Skip to main content
POST
/
workflows
/
run-with-payload
/
{workflow_id}
Trigger a workflow
curl --request POST \
  --url https://api.altrina.com/workflows/run-with-payload/{workflow_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": "<string>"
}
'
{
  "status": "<string>",
  "job_id": "<string>",
  "user_id": "<string>",
  "workflow_id": "<string>",
  "conversation_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Get your API key at https://app.altrina.com/settings

Path Parameters

​
workflow_id
string
required

The workflow ID to trigger The workflow ID to trigger. Find this in the Studio URL (e.g. app.altrina.com/gallery/studio/{workflow_id}) or pre-filled in the webhook trigger modal.

Body

application/json

Request body for triggering a workflow. The payload field is optional.

​
payload
string | null

Free-form text that Altrina maps into the workflow's input parameters. Omit for workflows with no inputs.

Response

Workflow triggered successfully

Response returned when a workflow is successfully triggered.

​
status
string
required

Always 'success' when the workflow is enqueued

​
job_id
string
required

Unique job identifier. Use this to poll /v1/get_job_status/{job_id}

​
user_id
string
required

The authenticated user who triggered the workflow

​
workflow_id
string
required

The workflow that was triggered

​
conversation_id
string
required

Conversation identifier for this workflow run