LlamaParse LlamaExtract API
The LlamaExtract API from LlamaParse — 16 operation(s) for llamaextract.
The LlamaExtract API from LlamaParse — 16 operation(s) for llamaextract.
openapi: 3.0.3
info:
title: Llama Platform Agent Data LlamaExtract API
version: 0.1.0
tags:
- name: LlamaExtract
paths:
/api/v1/extraction/jobs:
get:
tags:
- LlamaExtract
summary: List Jobs
operationId: list_jobs_api_v1_extraction_jobs_get
security:
- HTTPBearer: []
parameters:
- name: extraction_agent_id
in: query
required: true
schema:
type: string
format: uuid
title: Extraction Agent Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExtractJob'
title: Response List Jobs Api V1 Extraction Jobs Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- LlamaExtract
summary: Run Job
operationId: run_job_api_v1_extraction_jobs_post
security:
- HTTPBearer: []
parameters:
- name: from_ui
in: query
required: false
schema:
type: boolean
default: false
title: From Ui
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractJobCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractJob'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/jobs/{job_id}:
get:
tags:
- LlamaExtract
summary: Get Job
operationId: get_job_api_v1_extraction_jobs__job_id__get
security:
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
format: uuid
title: Job Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractJob'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/jobs/file:
post:
tags:
- LlamaExtract
summary: Run Job On File
operationId: run_job_on_file_api_v1_extraction_jobs_file_post
security:
- HTTPBearer: []
parameters:
- name: from_ui
in: query
required: false
schema:
type: boolean
default: false
title: From Ui
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_run_job_on_file_api_v1_extraction_jobs_file_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractJob'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/jobs/batch:
post:
tags:
- LlamaExtract
summary: Run Batch Jobs
operationId: run_batch_jobs_api_v1_extraction_jobs_batch_post
security:
- HTTPBearer: []
parameters:
- name: from_ui
in: query
required: false
schema:
type: boolean
default: false
title: From Ui
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractJobCreateBatch'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExtractJob'
title: Response Run Batch Jobs Api V1 Extraction Jobs Batch Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/jobs/{job_id}/result:
get:
tags:
- LlamaExtract
summary: Get Job Result
operationId: get_job_result_api_v1_extraction_jobs__job_id__result_get
security:
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
format: uuid
title: Job Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractResultset'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/runs:
get:
tags:
- LlamaExtract
summary: List Extract Runs
operationId: list_extract_runs_api_v1_extraction_runs_get
security:
- HTTPBearer: []
parameters:
- name: extraction_agent_id
in: query
required: true
schema:
type: string
format: uuid
title: Extraction Agent Id
- name: skip
in: query
required: false
schema:
type: integer
default: 0
title: Skip
- name: limit
in: query
required: false
schema:
type: integer
default: 25
title: Limit
- name: status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by status
title: Status
description: Filter by status
- name: run_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by run ID
title: Run Id
description: Filter by run ID
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedExtractRunsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/runs/latest-from-ui:
get:
tags:
- LlamaExtract
summary: Get Latest Run From Ui
operationId: get_latest_run_from_ui_api_v1_extraction_runs_latest_from_ui_get
security:
- HTTPBearer: []
parameters:
- name: extraction_agent_id
in: query
required: true
schema:
type: string
format: uuid
title: Extraction Agent Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ExtractRun'
- type: 'null'
title: Response Get Latest Run From Ui Api V1 Extraction Runs Latest From Ui Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/runs/by-job/{job_id}:
get:
tags:
- LlamaExtract
summary: Get Run By Job Id
operationId: get_run_by_job_id_api_v1_extraction_runs_by_job__job_id__get
security:
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
format: uuid
title: Job Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractRun'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/runs/{run_id}:
get:
tags:
- LlamaExtract
summary: Get Run
operationId: get_run_api_v1_extraction_runs__run_id__get
security:
- HTTPBearer: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractRun'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- LlamaExtract
summary: Delete Extraction Run
operationId: delete_extraction_run_api_v1_extraction_runs__run_id__delete
security:
- HTTPBearer: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/run:
post:
tags:
- LlamaExtract
summary: Extract Stateless
description: Stateless extraction using a default agent in the user's default project; requires `data_schema`, `config`, and one of `file_id` / `text` / base64 file data.
operationId: extract_stateless_api_v1_extraction_run_post
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractStatelessRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractJob'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/extraction-agents:
post:
tags:
- LlamaExtract
summary: Create Extraction Agent
operationId: create_extraction_agent_api_v1_extraction_extraction_agents_post
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgentCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- LlamaExtract
summary: List Extraction Agents
operationId: list_extraction_agents_api_v1_extraction_extraction_agents_get
security:
- HTTPBearer: []
parameters:
- name: include_default
in: query
required: false
schema:
type: boolean
description: Whether to include default agents in the results
default: false
title: Include Default
description: Whether to include default agents in the results
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExtractAgent'
title: Response List Extraction Agents Api V1 Extraction Extraction Agents Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/extraction-agents/schema/validation:
post:
tags:
- LlamaExtract
summary: Validate Extraction Schema
description: Validate an extraction agent schema; returns the normalized schema or raises 400.
operationId: validate_extraction_schema_api_v1_extraction_extraction_agents_schema_validation_post
security:
- HTTPBearer: []
parameters:
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractSchemaValidateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractSchemaValidateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/extraction-agents/schema/generate:
post:
tags:
- LlamaExtract
summary: Generate Extraction Schema
description: Generate or refine an extraction agent schema from a file, natural-language prompt, or existing schema.
operationId: generate_extraction_schema_api_v1_extraction_extraction_agents_schema_generate_post
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractSchemaGenerateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractSchemaGenerateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/extraction-agents/by-name/{name}:
get:
tags:
- LlamaExtract
summary: Get Extraction Agent By Name
operationId: get_extraction_agent_by_name_api_v1_extraction_extraction_agents_by_name__name__get
deprecated: true
security:
- HTTPBearer: []
parameters:
- name: name
in: path
required: true
schema:
type: string
title: Name
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/extraction-agents/default:
get:
tags:
- LlamaExtract
summary: Get Or Create Default Extraction Agent
description: Get or create the default extraction agent for the current project (empty schema, default config).
operationId: get_or_create_default_extraction_agent_api_v1_extraction_extraction_agents_default_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/extraction/extraction-agents/{extraction_agent_id}:
get:
tags:
- LlamaExtract
summary: Get Extraction Agent
operationId: get_extraction_agent_api_v1_extraction_extraction_agents__extraction_agent_id__get
security:
- HTTPBearer: []
parameters:
- name: extraction_agent_id
in: path
required: true
schema:
type: string
format: uuid
title: Extraction Agent Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- LlamaExtract
summary: Delete Extraction Agent
operationId: delete_extraction_agent_api_v1_extraction_extraction_agents__extraction_agent_id__delete
security:
- HTTPBearer: []
parameters:
- name: extraction_agent_id
in: path
required: true
schema:
type: string
format: uuid
title: Extraction Agent Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- LlamaExtract
summary: Update Extraction Agent
operationId: update_extraction_agent_api_v1_extraction_extraction_agents__extraction_agent_id__put
security:
- HTTPBearer: []
parameters:
- name: extraction_agent_id
in: path
required: true
schema:
type: string
format: uuid
title: Extraction Agent Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgentUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractAgent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ExtractModels:
type: string
enum:
- openai-gpt-4-1
- openai-gpt-4-1-mini
- openai-gpt-4-1-nano
- openai-gpt-5
- openai-gpt-5-mini
- gemini-2.0-flash
- gemini-2.5-flash
- gemini-2.5-flash-lite
- gemini-2.5-pro
- openai-gpt-4o
- openai-gpt-4o-mini
title: ExtractModels
description: Extract model options.
ExtractAgentUpdate:
properties:
data_schema:
anyOf:
- additionalProperties:
anyOf:
- additionalProperties: true
type: object
- items: {}
type: array
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
- type: string
title: Data Schema
description: The schema of the data
config:
$ref: '#/components/schemas/ExtractConfig'
description: The configuration parameters for the extraction agent.
type: object
required:
- data_schema
- config
title: ExtractAgentUpdate
description: Settings for updating an extraction schema.
File:
properties:
id:
type: string
format: uuid
title: Id
description: Unique identifier
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Creation datetime
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Update datetime
name:
type: string
maxLength: 3000
minLength: 1
title: Name
external_file_id:
anyOf:
- type: string
- type: 'null'
title: External File Id
description: The ID of the file in the external system
file_size:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: File Size
description: Size of the file in bytes
file_type:
anyOf:
- type: string
maxLength: 3000
minLength: 1
- type: 'null'
title: File Type
description: File type (e.g. pdf, docx, etc.)
project_id:
type: string
format: uuid
title: Project Id
description: The ID of the project that the file belongs to
last_modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Modified At
description: The last modified time of the file
resource_info:
anyOf:
- additionalProperties:
anyOf:
- additionalProperties: true
type: object
- items: {}
type: array
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
- type: 'null'
title: Resource Info
description: Resource information for the file
permission_info:
anyOf:
- additionalProperties:
anyOf:
- additionalProperties: true
type: object
- items: {}
type: array
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
- type: 'null'
title: Permission Info
description: Permission information for the file
data_source_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Data Source Id
description: The ID of the data source that the file belongs to
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: The expiration date for the file. Files past this date can be deleted.
purpose:
anyOf:
- type: string
- type: 'null'
title: Purpose
description: The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify')
type: object
required:
- id
- name
- project_id
title: File
description: Schema for a file.
PaginatedExtractRunsResponse:
properties:
items:
items:
$ref: '#/components/schemas/ExtractRun'
type: array
title: Items
description: The list of extraction runs
total:
type: integer
title: Total
description: The total number of extraction runs
skip:
type: integer
title: Skip
description: The number of extraction runs skipped
limit:
type: integer
title: Limit
description: The maximum number of extraction runs returned
type: object
required:
- items
- total
- skip
- limit
title: PaginatedExtractRunsResponse
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/llamaparse/refs/heads/main/openapi/llamaparse-llamaextract-api-openapi.yml