Skip to main content

Calling a deployed API

API Studio

A published version deployed to an environment answers real requests from its flows. Each flow endpoint runs the flow version pinned at deployment.

Deployments​

  • Only a published version can be deployed.
  • One version is active per API and environment. A new deployment replaces the previous one.
  • Deploying needs the API deploy permission.

URL​

/t/<account>/<environment>/<api>/<version>/<path>

<environment> is the environment name in lowercase, with spaces and symbols replaced by -.

Clients and keys​

A client belongs to one environment and to one API or to every API in the account. Managing clients and keys needs the API client permission.

  • A key is shown once, when it is created.
  • Send it as Authorization: Bearer <key> or X-API-Key: <key>.
  • A key works only in its own account and environment.
  • A revoked key stops working within 30 seconds.
  • Revoking a client revokes its keys.

Responses​

  • A request that does not match the API definition answers 400 and never runs the flow.
  • A synchronous endpoint answers within the sync timeout, or 504.
  • An asynchronous endpoint answers 202 with a Location header. Poll that URL for the status and the result.
  • 402 means the API Studio add-on is not active for the account.

Errors use the problem details format (RFC 9457) with type, title, status and code. A validation error lists each failing field in errors, with a JSON pointer and a detail.

Rate limits, quotas, CORS, idempotency keys, caching and deprecation headers are on Policies and limits.