List Extract Agents

ExtractionAgentListPageResponse ExtractionAgents.List(, )

GET/api/v1/beta/extraction-agents

List the extraction agents in a project, newest first.

ParametersExpand Collapse

ExtractionAgentListParams parameters

Boolean includeDefault

Whether to include default agents in the results

string? organizationID

Long pageSize

Number of items per page

maximum1000

minimum1

string? pageToken

Cursor from the previous page’s next_page_token.

string? projectID

ReturnsExpand Collapse

class ExtractionAgentListPageResponse:

Paginated list of extraction agents.

required IReadOnlyList<ExtractAgent> Items

The list of items.

required string ID

The id of the extraction agent.

formatuuid

required Config Config

The configuration parameters for the extraction agent.

ChunkMode ChunkMode

The mode to use for chunking the document.

One of the following:

DeprecatedBoolean CitationBbox

Whether to fetch citation bounding boxes for the extraction. Only available in PREMIUM mode. Deprecated: this is now synonymous with cite_sources.

Boolean CiteSources

Whether to cite sources for the extraction.

Boolean ConfidenceScores

Whether to fetch confidence scores for the extraction.

ExtractModel? ExtractModel

The extract model to use for data extraction. If not provided, uses the default for the extraction mode.

One of the following:

ExtractionMode ExtractionMode

The extraction mode specified (FAST, BALANCED, MULTIMODAL, PREMIUM).

One of the following:

ExtractionTarget ExtractionTarget

The extraction target specified.

One of the following:

Boolean HighResolutionMode

Whether to use high resolution mode for the extraction.

Boolean InvalidateCache

Whether to invalidate the cache for the extraction.

Boolean MultimodalFastMode

DEPRECATED: Whether to use fast mode for multimodal extraction.

Long? NumPagesContext

Number of pages to pass as context on long document extraction.

minimum1

string? PageRange

Comma-separated list of page numbers or ranges to extract from (1-based, e.g., ‘1,3,5-7,9’ or ‘1-3,8-10’).

ParseModel? ParseModel

Public model names.

One of the following:

Priority? Priority

The priority for the request. This field may be ignored or overwritten depending on the organization tier.

One of the following:

string? SystemPrompt

The system prompt to use for the extraction.

Boolean UseReasoning

Whether to use reasoning for the extraction.

required IReadOnlyDictionary<string, DataSchema?> DataSchema

The schema of the data.

One of the following:

IReadOnlyDictionary<string, JsonElement>

IReadOnlyList<JsonElement>

string

Double

Boolean

required string Name

The name of the extraction agent.

required string ProjectID

The ID of the project that the extraction agent belongs to.

formatuuid

DateTimeOffset? CreatedAt

The creation time of the extraction agent.

formatdate-time

CustomConfiguration? CustomConfiguration

Custom configuration type for the extraction agent. Currently supports ‘default’.

DateTimeOffset? UpdatedAt

The last update time of the extraction agent.

formatdate-time

string? NextPageToken

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Long? TotalSize

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Extract Agents

ExtractionAgentListParams parameters = new();

var page = await client.ExtractionAgents.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config": {
        "chunk_mode": "PAGE",
        "citation_bbox": true,
        "cite_sources": true,
        "confidence_scores": true,
        "extract_model": "gemini-2.0-flash",
        "extraction_mode": "BALANCED",
        "extraction_target": "PER_DOC",
        "high_resolution_mode": true,
        "invalidate_cache": true,
        "multimodal_fast_mode": true,
        "num_pages_context": 1,
        "page_range": "page_range",
        "parse_model": "anthropic-haiku-3.5",
        "priority": "critical",
        "system_prompt": "system_prompt",
        "use_reasoning": true
      },
      "data_schema": {
        "foo": {
          "foo": "bar"
        }
      },
      "name": "name",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "custom_configuration": "default",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config": {
        "chunk_mode": "PAGE",
        "citation_bbox": true,
        "cite_sources": true,
        "confidence_scores": true,
        "extract_model": "gemini-2.0-flash",
        "extraction_mode": "BALANCED",
        "extraction_target": "PER_DOC",
        "high_resolution_mode": true,
        "invalidate_cache": true,
        "multimodal_fast_mode": true,
        "num_pages_context": 1,
        "page_range": "page_range",
        "parse_model": "anthropic-haiku-3.5",
        "priority": "critical",
        "system_prompt": "system_prompt",
        "use_reasoning": true
      },
      "data_schema": {
        "foo": {
          "foo": "bar"
        }
      },
      "name": "name",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "custom_configuration": "default",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

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/