Sign in

v1

latestOpenAPI 3.1.02026-08-044257268.7 KB
Runs

Start an endpoint run

Start an execution of an endpoint. For a sync COMPLETED run the HTTP status FAITHFULLY MIRRORS the provider's own status (2xx → 2xx, provider 4xx/5xx → 4xx/5xx, request-timeout → 504); the body always carries the full run. A control gate returns a 200 BLOCKED run, and a run that exceeds its time budget returns 408 (TIMED_OUT). Async endpoints return a 202 acceptance ack — poll GET /v1/runs/{runId} for the result.

post/v1/run

Request body

providerstring required

Provider slug.

endpointstring required

Endpoint path within the provider.

Example request

{
  "provider": "exa",
  "endpoint": "search"
}

Response

Terminal run — COMPLETED (sync execution, when the provider responded 2xx) or BLOCKED (a workspace control gate rejected the run). A COMPLETED run with a non-2xx provider status is returned with that same HTTP status and this body shape — EXCEPT a provider 402 (the upstream vendor's payment/quota failure, not your wallet), which is returned as 502.

OR

Example response

{
  "providerResponse": {
    "httpStatus": 200
  }
}