Skip to content

Run Agent

POST
/api/public/ai-chat/agents/{agentId}/runs
curl --request POST \
--url https://backend.podscribe.ai/api/public/ai-chat/agents/1/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "params": { "additionalProperty": "example" } }'

Starts an asynchronous agent run. Returns immediately with status: processing and a runId that identifies the run. Poll GET /api/public/ai-chat/agent-runs/{runId}/status until the run is done or failed.

agentId
required
integer
>= 1

ID of an existing AI Chat agent. Copy it from the agent details page in the app.

Media typeapplication/json
object
params

Key-value map of template parameters substituted into the agent prompt (for example { "advertiser": "Example Advertiser" } for {{advertiser}}).

object
key
additional properties
string
Examplegenerated
{
"params": {
"additionalProperty": "example"
}
}

Agent run accepted

Media typeapplication/json
object
runId
required

Run identifier; use with the agent run status endpoint.

integer
status
required
string
Allowed values: processing
Example
{
"status": "processing"
}

Invalid request data

Invalid token, insufficient permissions, or agent is not active

Agent not found

Internal server error