Start a probe run

{ "type": "about:blank", "title": "<string>", "status": 123, "detail": "<string>", "instance": "<string>", "code": "<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

The agent this resource is scoped to (the UUID returned by createAgent / listAgents).

Body

application/json

scenarioId

string

required

The saved probe scenario to run (its id).

mode

enum<string>

required

How the probe reaches the agent — loopback (in-process, no telephony; fast and free) or phone (places a real PSTN call end-to-end).

Available options:

loopback,

phone

Response

Run kicked.

success

boolean

required

data

object

required

Show child attributes

message

string

errors

object[]

Show child attributes

Using the API

Endpoints

Start a probe run

Authorizations

Path Parameters

Body

Response