List Agents instances

GET/api/agents/v1

Lists the Agents instances this key can use within its organization and optional project restriction. Cloud owns the product directory and pagination; no runtime call is made, so a suspended or expired instance remains visible with its saved status. Use an instance ID from this page as the {instanceId} path value. Only owner or admin keys are allowed.

Organization API key authentication

Authorization: Bearer $SINECLOUD_API_KEY

Required scopes: agentRun

Parameters

limit · query · Optional: Maximum instances per page.
cursor · query · Optional: Unmodified nextCursor from the previous page.

Responses

200: Agents instance page visible to this key.
401: Missing, invalid or revoked organization API key.
403: Product scope, instance, project, workspace or current entitlement denied.

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.