Retrieve a reusable agent

GET/api/agents/v1/{instanceId}/{agent_id}

Retrieve a reusable agent

Organization API key authentication

Authorization: Bearer $SINECLOUD_API_KEY

Required scopes: agentRun

Parameters

instanceId · path · Required: An accessible Agents instance from the Console.
agent_id · path · Required
OpenAI-Beta · header · Required

Responses

200: Success
400: Invalid or unsupported request
401: Missing, invalid or revoked organization API key.
402: Insufficient funds or execution budget.
403: Product scope, instance, project, workspace or current entitlement denied.
404: Resource not found in this scope
409: State or idempotency conflict
413: Request body exceeds the route limit.
429: Rate or quota limit reached. Respect Retry-After when supplied.
501: Capability not implemented
502: Runtime response unavailable; read durable session state before attempting more execution.
503: Runtime, deployment, model or billing admission unavailable.
504: Gateway deadline exceeded; execution may have started. Inspect durable state before another submission.

Loading API reference…

Agents · Setup & authentication

Base URLhttps://sinecloud.dev/api/agents/v1/{instanceId}

Open Console · Create an API key · Browse all APIs

Download API index

Before your first request

Select your organization, prepare resources in Console, and issue an organization API key with the required product scopes. Current permissions, resource access, budget and available funds are checked on every call.

Select an Agents instance and Agent in Console. Replace instanceId with that instance’s ID. Send OpenAI-Beta: agents=v1 where documented. The catalog covers reusable Agents, sessions, input events, persisted items and turns, model discovery, usage and runtime capabilities. Native JSON and live SSE responses are preserved. Live events do not replay after reconnecting; recover from persisted session state before submitting more work.

Grant agentRun and access to the selected instance. Hosted sessions also require sandboxRun and current workspace access. A linked Box must pass its own resource and project checks.

Organization key authentication and base URL

The production API origin is https://sinecloud.dev; the documentation origin does not serve product requests. The path prefix is /api/agents/v1/{instanceId}. Use the complete path documented for the operation, replacing resource IDs, models and endpoint revisions with your actual selections.

Authorization: Bearer $SINECLOUD_API_KEY

Set SINECLOUD_API_KEY to your own environment variable value; never use platform service credentials. Each operation lists required scopes in x-sinecloud-scopes.

This reference is read-only. Run requests in Console or your own client. Browsing documentation never creates a key, starts execution or incurs an execution charge. Keep request IDs and execution receipts; a lost connection does not cancel work. Follow the operation’s recovery instructions before submitting again.