Skip to Content
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

headerAuthorization<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.

Path Parameters

companyId*string
Formatuuid

Request Body

application/json
  1. body
definitionId*string
Length1 <= length
input?
suppressNotification?boolean
resumeFromRunId?string
Formatuuid

Response Body

Agent run started

application/json
  1. response
runId*string
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/agent_runs' \  -H 'Content-Type: application/json' \  -d '{  "definitionId": "string"}'
Example Response
{  "runId": "string"}