API referenceConversations

Get conversation information

Retrieve information about a conversation, such as its state and a list of documents in the conversation.

Path parameters

conversation_idstringRequired

The conversation ID.

You can list conversations and get their IDs with the List conversations endpoint.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Response

Successful response.
idstring
Unique identifier for the conversation.
namestring
Name of the conversation.
statestring

The current state of the conversation.

  • COMPLETE: Ready to start a conversation.
  • FAILED: Not able process any of the uploaded files.
  • RUNNING: Still processing the uploaded files.
descriptionstring or null
Description of the conversation.
documentslist of objects or null
A list of all uploaded and processed documents in the conversation.