Open Menace Voice

Get Pilot Review

GET /api/v1/workflow/{workflow_id}/pilot-review — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/workflow/{workflow_id}/pilot-review

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/pilot-review \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "runs": [
    {
      "run_id": 1,
      "workflow_id": 1,
      "created_at": "2026-08-10T12:00:00Z",
      "state": "<string>",
      "mode": "<string>",
      "is_completed": true,
      "disposition": "<string>",
      "call_status": "<string>",
      "error_recorded": true,
      "transfer": "recorded_transfer",
      "duration_seconds": 1,
      "recorded_token_usage": 1,
      "actual_cost": "not_recorded",
      "webhooks": {
        "queued": 0,
        "accepted": 0,
        "failed": 0,
        "human_receipt": "not_recorded"
      }
    }
  ],
  "next_before_id": 1
}

get/api/v1/workflow/{workflow_id}/pilot-review

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Path parameters

workflow_idintegerrequired#

Range: >= 1

Query parameters

limitinteger#

Default: 25

Range: 1–100

before_idinteger · null#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

runsobject[]required#

Show child attributes

run_idintegerrequired#

workflow_idintegerrequired#

created_atstringrequired#

statestringrequired#

modestringrequired#

is_completedbooleanrequired#

dispositionstring · nullrequired#

Show child attributes

call_statusstring · nullrequired#

Show child attributes

error_recordedbooleanrequired#

transferenum<string>required#

Options:recorded_transfernot_recorded

duration_secondsnumber · nullrequired#

Show child attributes

recorded_token_usagenumber · nullrequired#

Show child attributes

actual_costenum<string>#

Default: "not_recorded"

Options:not_recorded

webhooksobject#

Show child attributes

queuedinteger#

Default: 0

acceptedinteger#

Default: 0

failedinteger#

Default: 0

human_receiptenum<string>#

Default: "not_recorded"

Options:not_recorded

next_before_idinteger · null#

Show child attributes

Get a presigned URL to upload a custom ambient noise audio file Get Api Keys