{ "opencollection": "1.0.0", "info": { "name": "Llama Platform Agent Data V2 API", "version": "0.1.0" }, "items": [ { "info": { "name": "V2", "type": "folder" }, "items": [ { "info": { "name": "Upload File Multipart", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/parse/upload", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload and parse a file using multipart/form-data.\n\nSend the file as a `file` field and parsing configuration as a\n`configuration` JSON string field.\n\nThe job runs asynchronously. Poll `GET /parse/{job_id}` with\n`expand` to retrieve results." }, { "info": { "name": "List Parse Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/parse", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "page_token", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "status", "value": "", "type": "query", "description": "Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)" }, { "name": "job_ids", "value": "", "type": "query", "description": "Filter by specific job IDs" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "created_at_on_or_after", "value": "", "type": "query", "description": "Include items created at or after this timestamp (inclusive)" }, { "name": "created_at_on_or_before", "value": "", "type": "query", "description": "Include items created at or before this timestamp (inclusive)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List parse jobs for the current project.\n\nFilter by `status` or creation date range. Results are\npaginated — use `page_token` from the response to fetch\nsubsequent pages." }, { "info": { "name": "Parse File", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/parse", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Parse a file by file ID or URL.\n\nProvide either `file_id` (a previously uploaded file) or\n`source_url` (a publicly accessible URL). Configure parsing\nwith options like `tier`, `target_pages`, and `lang`.\n\n## Tiers\n\n- `fast` — rule-based, cheapest, no AI\n- `cost_effective` — balanced speed and quality\n- `agentic` — full AI-powered parsing\n- `agentic_plus` — premium AI with specialized features\n\nThe job runs asynchronously. Poll `GET /parse/{job_id}` with\n`expand=text` or `expand=markdown` to retr" }, { "info": { "name": "List Parse Versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/parse/versions" }, "docs": "List the parse versions accepted by each tier." }, { "info": { "name": "Get Parse Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/parse/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to include: text, markdown, items, metadata, job_metadata, text_content_metadata, markdown_content_metadata, items_content_metadata, metadata_content_metadata, raw_words_content_metadata, xlsx_content_metadata, output_pdf_content_metadata, images_content_metadata. Metadata fields include presigned URLs." }, { "name": "image_filenames", "value": "", "type": "query", "description": "Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a parse job with optional expanded content.\n\nBy default returns job metadata only. Use `expand` to include\nparsed content:\n\n- `text` — plain text output\n- `markdown` — markdown output\n- `items` — structured page-by-page output\n- `job_metadata` — usage and processing details\n\nContent metadata fields (e.g. `text_content_metadata`) return\npresigned URLs for downloading large results." }, { "info": { "name": "Cancel Parse Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/parse/:job_id/cancel", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a running parse job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled." }, { "info": { "name": "List Classify Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/classify", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "page_token", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "status", "value": "", "type": "query", "description": "Filter by job status" }, { "name": "job_ids", "value": "", "type": "query", "description": "Filter by specific job IDs" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "configuration_id", "value": "", "type": "query", "description": "Filter by configuration ID" }, { "name": "created_at_on_or_after", "value": "", "type": "query", "description": "Include items created at or after this timestamp (inclusive)" }, { "name": "created_at_on_or_before", "value": "", "type": "query", "description": "Include items created at or before this timestamp (inclusive)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List classify jobs with optional filtering and pagination.\n\nFilter by `status`, `configuration_id`, specific `job_ids`,\nor creation date range." }, { "info": { "name": "Create Classify Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/classify", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a classify job.\n\nClassifies a document against a set of rules. Set `file_input`\nto a file ID (`dfl-...`) or parse job ID (`pjb-...`), and provide\neither inline `configuration` with rules or a `configuration_id`\nreferencing a saved preset.\n\nEach rule has a `type` (the label to assign) and a `description`\n(natural language criteria). The classifier returns the best\nmatching rule with a confidence score.\n\nThe job runs asynchronously. Poll `GET /classify/{job_id}` to\ncheck status and retrieve" }, { "info": { "name": "Get Classify Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/classify/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a classify job by ID.\n\nReturns the job status, configuration, and classify result\nwhen complete. The result includes the matched document type,\nconfidence score, and reasoning." }, { "info": { "name": "Cancel Classify Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/classify/:job_id/cancel", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a running classify job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled." }, { "info": { "name": "Validate Extraction Schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/extract/schema/validation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate a JSON schema for extraction." }, { "info": { "name": "Generate Extraction Schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/extract/schema/generate", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a JSON schema and return a product configuration request." }, { "info": { "name": "List Extract Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/extract", "params": [ { "name": "document_input_type", "value": "", "type": "query", "description": "Filter by document input type (file_id or parse_job_id)" }, { "name": "file_input", "value": "", "type": "query", "description": "Filter by file input value" }, { "name": "document_input_value", "value": "", "type": "query", "description": "Deprecated: use file_input instead" }, { "name": "status", "value": "", "type": "query", "description": "Filter by status" }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "page_token", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "job_ids", "value": "", "type": "query", "description": "Filter by specific job IDs" }, { "name": "expand", "value": "", "type": "query", "description": "Additional fields to include: configuration, extract_metadata" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "configuration_id", "value": "", "type": "query", "description": "Filter by configuration ID" }, { "name": "created_at_on_or_after", "value": "", "type": "query", "description": "Include items created at or after this timestamp (inclusive)" }, { "name": "created_at_on_or_before", "value": "", "type": "query", "description": "Include items created at or before this timestamp (inclusive)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List extraction jobs with optional filtering and pagination.\n\nFilter by `configuration_id`, `status`, `file_input`,\nor creation date range. Results are returned newest-first.\nUse `expand=configuration` to include the full configuration used,\nand `expand=extract_metadata` for per-field metadata." }, { "info": { "name": "Create Extract Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/extract", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an extraction job.\n\nExtracts structured data from a document using either a saved\nconfiguration or an inline JSON Schema.\n\n## Input\n\nProvide exactly one of:\n- `configuration_id` — reference a saved extraction config\n- `configuration` — inline configuration with a `data_schema`\n\n## Document input\n\nSet `file_input` to a file ID (`dfl-...`) or a\ncompleted parse job ID (`pjb-...`).\n\nThe job runs asynchronously. Poll `GET /extract/{job_id}` or\nregister a webhook to monitor completion." }, { "info": { "name": "Get Extract Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/extract/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Additional fields to include: configuration, extract_metadata" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a single extraction job by ID.\n\nReturns the job status and results when complete.\nUse `expand=configuration` to include the full configuration used,\nand `expand=extract_metadata` for per-field metadata." }, { "info": { "name": "Delete Extract Job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/extract/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an extraction job and its results." }, { "info": { "name": "Cancel Extract Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/extract/:job_id/cancel", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a running extraction job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled." }, { "info": { "name": "List Projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/projects", "params": [ { "name": "organization_id", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List projects in an organization. Requires `organization_id` or a project-scoped API key." }, { "info": { "name": "Get Project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a project by ID." }, { "info": { "name": "List Organizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List organizations the current user can access." }, { "info": { "name": "Get Organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an organization by ID." }, { "info": { "name": "List Batches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/batches", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" }, { "name": "created_at_on_or_after", "value": "", "type": "query" }, { "name": "created_at_on_or_before", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "source_directory_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List batches for the current project." }, { "info": { "name": "Create Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/batches", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a batch over a source directory and start processing asynchronously." }, { "info": { "name": "Get Batch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/batches/:batch_id", "params": [ { "name": "batch_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand. Supported value: results." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a batch by ID." } ] } ], "bundled": true }