Skip to main content
Use this read-only workflow to confirm that an integration can reach the intended workspace. It does not create a conversation or change an agent.
Recording pending for Read an agent through the API. No playable video is available yet.

Recording pending: Read an agent through the API. Follow the written guide below.

​
Before you begin

Create a scoped API key. Store it as THREETONE_API_KEY in your server environment. You need permission to read agents in the selected workspace.
1

List accessible agents

Send a request to List agents. Follow the returned pagination cursor when more results are available.
2

Inspect one configuration

Use a returned agent ID with Get agent. Confirm its branch and version metadata, prompt, model, and resource references. Do not substitute a display name for its ID.
3

Handle failures explicitly

Set request timeouts in your application. Distinguish authentication failures, unavailable resources, validation errors, and service failures. Log status and a safe request identifier rather than keys, prompts, or transcripts.
Use the Python or TypeScript REST examples for application code. Continue with API quickstart when you need to create a configuration.

​
Frequently asked questions

Not necessarily. Check the response status, workspace access, filters, and pagination. An empty successful response may contain no accessible agents.
Keep workspace API keys on a trusted server. Browser session access requires a separate supported authentication path.