SaaSFlow
DevelopersAPIReferenceagent_runs

Create agent run

Start an agent run. definitionId comes from the agent-definitions endpoint and input carries that agent's parameters.

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/agent_runs

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/companies/string/agent_runs" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string"  }'
{  "runId": "string"}

List agent runs

List this company's agent runs, past and in progress, with their status and which definition they came from. Use it to find a run id, or to check whether…

Retrieve agent run

Retrieve one agent run: its status, the input it was started with, and its result once finished. Poll this after starting a run.