API Access lets you run an agent from your own code, scripts, or other systems by sending an HTTP request — no chat window required. When enabled, the agent gets a public URL and a private API key you can call over HTTPS.
API Access triggers a single agent. To trigger a multi-step workflow, use the keys under Settings → API Keys instead. See API Keys.
Enabling API Access
Open the agent's settings
Edit the agent and find the API Access section.
Turn on the toggle
Enable “Allow this agent to be triggered via HTTP API”. This reveals the agent’s endpoint and credentials. Copy the Public URL
The read-only Public URL (POST) has the shape .../api/v1/triggers/agent/{agentId}. Use the Copy button next to it.
Save the API key
An API key is provisioned automatically and shown once. Copy it, then use hide to conceal it.
The API key is only shown once — save it somewhere safe before hiding it. Requests authenticate with the X-API-Key header.
Calling the Agent
The section provides ready-to-copy cURL snippets for both a JSON body and a multipart request with file uploads. Each snippet has a Bash / PowerShell / Cmd shell picker next to its Copy button — pick your shell and the copied command is formatted correctly for it (PowerShell and Cmd use curl.exe with a single-line, minified body). The examples below are illustrative — use your own URL and key.
Send a query as JSON:
curl -X POST "https://<your-domain>/api/v1/triggers/agent/{agentId}" \
-H "X-API-Key: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{ "query": "What is the largest river in the world?" }'
Attach a file with a multipart request:
curl -X POST "https://<your-domain>/api/v1/triggers/agent/{agentId}" \
-H "X-API-Key: <your-api-key>" \
-F 'payload={"query":"Summarize this report in 3 bullets."};type=application/json' \
-F "files=@./report.pdf"
Use the Download integration guide (.md) link in the API Access section for a full reference you can hand to a developer.
Triggering from Workflow Builder
If you build agents with Workflow Builder, a workflow can start from an http-trigger node. Its Test Endpoint panel gives you ready-made cURL, TypeScript, and Python examples for calling the workflow.