Skip to main content
POST
Create a new case or add files to an existing one
A case acts as a container for documents that need to be analysed together. You can create a case with or without file placeholders. With file placeholders: Pre-define expected files and get upload URLs immediately. Without file placeholders: Create case first, then add files later.
Important: Cases are designed for single-batch file uploads. Once you begin uploading files, the case locks to ensure complete analysis. Plan to upload all your files together.

Best Practices

  1. Descriptive Labels: Use clear, descriptive case labels like claim numbers or policy numbers for easy identification.
  2. Unique Labels (Case-Insensitive): Case labels must be unique per user regardless of letter casing. Creating a case with a label that only differs by case will return a 409 Conflict response.
  3. File Planning: Pre-define expected files when possible to get upload URLs immediately.
  4. Batch Operations: Create cases in advance for high-volume processing.

Authorizations

x-api-key
string
header
required

Body

application/json
label
string
required
Required string length: 1 - 255
file_labels
string[]
Required string length: 1 - 255
existing_case_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
current_context
string
Required string length: 1 - 2000

Response

Case created or files added successfully

case_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
is_locked
boolean
required
stream_url
string
required
files
object[]