Skip to main content
POST
Start a published workflow

Authorizations

Authorization
string
header
required

Organization API key. Keep it on your server.

Headers

Idempotency-Key
string
required

Unique ID for one intended launch. Reuse this key and the identical body when retrying that launch.

Required string length: 1 - 200

Body

application/json
workflow_revision_id
string<uuid>
required

Published workflow revision UUID, not a working-copy ID or version number.

inputs
object

Values matching the published workflow input fields.

participant_identity
string
default:browser

Identity for the participant joining the room.

Required string length: 1 - 100
tags
string[]

Application labels.

Maximum array length: 20
metadata
object

Application context; exclude secrets.

Response

Successful response

id
string<uuid>
required

Use this session ID for status, token refresh, end, and transcript requests.

status
enum<string>
required
Available options:
created,
active,
completed,
failed,
cancelled
room_name
string
required

Room name for the connection.

livekit_url
string<uri>
required

LiveKit connection URL returned by the service.

participant_token
string | null
required

Short-lived participant credential, or null after the session becomes terminal.

created_at
string<date-time>
required
started_at
string<date-time> | null
required
ended_at
string<date-time> | null
required
workflow_run_id
string<uuid> | null

Present for a workflow session; identifies its workflow run.