Skip to navigation
API Reference

Integrate Public Endpoints

View as Markdown

After selecting endpoints from /v1/search, send them to /v1/integrate along with the task you want to accomplish. It returns a task brief with the information and steps needed to call the selected endpoints.

Request

POST /v1/integrate

{
  "task": "Build an app to post current weather to Slack",
  "resources": [
        {
            "id": "urn:orbit:endpoint:v1:1OYrNvmw0qAUVtV7jNU3tC3kuCIFbpjpfGZuyexkHTlZg60P7mpN4cYzSm9XW:weatherapi-com:current-weather-json",
            "type": "endpoint"
        },
        {
            "id": "urn:orbit:endpoint:v1:1Jgb5F43F8b9al2a64G1srYRVxJ3SKnSepsgceU9aKzl1nnJeNHWFxEudTUMG:slack:send-message-to-slack",
            "type": "endpoint"
        }
    ]
}
  • task — what you want to accomplish (max 512 characters).
  • resources — the endpoints to integrate; each is an id from /v1/search plus its type (the result’s resourceType).

Both fields are required, and every resources entry needs id and type

This call takes no query parameters.

Response

The response contains one data entry with a taskBrief. The brief includes authentication requirements, base URLs, request steps, parameters, expected responses, dependencies between steps, and important considerations. The task brief uses the selected endpoints’ schemas and any shared variables, authentication settings, and descriptions defined by their parent APIs.

Idempotency

Integrate is read-only: it generates a task brief from the referenced endpoints and never creates or mutates data, so it is safe to retry. No idempotency key is required. The generated brief’s wording may vary between otherwise identical calls.

Errors

400 invalid input, 404 all ids could not be resolved, 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.

Request

This endpoint expects an object.
taskstringRequiredformat: "\S"1-512 characters
resourceslist of objectsRequired

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

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error