Skip to main content
POST
/
agents
/
{agentId}
/
probe
/
run
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "runId": "<string>"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

​
agentId
string
required

Body

application/json
​
scenarioId
string
required
​
mode
enum<string>
required
Available options:
loopback,
phone

Response

Run kicked.

​
success
boolean
required
​
data
object
required
​
message
string
​
errors
object[]