Skip to main content
POST
/
v1
/
agents
/
{agent_id}
/
runs
Run an agent
curl --request POST \
  --url https://api.tryprofound.com/v1/agents/{agent_id}/runs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "inputs": {}
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "started_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
agent_id
string<uuid>
required

The ID of the agent to run.

Body

application/json

Inputs to send to the agent run.

​
inputs
Inputs · object

Input values for the run. Keys should match the property names defined in schema.input.

Response

Successful Response

Run details returned after a run request is accepted.

​
id
string<uuid>
required

Unique ID for the accepted run.

​
agent_id
string<uuid>
required

Unique ID of the agent for this run.

​
status
enum<string>
required

Initial status of the accepted run.

Available options:
queued,
running,
succeeded,
failed,
cancelled,
skipped,
unknown
​
started_at
string<date-time> | null

When the run started, if execution began immediately.