ModelsExpand Collapse class IndexGetResponse : …
A searchable index over a directory of documents.
ID of the export configuration.
ID of the output directory holding the indexed files.
Project this index belongs to.
ID of the source directory.
ID of the sync configuration.
created_at : Optional [ datetime ]
description : Optional [ str ]
last_exported_at : Optional [ datetime ]
last_synced_at : Optional [ datetime ]
Build state and diagnostic info.
updated_at : Optional [ datetime ]
class IndexCreateResponse : …
A searchable index over a directory of documents.
ID of the export configuration.
ID of the output directory holding the indexed files.
Project this index belongs to.
ID of the source directory.
ID of the sync configuration.
created_at : Optional [ datetime ]
description : Optional [ str ]
last_exported_at : Optional [ datetime ]
last_synced_at : Optional [ datetime ]
Build state and diagnostic info.
updated_at : Optional [ datetime ]
class IndexListResponse : …
A searchable index over a directory of documents.
ID of the export configuration.
ID of the output directory holding the indexed files.
Project this index belongs to.
ID of the source directory.
ID of the sync configuration.
created_at : Optional [ datetime ]
description : Optional [ str ]
last_exported_at : Optional [ datetime ]
last_synced_at : Optional [ datetime ]
Build state and diagnostic info.
updated_at : Optional [ datetime ]
ModelsExpand Collapse class RetrievalRetrieveResponse : …
Response containing retrieval results.
Ordered list of retrieved chunks.
Text content of the retrieved chunk.
User-defined metadata associated with the chunk.
rerank_score : Optional [ float ]
Relevance score from the reranker, if reranking was applied.
Hybrid search relevance score.
static_fields : Optional [ ResultStaticFields ]
Built-in fields stored for every exported chunk.
attachments : Optional [ List [ ResultStaticFieldsAttachment ] ]
Attachments associated with the chunk
Attachment-relative path, e.g. ‘screenshots/page_7.jpg’.
File ID to pass as source_id when fetching the attachment.
Attachment kind, e.g. ‘screenshot’, ‘items’.
chunk_end_char : Optional [ int ]
End character offset of the chunk.
chunk_index : Optional [ int ]
Index of the chunk within the file.
chunk_start_char : Optional [ int ]
Start character offset of the chunk.
chunk_token_count : Optional [ int ]
Token count of the chunk.
page_range_end : Optional [ int ]
Last page number covered by this chunk.
page_range_start : Optional [ int ]
First page number covered by this chunk.
parsed_directory_file_id : Optional [ str ]
class RetrievalFindResponse : …
Display name of the file.
class RetrievalGrepResponse : …
A single grep match within a file.
End character offset of the match.
Start character offset of the match.
class RetrievalReadResponse : …
Parsed text content of the file.
ModelsExpand Collapse class ChatListResponse : …
Summary of a chat session, including its title and last run metadata.
ISO-format timestamp showing when the session was last updated.
Unique session identifier.
generated_title : Optional [ str ]
Auto-generated title derived from the first user message.
index_ids : Optional [ List [ str ] ]
Indexes this session is bound to. Null on unbound sessions.
Token usage and status from the most recent run. Null if the session has not been run yet.
class ChatCreateResponse : …
Summary of a chat session, including its title and last run metadata.
ISO-format timestamp showing when the session was last updated.
Unique session identifier.
generated_title : Optional [ str ]
Auto-generated title derived from the first user message.
index_ids : Optional [ List [ str ] ]
Indexes this session is bound to. Null on unbound sessions.
Token usage and status from the most recent run. Null if the session has not been run yet.
class ChatRetrieveResponse : …
Full chat session including its complete event history.
Ordered list of events that make up the conversation history.
One of the following:
usage : EventStopEventUsage
duration_ms : Optional [ float ]
total_output_tokens : Optional [ int ]
type : Optional [ Literal [ "stop" ] ]
class EventTextDeltaEvent : …
type : Optional [ Literal [ "text_delta" ] ]
type : Optional [ Literal [ "text" ] ]
class EventThinkingDeltaEvent : …
type : Optional [ Literal [ "thinking_delta" ] ]
class EventThinkingEvent : …
type : Optional [ Literal [ "thinking" ] ]
class EventToolCallEvent : …
arguments : Dict [ str , object ]
type : Optional [ Literal [ "tool_call" ] ]
class EventToolResultEvent : …
image_attachment : Optional [ EventToolResultEventImageAttachment ]
Coordinates for lazily resolving a page screenshot presigned URL.
type : Optional [ Literal [ "tool_result" ] ]
class EventUserInputEvent : …
type : Optional [ Literal [ "user_input" ] ]
ISO-format timestamp showing when the session was last updated.
Unique session identifier.
generated_title : Optional [ str ]
Auto-generated title derived from the first user message.
index_ids : Optional [ List [ str ] ]
Indexes this session is bound to. Null on unbound sessions.
Token usage and status from the most recent run. Null if the session has not been run yet.
class ChatGetSummaryResponse : …
Summary of a chat session, including its title and last run metadata.
ISO-format timestamp showing when the session was last updated.
Unique session identifier.
generated_title : Optional [ str ]
Auto-generated title derived from the first user message.
index_ids : Optional [ List [ str ] ]
Indexes this session is bound to. Null on unbound sessions.
Token usage and status from the most recent run. Null if the session has not been run yet.
ModelsExpand Collapse API Result for a single agent data item
collection : Optional [ str ]
created_at : Optional [ datetime ]
project_id : Optional [ str ]
updated_at : Optional [ datetime ]
class AgentDataAggregateResponse : …
API Result for a single group in the aggregate response
group_key : Dict [ str , object ]
first_item : Optional [ Dict [ str , object ] ]
class AgentDataDeleteByQueryResponse : …
API response for bulk delete operation
ModelsExpand Collapse class DirectoryCreateResponse : …
API response schema for a directory.
Unique identifier for the directory.
Human-readable name for the directory.
Project the directory belongs to.
connector_subscription_id : Optional [ str ]
Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Optional timestamp of when the directory was deleted. Null if not deleted.
description : Optional [ str ]
Optional description shown to users.
expires_at : Optional [ datetime ]
When this directory expires and is eligible for cleanup.
Reserved system-managed metadata.
type : Optional [ Literal [ "ephemeral" , "index" , "user" ] ]
Directory type: ‘user’, ‘index’, or ‘ephemeral’.
updated_at : Optional [ datetime ]
class DirectoryListResponse : …
API response schema for a directory.
Unique identifier for the directory.
Human-readable name for the directory.
Project the directory belongs to.
connector_subscription_id : Optional [ str ]
Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Optional timestamp of when the directory was deleted. Null if not deleted.
description : Optional [ str ]
Optional description shown to users.
expires_at : Optional [ datetime ]
When this directory expires and is eligible for cleanup.
Reserved system-managed metadata.
type : Optional [ Literal [ "ephemeral" , "index" , "user" ] ]
Directory type: ‘user’, ‘index’, or ‘ephemeral’.
updated_at : Optional [ datetime ]
class DirectoryGetResponse : …
API response schema for a directory.
Unique identifier for the directory.
Human-readable name for the directory.
Project the directory belongs to.
connector_subscription_id : Optional [ str ]
Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Optional timestamp of when the directory was deleted. Null if not deleted.
description : Optional [ str ]
Optional description shown to users.
expires_at : Optional [ datetime ]
When this directory expires and is eligible for cleanup.
Reserved system-managed metadata.
type : Optional [ Literal [ "ephemeral" , "index" , "user" ] ]
Directory type: ‘user’, ‘index’, or ‘ephemeral’.
updated_at : Optional [ datetime ]
class DirectoryUpdateResponse : …
API response schema for a directory.
Unique identifier for the directory.
Human-readable name for the directory.
Project the directory belongs to.
connector_subscription_id : Optional [ str ]
Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Optional timestamp of when the directory was deleted. Null if not deleted.
description : Optional [ str ]
Optional description shown to users.
expires_at : Optional [ datetime ]
When this directory expires and is eligible for cleanup.
Reserved system-managed metadata.
type : Optional [ Literal [ "ephemeral" , "index" , "user" ] ]
Directory type: ‘user’, ‘index’, or ‘ephemeral’.
updated_at : Optional [ datetime ]
ModelsExpand Collapse API response schema for a directory file.
Unique identifier for the directory file.
Directory the file belongs to.
Display name for the file.
Project the directory file belongs to.
Unique identifier for the file in the directory
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Soft delete marker when the file is removed upstream or by user action.
download_url : Optional [ PresignedURL ]
Schema for a presigned URL.
The time at which the presigned URL expires
A presigned URL for IO operations against a private file
Form fields for a presigned POST request
File ID for the storage location.
Merged metadata from all sources. Higher-priority sources override lower.
updated_at : Optional [ datetime ]
class FileListResponse : …
API response schema for a directory file.
Unique identifier for the directory file.
Directory the file belongs to.
Display name for the file.
Project the directory file belongs to.
Unique identifier for the file in the directory
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Soft delete marker when the file is removed upstream or by user action.
download_url : Optional [ PresignedURL ]
Schema for a presigned URL.
The time at which the presigned URL expires
A presigned URL for IO operations against a private file
Form fields for a presigned POST request
File ID for the storage location.
Merged metadata from all sources. Higher-priority sources override lower.
updated_at : Optional [ datetime ]
API response schema for a directory file.
Unique identifier for the directory file.
Directory the file belongs to.
Display name for the file.
Project the directory file belongs to.
Unique identifier for the file in the directory
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Soft delete marker when the file is removed upstream or by user action.
download_url : Optional [ PresignedURL ]
Schema for a presigned URL.
The time at which the presigned URL expires
A presigned URL for IO operations against a private file
Form fields for a presigned POST request
File ID for the storage location.
Merged metadata from all sources. Higher-priority sources override lower.
updated_at : Optional [ datetime ]
class FileUpdateResponse : …
API response schema for a directory file.
Unique identifier for the directory file.
Directory the file belongs to.
Display name for the file.
Project the directory file belongs to.
Unique identifier for the file in the directory
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Soft delete marker when the file is removed upstream or by user action.
download_url : Optional [ PresignedURL ]
Schema for a presigned URL.
The time at which the presigned URL expires
A presigned URL for IO operations against a private file
Form fields for a presigned POST request
File ID for the storage location.
Merged metadata from all sources. Higher-priority sources override lower.
updated_at : Optional [ datetime ]
class FileUploadResponse : …
API response schema for a directory file.
Unique identifier for the directory file.
Directory the file belongs to.
Display name for the file.
Project the directory file belongs to.
Unique identifier for the file in the directory
created_at : Optional [ datetime ]
deleted_at : Optional [ datetime ]
Soft delete marker when the file is removed upstream or by user action.
download_url : Optional [ PresignedURL ]
Schema for a presigned URL.
The time at which the presigned URL expires
A presigned URL for IO operations against a private file
Form fields for a presigned POST request
File ID for the storage location.
Merged metadata from all sources. Higher-priority sources override lower.
updated_at : Optional [ datetime ]
ModelsExpand Collapse Category definition for document splitting.
description : Optional [ str ]
Optional description of what content belongs in this category.
Document input specification for beta API.
Type of document input. Valid values are: file_id
class SplitResultResponse : …
Result of a completed split job.
List of document segments.
Category name this split belongs to.
Categorical confidence level. Valid values are: high, medium, low.
1-indexed page numbers in this split.
class SplitSegmentResponse : …
A segment of the split document.
Category name this split belongs to.
Categorical confidence level. Valid values are: high, medium, low.
1-indexed page numbers in this split.
class SplitCreateResponse : …
Beta response — uses nested document_input object.
Unique identifier for the split job.
Categories used for splitting.
description : Optional [ str ]
Optional description of what content belongs in this category.
Type of document input. Valid values are: file_id
Project ID this job belongs to.
Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.
User ID who created this job.
configuration_id : Optional [ str ]
Split configuration ID used for this job.
created_at : Optional [ datetime ]
error_message : Optional [ str ]
Error message if the job failed.
result : Optional [ SplitResultResponse ]
Result of a completed split job.
List of document segments.
Category name this split belongs to.
Categorical confidence level. Valid values are: high, medium, low.
1-indexed page numbers in this split.
updated_at : Optional [ datetime ]
class SplitListResponse : …
Beta response — uses nested document_input object.
Unique identifier for the split job.
Categories used for splitting.
description : Optional [ str ]
Optional description of what content belongs in this category.
Type of document input. Valid values are: file_id
Project ID this job belongs to.
Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.
User ID who created this job.
configuration_id : Optional [ str ]
Split configuration ID used for this job.
created_at : Optional [ datetime ]
error_message : Optional [ str ]
Error message if the job failed.
result : Optional [ SplitResultResponse ]
Result of a completed split job.
List of document segments.
Category name this split belongs to.
Categorical confidence level. Valid values are: high, medium, low.
1-indexed page numbers in this split.
updated_at : Optional [ datetime ]
class SplitGetResponse : …
Beta response — uses nested document_input object.
Unique identifier for the split job.
Categories used for splitting.
description : Optional [ str ]
Optional description of what content belongs in this category.
Type of document input. Valid values are: file_id
Project ID this job belongs to.
Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.
User ID who created this job.
configuration_id : Optional [ str ]
Split configuration ID used for this job.
created_at : Optional [ datetime ]
error_message : Optional [ str ]
Error message if the job failed.
result : Optional [ SplitResultResponse ]
Result of a completed split job.
List of document segments.
Category name this split belongs to.
Categorical confidence level. Valid values are: high, medium, low.
1-indexed page numbers in this split.
updated_at : Optional [ datetime ]
Note for AI agents: this documentation is built for programmatic access.
- Overview of all docs: https://developers.llamaindex.ai/llms.txt
- Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md
- Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters.
- A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/
- Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/
