Skip to content

List Extract Jobs

client.Extract.List(ctx, query) (*PaginatedCursor[ExtractV2Job], error)
GET/api/v2/extract

List extraction jobs with optional filtering and pagination.

Filter by configuration_id, status, file_input, or creation date range. Results are returned newest-first. Use expand=configuration to include the full configuration used, and expand=extract_metadata for per-field metadata.

ParametersExpand Collapse
query ExtractListParams
ConfigurationID param.Field[string]optional

Filter by configuration ID

CreatedAtOnOrAfter param.Field[Time]optional

Include items created at or after this timestamp (inclusive)

formatdate-time
CreatedAtOnOrBefore param.Field[Time]optional

Include items created at or before this timestamp (inclusive)

formatdate-time
DocumentInputType param.Field[string]optional

Filter by document input type (file_id or parse_job_id)

DeprecatedDocumentInputValue param.Field[string]optional

Deprecated: use file_input instead

Expand param.Field[[]string]optional

Additional fields to include: configuration, extract_metadata

FileInput param.Field[string]optional

Filter by file input value

JobIDs param.Field[[]string]optional

Filter by specific job IDs

OrganizationID param.Field[string]optional
PageSize param.Field[int64]optional

Number of items per page

PageToken param.Field[string]optional

Token for pagination

ProjectID param.Field[string]optional
Status param.Field[ExtractListParamsStatus]optional

Filter by status

const ExtractListParamsStatusPending ExtractListParamsStatus = "PENDING"
const ExtractListParamsStatusThrottled ExtractListParamsStatus = "THROTTLED"
const ExtractListParamsStatusRunning ExtractListParamsStatus = "RUNNING"
const ExtractListParamsStatusCompleted ExtractListParamsStatus = "COMPLETED"
const ExtractListParamsStatusFailed ExtractListParamsStatus = "FAILED"
const ExtractListParamsStatusCancelled ExtractListParamsStatus = "CANCELLED"
ReturnsExpand Collapse
type ExtractV2Job struct{…}

An extraction job.

ID string

Unique job identifier (job_id)

CreatedAt Time

Creation timestamp

formatdate-time
FileInput string

File ID or parse job ID that was extracted

ProjectID string

Project this job belongs to

Status string

Current job status.

  • PENDING — queued, not yet started
  • RUNNING — actively processing
  • COMPLETED — finished successfully
  • FAILED — terminated with an error
  • CANCELLED — cancelled by user
UpdatedAt Time

Last update timestamp

formatdate-time
Configuration ExtractConfigurationoptional

Extract configuration combining parse and extract settings.

DataSchema map[string, ExtractConfigurationDataSchemaUnion]

JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.

One of the following:
type ExtractConfigurationDataSchemaMap map[string, any]
type ExtractConfigurationDataSchemaArray []any
string
float64
bool
CiteSources booloptional

Include citations in results

ConfidenceScores booloptional

Include confidence scores in results

ExtractVersion stringoptional

Extract algorithm version. Use ‘latest’ for the default pipeline or a date string (e.g. ‘2026-01-08’) to pin to a specific release.

ExtractionTarget ExtractConfigurationExtractionTargetoptional

Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row

One of the following:
const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"
const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"
const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"
MaxPages int64optional

Maximum number of pages to process. Omit for no limit.

minimum1
ParseConfigID stringoptional

Saved parse configuration ID to control how the document is parsed before extraction

ParseTier stringoptional

Parse tier to use before extraction. Defaults to the extract tier if not specified.

SystemPrompt stringoptional

Custom system prompt to guide extraction behavior

TargetPages stringoptional

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

Tier ExtractConfigurationTieroptional

Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)

One of the following:
const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"
const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"
ConfigurationID stringoptional

Saved extract configuration ID used for this job, if any

ErrorMessage stringoptional

Error details when status is FAILED

ExtractMetadata ExtractJobMetadataoptional

Extraction metadata.

FieldMetadata ExtractedFieldMetadataoptional

Metadata for extracted fields including document, page, and row level info.

DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]optional

Per-field metadata keyed by field name from your schema. Scalar fields (e.g. vendor) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. items) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively.

One of the following:
type ExtractedFieldMetadataDocumentMetadataMap map[string, any]
type ExtractedFieldMetadataDocumentMetadataArray []any
string
float64
bool
PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]optional

Per-page metadata when extraction_target is per_page

One of the following:
type ExtractedFieldMetadataPageMetadataMap map[string, any]
type ExtractedFieldMetadataPageMetadataArray []any
string
float64
bool
RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]optional

Per-row metadata when extraction_target is per_table_row

One of the following:
type ExtractedFieldMetadataRowMetadataMap map[string, any]
type ExtractedFieldMetadataRowMetadataArray []any
string
float64
bool
ParseJobID stringoptional

Reference to the ParseJob ID used for parsing

ParseTier stringoptional

Parse tier used for parsing the document

ExtractResult ExtractV2JobExtractResultUnionoptional

Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row.

One of the following:
type ExtractV2JobExtractResultMap map[string, ExtractV2JobExtractResultMapItemUnion]
One of the following:
type ExtractV2JobExtractResultMapItemMap map[string, any]
type ExtractV2JobExtractResultMapItemArray []any
string
float64
bool
type ExtractV2JobExtractResultArray []map[string, ExtractV2JobExtractResultArrayItemUnion]
One of the following:
type ExtractV2JobExtractResultArrayItemMap map[string, any]
type ExtractV2JobExtractResultArrayItemArray []any
string
float64
bool
Metadata ExtractV2JobMetadataoptional

Job-level metadata.

Usage ExtractJobUsageoptional

Extraction usage metrics.

NumDocumentTokens int64optional

Number of document tokens

NumOutputTokens int64optional

Number of output tokens

NumPagesExtracted int64optional

Number of pages extracted

List Extract Jobs

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/llamacloud-prod-go"
  "github.com/stainless-sdks/llamacloud-prod-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Extract.List(context.TODO(), llamacloudprod.ExtractListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "items": [
    {
      "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "COMPLETED",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "configuration": {
        "data_schema": {
          "foo": {
            "foo": "bar"
          }
        },
        "cite_sources": true,
        "confidence_scores": true,
        "extract_version": "latest",
        "extraction_target": "per_doc",
        "max_pages": 10,
        "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555",
        "parse_tier": "fast",
        "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.",
        "target_pages": "1,3,5-7",
        "tier": "cost_effective"
      },
      "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
      "error_message": "error_message",
      "extract_metadata": {
        "field_metadata": {
          "document_metadata": {
            "items": [
              {
                "amount": {
                  "citation": [
                    {
                      "matching_text": "$10.00",
                      "page": 1
                    }
                  ],
                  "confidence": 1
                },
                "description": {
                  "citation": [
                    {
                      "matching_text": "$10/month",
                      "page": 1
                    }
                  ],
                  "confidence": 0.998
                }
              }
            ],
            "total": {
              "citation": "bar",
              "confidence": "bar"
            },
            "vendor": {
              "citation": "bar",
              "confidence": "bar",
              "extraction_confidence": "bar",
              "parsing_confidence": "bar"
            }
          },
          "page_metadata": [
            {
              "foo": {
                "foo": "bar"
              }
            }
          ],
          "row_metadata": [
            {
              "foo": {
                "foo": "bar"
              }
            }
          ]
        },
        "parse_job_id": "parse_job_id",
        "parse_tier": "parse_tier"
      },
      "extract_result": {
        "foo": {
          "foo": "bar"
        }
      },
      "metadata": {
        "usage": {
          "num_document_tokens": 0,
          "num_output_tokens": 0,
          "num_pages_extracted": 0
        }
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "COMPLETED",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "configuration": {
        "data_schema": {
          "foo": {
            "foo": "bar"
          }
        },
        "cite_sources": true,
        "confidence_scores": true,
        "extract_version": "latest",
        "extraction_target": "per_doc",
        "max_pages": 10,
        "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555",
        "parse_tier": "fast",
        "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.",
        "target_pages": "1,3,5-7",
        "tier": "cost_effective"
      },
      "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
      "error_message": "error_message",
      "extract_metadata": {
        "field_metadata": {
          "document_metadata": {
            "items": [
              {
                "amount": {
                  "citation": [
                    {
                      "matching_text": "$10.00",
                      "page": 1
                    }
                  ],
                  "confidence": 1
                },
                "description": {
                  "citation": [
                    {
                      "matching_text": "$10/month",
                      "page": 1
                    }
                  ],
                  "confidence": 0.998
                }
              }
            ],
            "total": {
              "citation": "bar",
              "confidence": "bar"
            },
            "vendor": {
              "citation": "bar",
              "confidence": "bar",
              "extraction_confidence": "bar",
              "parsing_confidence": "bar"
            }
          },
          "page_metadata": [
            {
              "foo": {
                "foo": "bar"
              }
            }
          ],
          "row_metadata": [
            {
              "foo": {
                "foo": "bar"
              }
            }
          ]
        },
        "parse_job_id": "parse_job_id",
        "parse_tier": "parse_tier"
      },
      "extract_result": {
        "foo": {
          "foo": "bar"
        }
      },
      "metadata": {
        "usage": {
          "num_document_tokens": 0,
          "num_output_tokens": 0,
          "num_pages_extracted": 0
        }
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}