Skip to main content
You need an Agent Builder account, access to a workspace, and permission to create an API key.

1. Create a key

Open API & Developers → API keys → Create API key. Choose a name and expiration, then store the secret securely. See API key management for rotation and troubleshooting.

2. Find your workspace ID

Open the REST API tab and copy the displayed Workspace ID. Set these environment variables for your local example, using your own values:
Use the positive integer shown in the console. Your key follows your account’s membership and role in that workspace.

3. List agents

Run the JavaScript example in a server environment with fetch support. Keep API keys out of client-side browser code. A successful request returns HTTP 200 and an array. A workspace with no matching agents returns:
An agent’s numeric id is used as workflow_id in many endpoints. Its workflow_uuid is a separate identifier; use the identifier requested by the endpoint. See List agents for the full response schema.

4. Continue your integration

To connect an AI assistant instead, follow the separate MCP quickstart.