Create Source

curl --request POST \
  --url https://api.linqalpha.com/v1/sources \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Q4_Revenue_Report.pdf",
  "file_key": "uploaded_sources/2024/q4/revenue_report.pdf"
}
'

{
  "source_id": "456e7890-e89b-12d3-a456-426614174001",
  "size": 2048576,
  "status": "processing"
}

RMS (On request)

Create Source

Registers a previously-uploaded file as a document source under a source batch and queues it for asynchronous parsing. Once status: "success", the source is searchable in chat/search conversations that reference its source_batch_id.

Important Notes:

Prerequisite: A source batch must be created first using POST /v1/source_batches
The file must already be in S3 before calling this endpoint. Two ways to get it there:
- Recommended: call POST /v1/sources/upload_url to obtain a presigned PUT URL, upload the file directly via that URL, then pass the returned file_key here. No client-side AWS setup required.
- Alternative: if you already have your own S3 staging bucket integrated with us, upload there and pass the resulting file_key.
Processing: Sources are queued for asynchronous processing. Use GET /v1/sources/{source_id} to poll the processing status before using in conversations.
File Requirements:
- Supported formats: PDF, DOCX, XLSX, DOC, TXT, PPTX
- Maximum size: 20MB per file
- Maximum files per batch: 10 files
Usage in Conversations:
- Reference sources via source_batch_id in chat/search API requests
- All sources in a batch are accessible when the batch is referenced
- Sources remain available for reuse within conversations that reference their batch

Workflow (presigned-URL path):

POST /v1/source_batches → source_batch_id
POST /v1/sources/upload_url → upload_url, file_key, content_type
PUT the file body to upload_url with header Content-Type: <content_type>
POST /v1/sources (this endpoint) with file_key from step 2
Poll GET /v1/sources/{source_id} until status: "success"
Reference source_batch_id in chat/search requests

POST

sources

Create Source

curl --request POST \
  --url https://api.linqalpha.com/v1/sources \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Q4_Revenue_Report.pdf",
  "file_key": "uploaded_sources/2024/q4/revenue_report.pdf"
}
'

{
  "source_id": "456e7890-e89b-12d3-a456-426614174001",
  "size": 2048576,
  "status": "processing"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

source_batch_id

string<uuid>

required

ID of the source batch to add this source to. The batch must be created first via POST /v1/source_batches.

Example:

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

name

string

required

Display name for the source, typically the original filename. Must not include a file extension.

Example:

"Q4_Revenue_Report"

file_key

string

required

S3 object key path where the file is stored. The file must be accessible to the API service and meet format/size requirements (PDF, DOCX, XLSX, DOC, TXT, PPTX; max 20MB).

Example:

"uploaded_sources/2024/q4/revenue_report.pdf"

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"

Response

Source created and queued for processing

source_id

string<uuid>

required

Unique identifier for the created source. Use this ID to poll processing status via GET /v1/sources/{source_id}.

Example:

"456e7890-e89b-12d3-a456-426614174001"

size

integer

required

File size in bytes

Required range: x >= 0

Example:

2048576

status

enum<string>

Initial processing status (typically 'processing' when first created)

Available options:

processing,

success,

failed

Example:

"processing"

Get Upload URL RMS Chat

⌘I

Documentation Index

Authorizations

Body

Response