API Reference

Extract

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Extract Job

client.Extract.Cancel(ctx, jobID, body) (*ExtractV2Job, error)

POST/api/v2/extract/{job_id}/cancel

Cancel a running extraction job.

Stops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.

ParametersExpand Collapse

jobID string

body ExtractCancelParams

OrganizationID param.Field[string]Optional

ProjectID param.Field[string]Optional

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. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).

ConfidenceScores boolOptional

Include confidence scores in results. Returned under extract_metadata (auto-included when set).

DisableCache boolOptional

Disable reuse and storage of Extract results

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. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.

ParseTier ExtractConfigurationParseTierOptional

Parse tier to use before extraction. Defaults to the extract tier if not specified. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.

One of the following:

const ExtractConfigurationParseTierAgentic ExtractConfigurationParseTier = "agentic"

const ExtractConfigurationParseTierAgenticPlus ExtractConfigurationParseTier = "agentic_plus"

const ExtractConfigurationParseTierCostEffective ExtractConfigurationParseTier = "cost_effective"

const ExtractConfigurationParseTierFast ExtractConfigurationParseTier = "fast"

SheetNames []stringOptional

Optional worksheet names to extract when spreadsheet_mode is on. Overrides target_pages for spreadsheets; omit to extract every sheet. Names are matched exactly (case-sensitive) — pass them as a list, e.g. [“Sheet 1”, “My Sheet”].

SpreadsheetMode boolOptional

Beta. When true, extract structured data directly from a spreadsheet workbook (.xlsx/.xls/.csv) — the agent reads cells straight from the workbook instead of the standard document path. Off by default (spreadsheets keep the standard path). Requires the agentic_plus tier. Billed on the standard per-page extract rate, against a page count derived from workbook size. Citations and confidence scores are not available in this mode.

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), agentic (15 credits/page), agentic_plus (50 credits/page), or turbo (35 credits/page)

One of the following:

const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"

const ExtractConfigurationTierAgenticPlus ExtractConfigurationTier = "agentic_plus"

const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"

const ExtractConfigurationTierTurbo ExtractConfigurationTier = "turbo"

Version stringOptional

Use ‘latest’ for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date. Job responses always report the concrete resolved version the job runs, fixed at job creation; saved configurations keep the value as provided.

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.

NumPagesBilled int64Optional

Number of effective pages billed

NumPagesExtracted int64Optional

Number of pages extracted

Usage ExtractV2JobUsageOptional

Usage recorded against an extract job.

A parse job can back several extract jobs, so each of them reports that same parse cost in its total.

Credits float64Optional

Total credits billed against this job. Null until billing has recorded it.

ExtractCredits float64Optional

Credits billed for the extraction itself

ParseCredits float64Optional

Credits billed against the parse job backing this extract job

Cancel Extract Job

Go

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  extractV2Job, err := client.Extract.Cancel(
    context.TODO(),
    "job_id",
    llamacloud.ExtractCancelParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", extractV2Job.ID)
}

200 example

{
  "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,
    "disable_cache": true,
    "extraction_target": "per_doc",
    "max_pages": 10,
    "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555",
    "parse_tier": "fast",
    "sheet_names": [
      "Sheet 1",
      "Q4 Summary"
    ],
    "spreadsheet_mode": true,
    "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",
    "version": "latest"
  },
  "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_pages_billed": 0,
      "num_pages_extracted": 0
    }
  },
  "usage": {
    "credits": 30,
    "extract_credits": 45,
    "parse_credits": 30
  }
}

Returns Examples

200 example

{
  "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,
    "disable_cache": true,
    "extraction_target": "per_doc",
    "max_pages": 10,
    "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555",
    "parse_tier": "fast",
    "sheet_names": [
      "Sheet 1",
      "Q4 Summary"
    ],
    "spreadsheet_mode": true,
    "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",
    "version": "latest"
  },
  "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_pages_billed": 0,
      "num_pages_extracted": 0
    }
  },
  "usage": {
    "credits": 30,
    "extract_credits": 45,
    "parse_credits": 30
  }
}