API referenceConversations

Get document metadata

Retrieve metadata for a specified document within a conversation.

Path parameters

conversation_idstringRequired

The conversation ID.

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

The ID of the document for which metadata is being retrieved.

You can get a list of document IDs in your conversation with a conversation information request.

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

Successfully retrieved document metadata.

idintegerOptional

The document ID.

ibdoc_pathstringOptional

Path to the document’s internal representation.

namestringOptional

The name of the document.

metadatalist of objectsOptional