## List Extract Agents

`ExtractionAgentListPageResponse ExtractionAgents.List(ExtractionAgentListParams?parameters, CancellationTokencancellationToken = default)`

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

List the extraction agents in a project, newest first.

### Parameters

- `ExtractionAgentListParams parameters`

  - `Boolean includeDefault`

    Whether to include default agents in the results

  - `string? organizationID`

  - `Long pageSize`

    Number of items per page

  - `string? pageToken`

    Cursor from the previous page's `next_page_token`.

  - `string? projectID`

### Returns

- `class ExtractionAgentListPageResponse:`

  Paginated list of extraction agents.

  - `required IReadOnlyList<ExtractAgent> Items`

    The list of items.

    - `required string ID`

      The id of the extraction agent.

    - `required Config Config`

      The configuration parameters for the extraction agent.

      - `ChunkMode ChunkMode`

        The mode to use for chunking the document.

        - `"PAGE"Page`

        - `"SECTION"Section`

      - `Boolean 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.

        - `"gemini-2.0-flash"Gemini2_0Flash`

        - `"gemini-2.5-flash"Gemini2_5Flash`

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

        - `"gemini-2.5-pro"Gemini2_5Pro`

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

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

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

        - `"openai-gpt-4o"OpenAIGpt4o`

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

        - `"openai-gpt-5"OpenAIGpt5`

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

      - `ExtractionMode ExtractionMode`

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

        - `"BALANCED"Balanced`

        - `"FAST"Fast`

        - `"MULTIMODAL"Multimodal`

        - `"PREMIUM"Premium`

      - `ExtractionTarget ExtractionTarget`

        The extraction target specified.

        - `"PER_DOC"PerDoc`

        - `"PER_PAGE"PerPage`

        - `"PER_TABLE_ROW"PerTableRow`

      - `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.

      - `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.

        - `"anthropic-haiku-3.5"AnthropicHaiku3_5`

        - `"anthropic-haiku-4.5"AnthropicHaiku4_5`

        - `"anthropic-sonnet-3.5"AnthropicSonnet3_5`

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

        - `"anthropic-sonnet-3.7"AnthropicSonnet3_7`

        - `"anthropic-sonnet-4.0"AnthropicSonnet4_0`

        - `"anthropic-sonnet-4.5"AnthropicSonnet4_5`

        - `"gemini-2.0-flash"Gemini2_0Flash`

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

        - `"gemini-2.5-flash"Gemini2_5Flash`

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

        - `"gemini-2.5-pro"Gemini2_5Pro`

        - `"gemini-3.0-pro"Gemini3_0Pro`

        - `"gemini-3.1-pro"Gemini3_1Pro`

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

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

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

        - `"openai-gpt-4o"OpenAIGpt4o`

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

        - `"openai-gpt-5"OpenAIGpt5`

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

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

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

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

        - `"openai-whisper-1"OpenAIWhisper1`

      - `Priority? Priority`

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

        - `"critical"Critical`

        - `"high"High`

        - `"low"Low`

        - `"medium"Medium`

      - `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.

      - `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.

    - `DateTimeOffset? CreatedAt`

      The creation time of the extraction agent.

    - `CustomConfiguration? CustomConfiguration`

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

      - `"default"Default`

    - `DateTimeOffset? UpdatedAt`

      The last update time of the extraction agent.

  - `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.

### Example

```csharp
ExtractionAgentListParams parameters = new();

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

#### 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
}
```
