Skip to main content
POST
Answer a workflow's question

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

Answer the question being asked, or skip it (value null).

key
string
required

The question being answered, so a stale tab can't answer another.

Pattern: ^[a-z][a-z0-9_]{0,39}$
value
string | null
Maximum string length: 4000

Response

Successful Response

Where a workflow conversation stands.

item_id
string<uuid>
required
title
string
required
total
integer
required

Questions the workflow can ask.

version
string | null

The version it follows.

transcript
WorkflowTranscriptEntry · object[]
current
ChatWorkflowQuestionOut · object | null

The question waiting for an answer; null once done.

done
boolean
default:false
task
string | null

Once done: the message to send to the assistant.

available
boolean
default:true

False when the version was withdrawn or is no longer yours to see.

can_continue
boolean
default:true

Whether you may answer: who started it, or a manager.