API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Beta

BetaIndexes

Get Index

client.beta.indexes.get(stringindexID, IndexGetParams { organization_id, project_id } query?, RequestOptionsoptions?): IndexGetResponse { id, export_config_id, name, 10 more }

GET/api/v1/indexes/{index_id}

Delete Index

client.beta.indexes.delete(stringindexID, IndexDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): void

DELETE/api/v1/indexes/{index_id}

Create Index

client.beta.indexes.create(IndexCreateParams { source_directory_id, organization_id, project_id, 6 more } params, RequestOptionsoptions?): IndexCreateResponse { id, export_config_id, name, 10 more }

POST/api/v1/indexes

Sync Index

client.beta.indexes.sync(stringindexID, IndexSyncParams { organization_id, project_id } params?, RequestOptionsoptions?): IndexSyncResponse

POST/api/v1/indexes/{index_id}/sync

List Indexes

client.beta.indexes.list(IndexListParams { organization_id, page_size, page_token, 2 more } query?, RequestOptionsoptions?): PaginatedCursor<IndexListResponse { id, export_config_id, name, 10 more } >

GET/api/v1/indexes

ModelsExpand Collapse

IndexGetResponse { id, export_config_id, name, 10 more }

A searchable index over a directory of documents.

id: string

Unique identifier

export_config_id: string

ID of the export configuration.

name: string

Index name.

output_directory_id: string

ID of the output directory holding the indexed files.

project_id: string

Project this index belongs to.

source_directory_id: string

ID of the source directory.

sync_config_id: string

ID of the sync configuration.

created_at?: string | null

Creation datetime

formatdate-time

description?: string | null

Index description.

last_exported_at?: string | null

Last export time.

formatdate-time

last_synced_at?: string | null

Last sync time.

formatdate-time

metadata?: Record<string, unknown>

Build state and diagnostic info.

updated_at?: string | null

Update datetime

formatdate-time

IndexCreateResponse { id, export_config_id, name, 10 more }

A searchable index over a directory of documents.

id: string

Unique identifier

export_config_id: string

ID of the export configuration.

name: string

Index name.

output_directory_id: string

ID of the output directory holding the indexed files.

project_id: string

Project this index belongs to.

source_directory_id: string

ID of the source directory.

sync_config_id: string

ID of the sync configuration.

created_at?: string | null

Creation datetime

formatdate-time

description?: string | null

Index description.

last_exported_at?: string | null

Last export time.

formatdate-time

last_synced_at?: string | null

Last sync time.

formatdate-time

metadata?: Record<string, unknown>

Build state and diagnostic info.

updated_at?: string | null

Update datetime

formatdate-time

IndexSyncResponse = unknown

IndexListResponse { id, export_config_id, name, 10 more }

A searchable index over a directory of documents.

id: string

Unique identifier

export_config_id: string

ID of the export configuration.

name: string

Index name.

output_directory_id: string

ID of the output directory holding the indexed files.

project_id: string

Project this index belongs to.

source_directory_id: string

ID of the source directory.

sync_config_id: string

ID of the sync configuration.

created_at?: string | null

Creation datetime

formatdate-time

description?: string | null

Index description.

last_exported_at?: string | null

Last export time.

formatdate-time

last_synced_at?: string | null

Last sync time.

formatdate-time

metadata?: Record<string, unknown>

Build state and diagnostic info.

updated_at?: string | null

Update datetime

formatdate-time

BetaRetrieval

Retrieve

client.beta.retrieval.retrieve(RetrievalRetrieveParams { index_id, query, organization_id, 9 more } params, RequestOptionsoptions?): RetrievalRetrieveResponse { results }

POST/api/v1/retrieval/retrieve

Find Files

client.beta.retrieval.find(RetrievalFindParams { index_id, organization_id, project_id, 4 more } params, RequestOptionsoptions?): PaginatedCursorPost<RetrievalFindResponse { file_id, file_name } >

POST/api/v1/retrieval/files/find

Grep File

client.beta.retrieval.grep(RetrievalGrepParams { file_id, index_id, pattern, 5 more } params, RequestOptionsoptions?): PaginatedCursorPost<RetrievalGrepResponse { content, end_char, start_char } >

POST/api/v1/retrieval/files/grep

Read File

client.beta.retrieval.read(RetrievalReadParams { file_id, index_id, organization_id, 3 more } params, RequestOptionsoptions?): RetrievalReadResponse { content }

POST/api/v1/retrieval/files/read

ModelsExpand Collapse

RetrievalRetrieveResponse { results }

Response containing retrieval results.

results: Array<Result>

Ordered list of retrieved chunks.

content: string

Text content of the retrieved chunk.

metadata?: Record<string, string | number | number | 3 more> | null

User-defined metadata associated with the chunk.

One of the following:

string

number

number

boolean

unknown

Array<string>

rerank_score?: number | null

Relevance score from the reranker, if reranking was applied.

score?: number | null

Hybrid search relevance score.

static_fields?: StaticFields { attachments, chunk_end_char, chunk_index, 5 more }

Built-in fields stored for every exported chunk.

attachments?: Array<Attachment>

Attachments associated with the chunk

attachment_name: string

Attachment-relative path, e.g. ‘screenshots/page_7.jpg’.

source_id: string

File ID to pass as source_id when fetching the attachment.

type: string

Attachment kind, e.g. ‘screenshot’, ‘items’.

chunk_end_char?: number | null

End character offset of the chunk.

chunk_index?: number | null

Index of the chunk within the file.

chunk_start_char?: number | null

Start character offset of the chunk.

chunk_token_count?: number | null

Token count of the chunk.

page_range_end?: number | null

Last page number covered by this chunk.

page_range_start?: number | null

First page number covered by this chunk.

parsed_directory_file_id?: string | null

ID of the parsed file.

RetrievalFindResponse { file_id, file_name }

A file returned by find.

file_id: string

ID of the file.

file_name: string

Display name of the file.

RetrievalGrepResponse { content, end_char, start_char }

A single grep match within a file.

content: string

Matched text content.

end_char: number

End character offset of the match.

start_char: number

Start character offset of the match.

RetrievalReadResponse { content }

File read result.

content: string

Parsed text content of the file.

BetaChat

List Sessions

client.beta.chat.list(ChatListParams { organization_id, page_size, page_token, project_id } query?, RequestOptionsoptions?): PaginatedCursor<ChatListResponse { last_updated_at, session_id, generated_title, 2 more } >

GET/api/v1/chat

Create Session

client.beta.chat.create(ChatCreateParams { organization_id, project_id, index_ids } params?, RequestOptionsoptions?): ChatCreateResponse { last_updated_at, session_id, generated_title, 2 more }

POST/api/v1/chat

Get Full Session

client.beta.chat.retrieve(stringsessionID, ChatRetrieveParams { organization_id, project_id } query?, RequestOptionsoptions?): ChatRetrieveResponse { events, last_updated_at, session_id, 3 more }

GET/api/v1/chat/{session_id}

Delete Session

client.beta.chat.delete(stringsessionID, ChatDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): void

DELETE/api/v1/chat/{session_id}

Get Session Summary

client.beta.chat.getSummary(stringsessionID, ChatGetSummaryParams { organization_id, project_id } query?, RequestOptionsoptions?): ChatGetSummaryResponse { last_updated_at, session_id, generated_title, 2 more }

GET/api/v1/chat/{session_id}/summary

Stream Messages

client.beta.chat.stream(stringsessionID, ChatStreamParams { index_ids, prompt, organization_id, project_id } params, RequestOptionsoptions?): ChatStreamResponse

POST/api/v1/chat/{session_id}/messages/stream

ModelsExpand Collapse

ChatListResponse { last_updated_at, session_id, generated_title, 2 more }

Summary of a chat session, including its title and last run metadata.

last_updated_at: string

ISO-format timestamp showing when the session was last updated.

session_id: string

Unique session identifier.

generated_title?: string | null

Auto-generated title derived from the first user message.

index_ids?: Array<string> | null

Indexes this session is bound to. Null on unbound sessions.

job_metadata?: JobMetadata | null

Token usage and status from the most recent run. Null if the session has not been run yet.

duration_ms?: number

error?: string | null

export_config_ids?: Array<string> | null

is_error?: boolean

total_input_tokens?: number | null

total_output_tokens?: number | null

turns?: number

ChatCreateResponse { last_updated_at, session_id, generated_title, 2 more }

Summary of a chat session, including its title and last run metadata.

last_updated_at: string

ISO-format timestamp showing when the session was last updated.

session_id: string

Unique session identifier.

generated_title?: string | null

Auto-generated title derived from the first user message.

index_ids?: Array<string> | null

Indexes this session is bound to. Null on unbound sessions.

job_metadata?: JobMetadata | null

Token usage and status from the most recent run. Null if the session has not been run yet.

duration_ms?: number

error?: string | null

export_config_ids?: Array<string> | null

is_error?: boolean

total_input_tokens?: number | null

total_output_tokens?: number | null

turns?: number

ChatRetrieveResponse { events, last_updated_at, session_id, 3 more }

Full chat session including its complete event history.

events: Array<StopEvent { error, is_error, usage, type } | TextDeltaEvent { content, type } | TextEvent { content, type } | 5 more>

Ordered list of events that make up the conversation history.

One of the following:

StopEvent { error, is_error, usage, type }

error: string | null

is_error: boolean

usage: Usage { duration_ms, total_input_tokens, total_output_tokens, turns }

duration_ms?: number

total_input_tokens?: number | null

total_output_tokens?: number | null

turns?: number

type?: "stop"

TextDeltaEvent { content, type }

content: string

type?: "text_delta"

TextEvent { content, type }

content: string

type?: "text"

ThinkingDeltaEvent { content, type }

content: string

type?: "thinking_delta"

ThinkingEvent { content, type }

content: string

type?: "thinking"

ToolCallEvent { arguments, call_id, name, type }

arguments: Record<string, unknown>

call_id: string

name: string

type?: "tool_call"

ToolResultEvent { call_id, name, result, 2 more }

call_id: string

name: string

result: unknown

image_attachment?: ImageAttachment | null

Coordinates for lazily resolving a page screenshot presigned URL.

attachment_name: string

source_id: string

type?: "tool_result"

UserInputEvent { content, type }

content: string

type?: "user_input"

last_updated_at: string

ISO-format timestamp showing when the session was last updated.

session_id: string

Unique session identifier.

generated_title?: string | null

Auto-generated title derived from the first user message.

index_ids?: Array<string> | null

Indexes this session is bound to. Null on unbound sessions.

job_metadata?: JobMetadata | null

Token usage and status from the most recent run. Null if the session has not been run yet.

duration_ms?: number

error?: string | null

export_config_ids?: Array<string> | null

is_error?: boolean

total_input_tokens?: number | null

total_output_tokens?: number | null

turns?: number

ChatGetSummaryResponse { last_updated_at, session_id, generated_title, 2 more }

Summary of a chat session, including its title and last run metadata.

last_updated_at: string

ISO-format timestamp showing when the session was last updated.

session_id: string

Unique session identifier.

generated_title?: string | null

Auto-generated title derived from the first user message.

index_ids?: Array<string> | null

Indexes this session is bound to. Null on unbound sessions.

job_metadata?: JobMetadata | null

Token usage and status from the most recent run. Null if the session has not been run yet.

duration_ms?: number

error?: string | null

export_config_ids?: Array<string> | null

is_error?: boolean

total_input_tokens?: number | null

total_output_tokens?: number | null

turns?: number

ChatStreamResponse = unknown

BetaAgent Data

Get Agent Data

client.beta.agentData.get(stringitemID, AgentDataGetParams { organization_id, project_id } query?, RequestOptionsoptions?): AgentData { data, deployment_name, id, 4 more }

GET/api/v1/beta/agent-data/{item_id}

Update Agent Data

client.beta.agentData.update(stringitemID, AgentDataUpdateParams { data, organization_id, project_id } params, RequestOptionsoptions?): AgentData { data, deployment_name, id, 4 more }

PUT/api/v1/beta/agent-data/{item_id}

Delete Agent Data

client.beta.agentData.delete(stringitemID, AgentDataDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): AgentDataDeleteResponse

DELETE/api/v1/beta/agent-data/{item_id}

Create Agent Data

client.beta.agentData.create(AgentDataCreateParams { data, deployment_name, organization_id, 2 more } params, RequestOptionsoptions?): AgentData { data, deployment_name, id, 4 more }

POST/api/v1/beta/agent-data

Search Agent Data

client.beta.agentData.search(AgentDataSearchParams { deployment_name, organization_id, project_id, 7 more } params, RequestOptionsoptions?): PaginatedCursorPost<AgentData { data, deployment_name, id, 4 more } >

POST/api/v1/beta/agent-data/:search

Aggregate Agent Data

client.beta.agentData.aggregate(AgentDataAggregateParams { deployment_name, organization_id, project_id, 9 more } params, RequestOptionsoptions?): PaginatedCursorPost<AgentDataAggregateResponse { group_key, count, first_item } >

POST/api/v1/beta/agent-data/:aggregate

Delete Agent Data By Query

client.beta.agentData.deleteByQuery(AgentDataDeleteByQueryParams { deployment_name, organization_id, project_id, 2 more } params, RequestOptionsoptions?): AgentDataDeleteByQueryResponse { deleted_count }

POST/api/v1/beta/agent-data/:delete

ModelsExpand Collapse

AgentData { data, deployment_name, id, 4 more }

API Result for a single agent data item

data: Record<string, unknown>

deployment_name: string

id?: string | null

collection?: string

created_at?: string | null

project_id?: string | null

updated_at?: string | null

AgentDataDeleteResponse = Record<string, string>

AgentDataAggregateResponse { group_key, count, first_item }

API Result for a single group in the aggregate response

group_key: Record<string, unknown>

count?: number | null

first_item?: Record<string, unknown> | null

AgentDataDeleteByQueryResponse { deleted_count }

API response for bulk delete operation

deleted_count: number

BetaDirectories

Create Directory

client.beta.directories.create(DirectoryCreateParams { name, organization_id, project_id, 4 more } params, RequestOptionsoptions?): DirectoryCreateResponse { id, name, project_id, 8 more }

POST/api/v1/beta/directories

List Directories

client.beta.directories.list(DirectoryListParams { include_deleted, name, organization_id, 5 more } query?, RequestOptionsoptions?): PaginatedCursor<DirectoryListResponse { id, name, project_id, 8 more } >

GET/api/v1/beta/directories

Get Directory

client.beta.directories.get(stringdirectoryID, DirectoryGetParams { organization_id, project_id } query?, RequestOptionsoptions?): DirectoryGetResponse { id, name, project_id, 8 more }

GET/api/v1/beta/directories/{directory_id}

Update Directory

client.beta.directories.update(stringdirectoryID, DirectoryUpdateParams { organization_id, project_id, description, name } params, RequestOptionsoptions?): DirectoryUpdateResponse { id, name, project_id, 8 more }

PATCH/api/v1/beta/directories/{directory_id}

Delete Directory

client.beta.directories.delete(stringdirectoryID, DirectoryDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): void

DELETE/api/v1/beta/directories/{directory_id}

ModelsExpand Collapse

DirectoryCreateResponse { id, name, project_id, 8 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1

project_id: string

Project the directory belongs to.

connector_subscription_id?: string | null

Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time

description?: string | null

Optional description shown to users.

expires_at?: string | null

When this directory expires and is eligible for cleanup.

formatdate-time

system_metadata?: Record<string, unknown> | null

Reserved system-managed metadata.

type?: "ephemeral" | "index" | "user" | null

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:

"ephemeral"

"index"

"user"

updated_at?: string | null

Update datetime

formatdate-time

DirectoryListResponse { id, name, project_id, 8 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1

project_id: string

Project the directory belongs to.

connector_subscription_id?: string | null

Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time

description?: string | null

Optional description shown to users.

expires_at?: string | null

When this directory expires and is eligible for cleanup.

formatdate-time

system_metadata?: Record<string, unknown> | null

Reserved system-managed metadata.

type?: "ephemeral" | "index" | "user" | null

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:

"ephemeral"

"index"

"user"

updated_at?: string | null

Update datetime

formatdate-time

DirectoryGetResponse { id, name, project_id, 8 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1

project_id: string

Project the directory belongs to.

connector_subscription_id?: string | null

Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time

description?: string | null

Optional description shown to users.

expires_at?: string | null

When this directory expires and is eligible for cleanup.

formatdate-time

system_metadata?: Record<string, unknown> | null

Reserved system-managed metadata.

type?: "ephemeral" | "index" | "user" | null

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:

"ephemeral"

"index"

"user"

updated_at?: string | null

Update datetime

formatdate-time

DirectoryUpdateResponse { id, name, project_id, 8 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1

project_id: string

Project the directory belongs to.

connector_subscription_id?: string | null

Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time

description?: string | null

Optional description shown to users.

expires_at?: string | null

When this directory expires and is eligible for cleanup.

formatdate-time

system_metadata?: Record<string, unknown> | null

Reserved system-managed metadata.

type?: "ephemeral" | "index" | "user" | null

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:

"ephemeral"

"index"

"user"

updated_at?: string | null

Update datetime

formatdate-time

BetaDirectoriesFiles

Add Directory File

client.beta.directories.files.add(stringdirectoryID, FileAddParams { file_id, organization_id, project_id, 3 more } params, RequestOptionsoptions?): FileAddResponse { id, directory_id, display_name, 8 more }

POST/api/v1/beta/directories/{directory_id}/files

List Directory Files

client.beta.directories.files.list(stringdirectoryID, FileListParams { display_name, display_name_contains, expand, 9 more } query?, RequestOptionsoptions?): PaginatedCursor<FileListResponse { id, directory_id, display_name, 8 more } >

GET/api/v1/beta/directories/{directory_id}/files

Get Directory File

client.beta.directories.files.get(stringdirectoryFileID, FileGetParams { directory_id, expand, organization_id, project_id } params, RequestOptionsoptions?): FileGetResponse { id, directory_id, display_name, 8 more }

GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Update Directory File

client.beta.directories.files.update(stringdirectoryFileID, FileUpdateParams { directory_id, organization_id, project_id, 4 more } params, RequestOptionsoptions?): FileUpdateResponse { id, directory_id, display_name, 8 more }

PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Delete Directory File

client.beta.directories.files.delete(stringdirectoryFileID, FileDeleteParams { directory_id, organization_id, project_id } params, RequestOptionsoptions?): void

DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Upload File To Directory

client.beta.directories.files.upload(stringdirectoryID, FileUploadParams { upload_file, organization_id, project_id, 4 more } params, RequestOptionsoptions?): FileUploadResponse { id, directory_id, display_name, 8 more }

POST/api/v1/beta/directories/{directory_id}/files/upload

ModelsExpand Collapse

FileAddResponse { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1

project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

download_url?: PresignedURL { expires_at, url, form_fields } | null

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time

url: string

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields?: Record<string, string> | null

Form fields for a presigned POST request

file_id?: string | null

File ID for the storage location.

metadata?: Record<string, string | number | number | 3 more>

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

string

number

number

boolean

unknown

Array<string>

updated_at?: string | null

Update datetime

formatdate-time

FileListResponse { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1

project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

download_url?: PresignedURL { expires_at, url, form_fields } | null

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time

url: string

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields?: Record<string, string> | null

Form fields for a presigned POST request

file_id?: string | null

File ID for the storage location.

metadata?: Record<string, string | number | number | 3 more>

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

string

number

number

boolean

unknown

Array<string>

updated_at?: string | null

Update datetime

formatdate-time

FileGetResponse { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1

project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

download_url?: PresignedURL { expires_at, url, form_fields } | null

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time

url: string

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields?: Record<string, string> | null

Form fields for a presigned POST request

file_id?: string | null

File ID for the storage location.

metadata?: Record<string, string | number | number | 3 more>

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

string

number

number

boolean

unknown

Array<string>

updated_at?: string | null

Update datetime

formatdate-time

FileUpdateResponse { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1

project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

download_url?: PresignedURL { expires_at, url, form_fields } | null

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time

url: string

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields?: Record<string, string> | null

Form fields for a presigned POST request

file_id?: string | null

File ID for the storage location.

metadata?: Record<string, string | number | number | 3 more>

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

string

number

number

boolean

unknown

Array<string>

updated_at?: string | null

Update datetime

formatdate-time

FileUploadResponse { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1

project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1

created_at?: string | null

Creation datetime

formatdate-time

deleted_at?: string | null

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

download_url?: PresignedURL { expires_at, url, form_fields } | null

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time

url: string

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields?: Record<string, string> | null

Form fields for a presigned POST request

file_id?: string | null

File ID for the storage location.

metadata?: Record<string, string | number | number | 3 more>

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

string

number

number

boolean

unknown

Array<string>

updated_at?: string | null

Update datetime

formatdate-time

BetaSplit

Create Split Job

client.beta.split.create(SplitCreateParams { document_input, organization_id, project_id, 2 more } params, RequestOptionsoptions?): SplitCreateResponse { id, categories, document_input, 8 more }

POST/api/v1/beta/split/jobs

List Split Jobs

client.beta.split.list(SplitListParams { created_at_on_or_after, created_at_on_or_before, job_ids, 5 more } query?, RequestOptionsoptions?): PaginatedCursor<SplitListResponse { id, categories, document_input, 8 more } >

GET/api/v1/beta/split/jobs

Get Split Job

client.beta.split.get(stringsplitJobID, SplitGetParams { organization_id, project_id } query?, RequestOptionsoptions?): SplitGetResponse { id, categories, document_input, 8 more }

GET/api/v1/beta/split/jobs/{split_job_id}

ModelsExpand Collapse

SplitCategory { name, description }

Category definition for document splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

SplitDocumentInput { type, value }

Document input specification for beta API.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

SplitResultResponse { segments }

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

Categorical confidence level. Valid values are: high, medium, low.

pages: Array<number>

1-indexed page numbers in this split.

SplitSegmentResponse { category, confidence_category, pages }

A segment of the split document.

category: string

Category name this split belongs to.

confidence_category: string

Categorical confidence level. Valid values are: high, medium, low.

pages: Array<number>

1-indexed page numbers in this split.

SplitCreateResponse { id, categories, document_input, 8 more }

Beta response — uses nested document_input object.

id: string

Unique identifier for the split job.

categories: Array<SplitCategory { name, description } >

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

user_id: string

User ID who created this job.

configuration_id?: string | null

Split configuration ID used for this job.

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if the job failed.

result?: SplitResultResponse { segments } | null

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

Categorical confidence level. Valid values are: high, medium, low.

pages: Array<number>

1-indexed page numbers in this split.

updated_at?: string | null

Update datetime

formatdate-time

SplitListResponse { id, categories, document_input, 8 more }

Beta response — uses nested document_input object.

id: string

Unique identifier for the split job.

categories: Array<SplitCategory { name, description } >

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

user_id: string

User ID who created this job.

configuration_id?: string | null

Split configuration ID used for this job.

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if the job failed.

result?: SplitResultResponse { segments } | null

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

Categorical confidence level. Valid values are: high, medium, low.

pages: Array<number>

1-indexed page numbers in this split.

updated_at?: string | null

Update datetime

formatdate-time

SplitGetResponse { id, categories, document_input, 8 more }

Beta response — uses nested document_input object.

id: string

Unique identifier for the split job.

categories: Array<SplitCategory { name, description } >

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

user_id: string

User ID who created this job.

configuration_id?: string | null

Split configuration ID used for this job.

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if the job failed.

result?: SplitResultResponse { segments } | null

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

Categorical confidence level. Valid values are: high, medium, low.

pages: Array<number>

1-indexed page numbers in this split.

updated_at?: string | null

Update datetime

formatdate-time