Skip to main content
POST
Start a workflow in a new chat

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

thread_id
string<uuid>
required

Body

application/json

Start a workflow in an empty thread, at its newest approved version.

item_id
string<uuid>
required

The workflow's registry artifact id.

Response

Successful Response

A started workflow and the thread it named.

progress
ChatWorkflowProgress · object
required

Where a workflow conversation stands.

thread
ChatThreadResponse · object | null

A chat thread as the thread list shows it, with what you may do with it.