Create conversation and upload files

POST

Create a new conversation and upload files to it.

Headers

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.

Request

This endpoint expects a multipart form with multiple files.
namestringOptional

Name of the conversation.

descriptionstringOptional

Description of the conversation.

filesfilesRequired
orgstringOptional

Your organization name. For organization members, your organization is <ORGANIZATION-ID>. If not defined, the organization is inferred from the IB-Context header value.

If you define an org value and include the IB-Context header, the organization values must match or the request can’t complete.
workspacestringOptional

The name of your personal workspace, where the conversation is created. For organization members, your personal workspace name is your user ID. If not defined, the workspace is inferred from the IB-Context header value.

enable_object_detectionbooleanOptionalDefaults to false

Defines whether to enable object detection for the processed file. Object detection includes support for extracting tables and checkboxes.

Response

Conversation created successfully.

idstring

Unique identifier for the conversation.

namestring

Name of the conversation.

upload_statusobjectOptional

Status of file uploads. This field is omitted if no files are provided.

List conversations