Skip to main content

​
List Indexes

GET /api/v1/developer/list-indexes Retrieve a list of all indexed services (SDKs, CLIs, APIs) available for context retrieval. Use the returned index_id to query specific services with the get-context endpoint.

​
Request

​
Headers

API-Key: your-api-key

​
Example Request

curl -X GET \
  "https://www.goharvest.ai/api/v1/developer/list-indexes" \
  -H "API-Key: your-api-key"

​
Response

​
Success Response (200)

{
  "ok": true,
  "error": null,
  "data": {
    "indexes": [
      {
        "name": "Python Requests Library",
        "index_id": "scrape_123456",
        "type": "SDK"
      },
      {
        "name": "AWS CLI",
        "index_id": "scrape_789012",
        "type": "CLI"
      },
      {
        "name": "Stripe API",
        "index_id": "scrape_345678",
        "type": "API"
      }
    ]
  }
}
​
ok
boolean
Indicates if the request was successful
​
error
string | null
Error message if the request failed, null otherwise
​
data
object
Contains the response data

​
Service Types

The indexed services are categorized into the following types:
Software Development Kit documentation and examples. Includes libraries like:
  • Python packages (requests, pandas, etc.)
  • JavaScript/TypeScript libraries
  • Language-specific SDKs
Command-line interface tools and their documentation. Examples:
  • AWS CLI
  • Docker CLI
  • Git commands
REST APIs, GraphQL APIs, and other web service documentation:
  • API endpoints and methods
  • Request/response examples
  • Authentication patterns
Services that don’t fit into the above categories or are newly indexed

​
Error Responses

{
  "detail": "API key missing",
  "status_code": 401
}
The API key is missing from request.
{
  "detail": "Invalid API key",
  "status_code": 401
}
The API key provided is invalid.
{
  "detail": "User account not found for user_account_id <user_account_id>",
  "status_code": 404
}
The user account associated with the API key doesn’t exist.
{
  "detail": "No API key found",
  "status_code": 404
}
There are no API keys created.

​
Best Practices

Cache the Results: The list of available indexes doesn’t change frequently. Cache the response to minimize API calls and improve performance.
Use index_id for Queries: When calling the get-context endpoint, use the index_id field returned from this endpoint.

​
Next Steps

Get Context

Query indexed services for documentation and examples

API Authentication

Learn how to create and manage API keys
⌘I