Skip to main content
POST
Create Source Batch

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required

Descriptive name for the source batch (e.g., project name, document category)

Required string length: 1 - 255
Example:

"Q4_Financial_Reports"

user_id
string

User ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>

Organization ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

user_email
string

User email

Example:

"john.doe@example.com"

user_name
string

User name

Example:

"John Doe"

description
string

Optional detailed description of the source batch purpose and contents

Maximum string length: 1000
Example:

"Financial documents including revenue reports, expense summaries, and forecasts for Q4 2024"

Response

Source batch created successfully

source_batch_id
string<uuid>
required

Unique identifier for the created source batch. Use this ID when uploading sources and referencing the batch in chat/search requests.

Example:

"123e4567-e89b-12d3-a456-426614174000"