Skip to navigation
API Reference

Search Public Endpoints

View as Markdown

Describe your goal in q. Search returns matching public endpoints and evaluates what each one does, when to use it, and its limitations so the agent can select the best fit.

Request

POST /v1/search

{ "q": "Get Current Weather" }
{ "q": "Add tracking details for an existing paypal order" }

q is required and capped at 512 characters. No other body field is accepted; unknown fields return 400.

Query parameters

  • limit — results per page (default 10, max 25)
  • cursor — pass meta.nextCursor from the previous response

Pagination stops at 40 results total; a cursor past 40 is rejected.

Response

Each result carries id, resourceType, name, description, method (or transport for mcp results), url, and evaluateGuide.

  • resourceType — the kind of resource: endpoint (an HTTP endpoint) or mcp (an MCP). Pass it to /v1/integrate as the resource’s type.
  • method / transport — an endpoint result carries the HTTP method; an mcp result carries transport (the MCP transport) in its place.
  • evaluateGuide — an evaluation of the endpoint in three parts: a brief summary, recommended use cases, and unsupported use cases or limitations.

meta carries q, total, and nextCursor (absent on the last page).

Idempotency

Search is read-only and does not create or mutate data, so it is safe to retry. No idempotency key is required. Responses may still change between calls as the public catalog changes over time.

Errors

400 invalid input, 429 rate limited, 500 server error.

Headers

Orbit-Client-NamestringOptional<=128 characters

Name of the client application or agent invoking this tool (e.g. “cursor/composer-2.5”, “claude/sonnet-4.6”, “codex/gpt-5.6-sol”, “vscode”). Used for anonymous usage analytics.

Query parameters

limitintegerOptional1-25Defaults to 10
Results per page. Default 10, maximum 25.
cursorstringOptional

Pagination cursor. Pass the meta.nextCursor value from the previous response. Omit for the first page.

Request

This endpoint expects an object.
qstringRequired1-512 characters

Free-text search: a natural language query, keywords, an API name, or a question. Matched by meaning and keyword. Capped at 512 characters; longer values return 400.

Response headers

RateLimit-Limitinteger

Requests permitted in the current rate-limit window.

RateLimit-Remaininginteger

Requests remaining in the current rate-limit window.

RateLimit-Resetinteger

Unix timestamp (seconds since epoch) at which the current rate-limit window resets.

Response

Successful Response
datalist of objectsOptional
metaobjectOptional

Errors

400
Bad Request Error
429
Too Many Requests Error
500
Internal Server Error