Skip to main content
POST
Add a prompt to a chat and get its answer

Authorizations

Authorization
string
header
required

Your Vook API key (mint one from the web app).

Path Parameters

id
string
required

Transcription ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

chat_id
string
required

Chat ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
prompt
string
required

Question or instruction to run against the transcript

Minimum string length: 1
Example:

"List the action items decided in this meeting."

Response

The chat, with your prompt and its answer

id
string
required

Chat ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

transcription_id
string
required

ID of the transcription this chat runs against

Example:

"123e4567-e89b-12d3-a456-426614174000"

title
string
required

Label given to the chat

Example:

"Action items"

created_at
string<date-time>
required

When the chat was created

Example:

"2024-01-15T10:30:00.000Z"

messages
object[]
required

Prompts and answers, oldest first

turn_in_progress
boolean
required

True while a message on this chat is being answered. Poll the chat until it is false: your prompt and its answer in messages means the turn completed.

Example:

false