# Extraction Agents

## List Extract Agents

**get** `/api/v1/beta/extraction-agents`

List the extraction agents in a project, newest first.

### Query Parameters

- `include_default: optional boolean`

  Whether to include default agents in the results

- `organization_id: optional string`

- `page_size: optional number`

  Number of items per page

- `page_token: optional string`

  Cursor from the previous page's `next_page_token`.

- `project_id: optional string`

### Cookie Parameters

- `session: optional string`

### Returns

- `items: array of ExtractAgent`

  The list of items.

  - `id: string`

    The id of the extraction agent.

  - `config: object { chunk_mode, citation_bbox, cite_sources, 13 more }`

    The configuration parameters for the extraction agent.

    - `chunk_mode: optional "PAGE" or "SECTION"`

      The mode to use for chunking the document.

      - `"PAGE"`

      - `"SECTION"`

    - `citation_bbox: optional boolean`

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

    - `cite_sources: optional boolean`

      Whether to cite sources for the extraction.

    - `confidence_scores: optional boolean`

      Whether to fetch confidence scores for the extraction.

    - `extract_model: optional "gemini-2.0-flash" or "gemini-2.5-flash" or "gemini-2.5-flash-lite" or 8 more or string`

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

      - `ExtractModels = "gemini-2.0-flash" or "gemini-2.5-flash" or "gemini-2.5-flash-lite" or 8 more`

        Extract model options.

        - `"gemini-2.0-flash"`

        - `"gemini-2.5-flash"`

        - `"gemini-2.5-flash-lite"`

        - `"gemini-2.5-pro"`

        - `"openai-gpt-4-1"`

        - `"openai-gpt-4-1-mini"`

        - `"openai-gpt-4-1-nano"`

        - `"openai-gpt-4o"`

        - `"openai-gpt-4o-mini"`

        - `"openai-gpt-5"`

        - `"openai-gpt-5-mini"`

      - `string`

    - `extraction_mode: optional "BALANCED" or "FAST" or "MULTIMODAL" or "PREMIUM"`

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

      - `"BALANCED"`

      - `"FAST"`

      - `"MULTIMODAL"`

      - `"PREMIUM"`

    - `extraction_target: optional "PER_DOC" or "PER_PAGE" or "PER_TABLE_ROW"`

      The extraction target specified.

      - `"PER_DOC"`

      - `"PER_PAGE"`

      - `"PER_TABLE_ROW"`

    - `high_resolution_mode: optional boolean`

      Whether to use high resolution mode for the extraction.

    - `invalidate_cache: optional boolean`

      Whether to invalidate the cache for the extraction.

    - `multimodal_fast_mode: optional boolean`

      DEPRECATED: Whether to use fast mode for multimodal extraction.

    - `num_pages_context: optional number`

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

    - `page_range: optional string`

      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').

    - `parse_model: optional "anthropic-haiku-3.5" or "anthropic-haiku-4.5" or "anthropic-sonnet-3.5" or 22 more`

      Public model names.

      - `"anthropic-haiku-3.5"`

      - `"anthropic-haiku-4.5"`

      - `"anthropic-sonnet-3.5"`

      - `"anthropic-sonnet-3.5-v2"`

      - `"anthropic-sonnet-3.7"`

      - `"anthropic-sonnet-4.0"`

      - `"anthropic-sonnet-4.5"`

      - `"gemini-2.0-flash"`

      - `"gemini-2.0-flash-lite"`

      - `"gemini-2.5-flash"`

      - `"gemini-2.5-flash-lite"`

      - `"gemini-2.5-pro"`

      - `"gemini-3.0-pro"`

      - `"gemini-3.1-pro"`

      - `"openai-gpt-4-1"`

      - `"openai-gpt-4-1-mini"`

      - `"openai-gpt-4-1-nano"`

      - `"openai-gpt-4o"`

      - `"openai-gpt-4o-mini"`

      - `"openai-gpt-5"`

      - `"openai-gpt-5-mini"`

      - `"openai-gpt-5-nano"`

      - `"openai-text-embedding-3-large"`

      - `"openai-text-embedding-3-small"`

      - `"openai-whisper-1"`

    - `priority: optional "critical" or "high" or "low" or "medium"`

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

      - `"critical"`

      - `"high"`

      - `"low"`

      - `"medium"`

    - `system_prompt: optional string`

      The system prompt to use for the extraction.

    - `use_reasoning: optional boolean`

      Whether to use reasoning for the extraction.

  - `data_schema: map[map[unknown] or array of unknown or string or 2 more]`

    The schema of the data.

    - `map[unknown]`

    - `array of unknown`

    - `string`

    - `number`

    - `boolean`

  - `name: string`

    The name of the extraction agent.

  - `project_id: string`

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

  - `created_at: optional string`

    The creation time of the extraction agent.

  - `custom_configuration: optional "default"`

    Custom configuration type for the extraction agent. Currently supports 'default'.

    - `"default"`

  - `updated_at: optional string`

    The last update time of the extraction agent.

- `next_page_token: optional string`

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

- `total_size: optional number`

  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.

### Example

```http
curl https://api.cloud.llamaindex.ai/api/v1/beta/extraction-agents \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"
```

#### Response

```json
{
  "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
}
```

## Domain Types

### Extract Agent

- `ExtractAgent object { id, config, data_schema, 5 more }`

  Schema and configuration for an extraction agent.

  - `id: string`

    The id of the extraction agent.

  - `config: object { chunk_mode, citation_bbox, cite_sources, 13 more }`

    The configuration parameters for the extraction agent.

    - `chunk_mode: optional "PAGE" or "SECTION"`

      The mode to use for chunking the document.

      - `"PAGE"`

      - `"SECTION"`

    - `citation_bbox: optional boolean`

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

    - `cite_sources: optional boolean`

      Whether to cite sources for the extraction.

    - `confidence_scores: optional boolean`

      Whether to fetch confidence scores for the extraction.

    - `extract_model: optional "gemini-2.0-flash" or "gemini-2.5-flash" or "gemini-2.5-flash-lite" or 8 more or string`

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

      - `ExtractModels = "gemini-2.0-flash" or "gemini-2.5-flash" or "gemini-2.5-flash-lite" or 8 more`

        Extract model options.

        - `"gemini-2.0-flash"`

        - `"gemini-2.5-flash"`

        - `"gemini-2.5-flash-lite"`

        - `"gemini-2.5-pro"`

        - `"openai-gpt-4-1"`

        - `"openai-gpt-4-1-mini"`

        - `"openai-gpt-4-1-nano"`

        - `"openai-gpt-4o"`

        - `"openai-gpt-4o-mini"`

        - `"openai-gpt-5"`

        - `"openai-gpt-5-mini"`

      - `string`

    - `extraction_mode: optional "BALANCED" or "FAST" or "MULTIMODAL" or "PREMIUM"`

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

      - `"BALANCED"`

      - `"FAST"`

      - `"MULTIMODAL"`

      - `"PREMIUM"`

    - `extraction_target: optional "PER_DOC" or "PER_PAGE" or "PER_TABLE_ROW"`

      The extraction target specified.

      - `"PER_DOC"`

      - `"PER_PAGE"`

      - `"PER_TABLE_ROW"`

    - `high_resolution_mode: optional boolean`

      Whether to use high resolution mode for the extraction.

    - `invalidate_cache: optional boolean`

      Whether to invalidate the cache for the extraction.

    - `multimodal_fast_mode: optional boolean`

      DEPRECATED: Whether to use fast mode for multimodal extraction.

    - `num_pages_context: optional number`

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

    - `page_range: optional string`

      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').

    - `parse_model: optional "anthropic-haiku-3.5" or "anthropic-haiku-4.5" or "anthropic-sonnet-3.5" or 22 more`

      Public model names.

      - `"anthropic-haiku-3.5"`

      - `"anthropic-haiku-4.5"`

      - `"anthropic-sonnet-3.5"`

      - `"anthropic-sonnet-3.5-v2"`

      - `"anthropic-sonnet-3.7"`

      - `"anthropic-sonnet-4.0"`

      - `"anthropic-sonnet-4.5"`

      - `"gemini-2.0-flash"`

      - `"gemini-2.0-flash-lite"`

      - `"gemini-2.5-flash"`

      - `"gemini-2.5-flash-lite"`

      - `"gemini-2.5-pro"`

      - `"gemini-3.0-pro"`

      - `"gemini-3.1-pro"`

      - `"openai-gpt-4-1"`

      - `"openai-gpt-4-1-mini"`

      - `"openai-gpt-4-1-nano"`

      - `"openai-gpt-4o"`

      - `"openai-gpt-4o-mini"`

      - `"openai-gpt-5"`

      - `"openai-gpt-5-mini"`

      - `"openai-gpt-5-nano"`

      - `"openai-text-embedding-3-large"`

      - `"openai-text-embedding-3-small"`

      - `"openai-whisper-1"`

    - `priority: optional "critical" or "high" or "low" or "medium"`

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

      - `"critical"`

      - `"high"`

      - `"low"`

      - `"medium"`

    - `system_prompt: optional string`

      The system prompt to use for the extraction.

    - `use_reasoning: optional boolean`

      Whether to use reasoning for the extraction.

  - `data_schema: map[map[unknown] or array of unknown or string or 2 more]`

    The schema of the data.

    - `map[unknown]`

    - `array of unknown`

    - `string`

    - `number`

    - `boolean`

  - `name: string`

    The name of the extraction agent.

  - `project_id: string`

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

  - `created_at: optional string`

    The creation time of the extraction agent.

  - `custom_configuration: optional "default"`

    Custom configuration type for the extraction agent. Currently supports 'default'.

    - `"default"`

  - `updated_at: optional string`

    The last update time of the extraction agent.