API referenceConversations

Create conversation and upload files

Create a new conversation and upload files to it. <Note>For an overview of file upload limitations and supported file types, see [File limitations and processing](/overview/limitations/).</Note>

Authentication

AuthorizationBearer
Bearer HTTP authentication.

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](/api-sdk/authorization#ib-context-header) for details.

Request

This endpoint expects a multipart form with multiple files.
namestringOptional
Name of the conversation.
descriptionstringOptional
Description of the conversation.
filesfilesRequired
A list of files to process, defined with local file paths.
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. <Note>If you define an `org` value and include the `IB-Context` header, the organization values must match or the request can't complete.</Note>
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.

When making this call from a service account, you must specify a workspace.

enable_object_detectionbooleanOptionalDefaults to false

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

enable_entity_detectionbooleanOptionalDefaults to true
Defines whether to enable entity detection for the processed file. Entity detection is supported for signatures and barcodes. If entity detection is not required, consider disabling to improve processing speed.
write_converted_imagebooleanOptionalDefaults to true

Defines whether to save the image files generated when processing the document. One .jpeg image file per document page is saved. If storage space is a consideration, consider disabling for documents with many pages.

write_thumbnailbooleanOptionalDefaults to true

Defines whether to generate and save thumbnails of each image file generated when processing the document. One .jpeg thumbnail—a small image representation of the larger image—per document page is saved. If storage space is a consideration, consider disabling for documents with many pages.

fast_modebooleanOptionalDefaults to false

Defines whether to skip several digitization preprocessing steps. The enable_entity_detection, write_converted_image, and write_thumbnail flags must all be set to false.

enable_multilanguage_supportbooleanOptionalDefaults to false

Commercial & Enterprise Enable if the conversation contains documents in a standard non-Latin language.

enable_multilanguage_advanced_modebooleanOptionalDefaults to false

Enterprise Enable this and enable_multilanguage_support if the conversation contains documents in an advanced non-Latin language, including Greek, Hebrew, Thai, and others.

Response

Conversation created successfully.
idstring
Unique identifier for the conversation.
namestring
Name of the conversation.
upload_statusobject or null
Status of file uploads. This field is omitted if no files are provided.