## Cancel Extract Job `extract.cancel(strjob_id, ExtractCancelParams**kwargs) -> ExtractV2Job` **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. ### Parameters - `job_id: str` - `organization_id: Optional[str]` - `project_id: Optional[str]` ### Returns - `class ExtractV2Job: …` An extraction job. - `id: str` Unique job identifier (job_id) - `created_at: datetime` Creation timestamp - `file_input: str` File ID or parse job ID that was extracted - `project_id: str` Project this job belongs to - `status: str` Current job status. - `PENDING` — queued, not yet started - `RUNNING` — actively processing - `COMPLETED` — finished successfully - `FAILED` — terminated with an error - `CANCELLED` — cancelled by user - `updated_at: datetime` Last update timestamp - `configuration: Optional[ExtractConfiguration]` Extract configuration combining parse and extract settings. - `data_schema: Dict[str, Union[Dict[str, object], List[object], str, 3 more]]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `Dict[str, object]` - `List[object]` - `str` - `float` - `bool` - `cite_sources: Optional[bool]` Include citations in results. Returned under `extract_metadata` (auto-included when set). Text-level on `turbo` (no bounding boxes). - `confidence_scores: Optional[bool]` Include confidence scores in results. Returned under `extract_metadata` (auto-included when set). - `disable_cache: Optional[bool]` Disable reuse and storage of Extract results - `extraction_target: Optional[Literal["per_doc", "per_page", "per_table_row"]]` 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 - `"per_doc"` - `"per_page"` - `"per_table_row"` - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `parse_config_id: Optional[str]` 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. - `parse_tier: Optional[Literal["agentic", "agentic_plus", "cost_effective", "fast"]]` 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. - `"agentic"` - `"agentic_plus"` - `"cost_effective"` - `"fast"` - `sheet_names: Optional[List[str]]` 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"]. - `spreadsheet_mode: Optional[bool]` 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. - `system_prompt: Optional[str]` Custom system prompt to guide extraction behavior - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `tier: Optional[Literal["agentic", "agentic_plus", "cost_effective", "turbo"]]` Extract tier: cost_effective (5 credits/page), agentic (15 credits/page), agentic_plus (50 credits/page), or turbo (35 credits/page) - `"agentic"` - `"agentic_plus"` - `"cost_effective"` - `"turbo"` - `version: Optional[str]` 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. - `configuration_id: Optional[str]` Saved extract configuration ID used for this job, if any - `error_message: Optional[str]` Error details when status is FAILED - `extract_metadata: Optional[ExtractJobMetadata]` Extraction metadata. - `field_metadata: Optional[ExtractedFieldMetadata]` Metadata for extracted fields including document, page, and row level info. - `document_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]` 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. - `Dict[str, object]` - `List[object]` - `str` - `float` - `bool` - `page_metadata: Optional[List[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]]` Per-page metadata when extraction_target is per_page - `Dict[str, object]` - `List[object]` - `str` - `float` - `bool` - `row_metadata: Optional[List[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]]` Per-row metadata when extraction_target is per_table_row - `Dict[str, object]` - `List[object]` - `str` - `float` - `bool` - `parse_job_id: Optional[str]` Reference to the ParseJob ID used for parsing - `parse_tier: Optional[str]` Parse tier used for parsing the document - `extract_result: Optional[Union[Dict[str, Union[Dict[str, object], List[object], str, 3 more]], List[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]], null]]` Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row. - `Dict[str, Union[Dict[str, object], List[object], str, 3 more]]` - `Dict[str, object]` - `List[object]` - `str` - `float` - `bool` - `List[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]` - `Dict[str, object]` - `List[object]` - `str` - `float` - `bool` - `metadata: Optional[Metadata]` Job-level metadata. - `usage: Optional[ExtractJobUsage]` Extraction usage metrics. - `num_pages_billed: Optional[int]` Number of effective pages billed - `num_pages_extracted: Optional[int]` Number of pages extracted - `usage: Optional[Usage]` 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: Optional[float]` Total credits billed against this job. Null until billing has recorded it. - `extract_credits: Optional[float]` Credits billed for the extraction itself - `parse_credits: Optional[float]` Credits billed against the parse job backing this extract job ### Example ```python import os from llama_cloud import LlamaCloud client = LlamaCloud( api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted ) extract_v2_job = client.extract.cancel( job_id="job_id", ) print(extract_v2_job.id) ``` #### Response ```json { "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 } } ```