Automations · Workflows

Manually start a workflow run

Manually starts a workflow run.

POSThttps://api.pozy.ai/v1/workflows/{workflowId}/executions
triggerWorkflow

Guide: Workflows

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
workflowIdrequiredstring

Request body

application/json, required

  • tostring
  • conversationIdstring
  • textstring

Example

curl -X POST "https://api.pozy.ai/v1/workflows/6e299f518f373bfd669857c4/executions" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155550123",
  "conversationId": "6e525f3820fc636aa96d2ee9",
  "text": "Hello from Pozy"
}'

Response

200 on success

  • successboolean
  • executionobject

    Can be null.

    • idstring
    • statusstring
    • currentNodeIdstring
    • waitingForobject

      Can be null.

    • variablesobject
    • conversationIdstring
200 response
{
  "success": true,
  "execution": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "active",
    "currentNodeId": "6824a29c1481b019b3350794",
    "waitingFor": {},
    "variables": {},
    "conversationId": "6e525f3820fc636aa96d2ee9"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Workflows