{ "opencollection": "1.0.0", "info": { "name": "Llama Platform Agent Data Beta API", "version": "0.1.0" }, "items": [ { "info": { "name": "Beta", "type": "folder" }, "items": [ { "info": { "name": "List Classify Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/classifier/jobs", "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" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List classify jobs. Experimental: not production-ready and subject to change." }, { "info": { "name": "Create Classify Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/classifier/jobs", "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. Experimental: not production-ready and subject to change." }, { "info": { "name": "Get Classify Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/classifier/jobs/:classify_job_id", "params": [ { "name": "classify_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. Experimental: not production-ready and subject to change." }, { "info": { "name": "Get Classification Job Results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/classifier/jobs/:classify_job_id/results", "params": [ { "name": "classify_job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the results of a classify job. Experimental: not production-ready and subject to change." }, { "info": { "name": "List Usage Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/usage-metrics", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "page_token", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "include_total", "value": "", "type": "query", "description": "Include total count in response" }, { "name": "project_id", "value": "", "type": "query", "description": "Filter by project ID" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user ID" }, { "name": "event_types", "value": "", "type": "query", "description": "Filter by event types" }, { "name": "days", "value": "", "type": "query", "description": "Filter by specific days (YYYY-MM-DD)" }, { "name": "day_on_or_before", "value": "", "type": "query", "description": "Filter by days on or before this date (YYYY-MM-DD)" }, { "name": "day_on_or_after", "value": "", "type": "query", "description": "Filter by days on or after this date (YYYY-MM-DD)" }, { "name": "event_aggregation_type", "value": "", "type": "query", "description": "Filter by event aggregation type" }, { "name": "event_aggregation_key", "value": "", "type": "query", "description": "Filter by event aggregation key" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List usage metrics with filtering and pagination." }, { "info": { "name": "Get Agent Data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/agent-data/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get agent data by ID." }, { "info": { "name": "Update Agent Data", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/beta/agent-data/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update agent data by ID (overwrites)." }, { "info": { "name": "Delete Agent Data", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/beta/agent-data/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete agent data by ID." }, { "info": { "name": "Create Agent Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/agent-data", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create new agent data." }, { "info": { "name": "Search Agent Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/agent-data/:search", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search agent data with filtering, sorting, and pagination." }, { "info": { "name": "Aggregate Agent Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/agent-data/:aggregate", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Aggregate agent data with grouping and optional counting/first item retrieval." }, { "info": { "name": "Delete Agent Data By Query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/agent-data/:delete", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bulk delete agent data by query (deployment_name, collection, optional filters)." }, { "info": { "name": "List Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/files", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "The maximum number of items to return. Defaults to 50, maximum is 1000." }, { "name": "page_token", "value": "", "type": "query", "description": "A page token received from a previous list call. Provide this to retrieve the subsequent page." }, { "name": "file_ids", "value": "", "type": "query", "description": "Filter by specific file IDs." }, { "name": "file_name", "value": "", "type": "query", "description": "Filter by file name (exact match)." }, { "name": "external_file_id", "value": "", "type": "query", "description": "Filter by external file ID." }, { "name": "order_by", "value": "", "type": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use 'field_name desc' to specify descending order." }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand on each file." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List files with optional filtering and pagination.\n\nFilter by `file_name`, `file_ids`, or `external_file_id`.\nSupports cursor-based pagination and custom ordering." }, { "info": { "name": "Upload File", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/files", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload a file using multipart/form-data.\n\nSet `purpose` to indicate how the file will be used:\n`user_data`, `parse`, `extract`, `classify`, `split`,\n`sheet`, or `agent_app`.\n\nReturns the created file metadata including its ID for use\nin subsequent parse, extract, or classify operations." }, { "info": { "name": "Query Files", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/files/query", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Query files with filtering and pagination. Deprecated: use `GET /files`." }, { "info": { "name": "Get File", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/files/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get file metadata by ID." }, { "info": { "name": "Delete File", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/beta/files/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a file from the project." }, { "info": { "name": "Read File Content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/files/:file_id/content", "params": [ { "name": "file_id", "value": "", "type": "path" }, { "name": "expires_at_seconds", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a presigned URL to download the file content." }, { "info": { "name": "List Spreadsheet Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/sheets/jobs", "params": [ { "name": "include_results", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Filter by job status" }, { "name": "job_ids", "value": "", "type": "query", "description": "Filter by specific job IDs" }, { "name": "configuration_id", "value": "", "type": "query", "description": "Filter by saved configuration ID" }, { "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", "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 spreadsheet parsing jobs. Experimental: not production-ready and subject to change." }, { "info": { "name": "Create Spreadsheet Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/sheets/jobs", "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 spreadsheet parsing job.\n\nProvide at most one of `configuration` (an inline parsing configuration) or `configuration_id` (a saved configuration preset). If neither is provided, a default configuration is used. Optionally include `webhook_configurations` to receive `sheets.*` status notifications.\n\nExperimental: not production-ready and subject to change." }, { "info": { "name": "Get Spreadsheet Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/sheets/jobs/:spreadsheet_job_id", "params": [ { "name": "spreadsheet_job_id", "value": "", "type": "path" }, { "name": "include_results", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query", "description": "Optional fields to populate on the response. Valid values: metadata_state_transitions." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a spreadsheet parsing job. When `include_results=True` (default), embeds extracted regions and results if complete, skipping the separate `/results` call. Experimental: not production-ready and subject to change." }, { "info": { "name": "Delete Spreadsheet Job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/beta/sheets/jobs/:spreadsheet_job_id", "params": [ { "name": "spreadsheet_job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a spreadsheet parsing job and its associated data. Experimental: not production-ready and subject to change." }, { "info": { "name": "Get Result Region", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/sheets/jobs/:spreadsheet_job_id/regions/:region_id/result/:region_type", "params": [ { "name": "spreadsheet_job_id", "value": "", "type": "path" }, { "name": "region_id", "value": "", "type": "path" }, { "name": "region_type", "value": "", "type": "path" }, { "name": "expires_at_seconds", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a presigned URL to download a specific extracted region. Experimental: not production-ready and subject to change." }, { "info": { "name": "List Directories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/directories", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "include_deleted", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Directories" }, { "info": { "name": "Create Directory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/directories", "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 new directory within the specified project." }, { "info": { "name": "Get Directory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a directory by its identifier." }, { "info": { "name": "Update Directory", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update directory metadata." }, { "info": { "name": "Delete Directory", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Permanently delete a directory." }, { "info": { "name": "List Directory Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand on each directory file." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "display_name", "value": "", "type": "query" }, { "name": "display_name_contains", "value": "", "type": "query" }, { "name": "unique_id", "value": "", "type": "query" }, { "name": "file_id", "value": "", "type": "query" }, { "name": "include_deleted", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" }, { "name": "updated_at_on_or_after", "value": "", "type": "query", "description": "Include items updated at or after this timestamp (inclusive)" }, { "name": "updated_at_on_or_before", "value": "", "type": "query", "description": "Include items updated at or before this timestamp (inclusive)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all files within the specified directory with optional filtering and pagination." }, { "info": { "name": "Add Directory File", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new file within the specified directory; the directory must exist in the project and `file_id` must reference an existing file." }, { "info": { "name": "Upload File To Directory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files/upload", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload a file and create its directory entry in one call; `unique_id` / `display_name` default to values derived from file metadata." }, { "info": { "name": "Get Directory File", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files/:directory_file_id", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "directory_file_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a directory file by `directory_file_id`; to look up by `unique_id`, use the list endpoint with a filter." }, { "info": { "name": "Update Directory File", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files/:directory_file_id", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "directory_file_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update directory-file metadata by `directory_file_id`; set `directory_id` to move the file to a different directory. To resolve from `unique_id`, list with a filter first." }, { "info": { "name": "Delete Directory File", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files/:directory_file_id", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "directory_file_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a directory file by `directory_file_id`; to resolve from `unique_id`, list with a filter first." }, { "info": { "name": "Bulk Delete Directory Files", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/directories/:directory_id/files/bulk-delete", "params": [ { "name": "directory_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete up to 100 files from the specified directory; all must belong to it." }, { "info": { "name": "List Configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/configurations", "params": [ { "name": "product_type", "value": "", "type": "query", "description": "Filter by one or more product types. Repeat the parameter for multiple values." }, { "name": "name", "value": "", "type": "query", "description": "Filter by configuration name." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page." }, { "name": "page_token", "value": "", "type": "query", "description": "Pagination token." }, { "name": "latest_only", "value": "", "type": "query", "description": "Return only the latest version per configuration name." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List product configurations for the current project." }, { "info": { "name": "Create Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/configurations", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates." }, { "info": { "name": "Get Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/configurations/:config_id", "params": [ { "name": "config_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a single product configuration by ID." }, { "info": { "name": "Update Configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/beta/configurations/:config_id", "params": [ { "name": "config_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing product configuration." }, { "info": { "name": "Delete Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/beta/configurations/:config_id", "params": [ { "name": "config_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a product configuration." }, { "info": { "name": "List Split Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/split/jobs", "params": [ { "name": "status", "value": "", "type": "query", "description": "Filter by job status (pending, processing, 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": "page_size", "value": "", "type": "query" }, { "name": "page_token", "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 document split jobs." }, { "info": { "name": "Create Split Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/split/jobs", "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 document split job." }, { "info": { "name": "Get Split Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/split/jobs/:split_job_id", "params": [ { "name": "split_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 document split job." }, { "info": { "name": "List Batch Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/batch-processing", "params": [ { "name": "directory_id", "value": "", "type": "query", "description": "Filter by directory ID" }, { "name": "job_type", "value": "", "type": "query", "description": "Filter by job type (PARSE, EXTRACT, CLASSIFY)" }, { "name": "status", "value": "", "type": "query", "description": "Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of jobs to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of jobs to skip for pagination" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List batch processing jobs with optional filtering.\n\nFilter by `directory_id`, `job_type`, or `status`. Results\nare paginated with configurable `limit` and `offset`." }, { "info": { "name": "Create Batch Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/batch-processing", "headers": [ { "name": "temporal-namespace", "value": "" } ], "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 processing job.\n\nProcesses files from a directory or a specific list of item IDs.\nSupports batch parsing and classification operations.\n\nProvide either `directory_id` to process all files in a directory,\nor `item_ids` for specific items. The job runs asynchronously —\npoll `GET /batch/{job_id}` for progress." }, { "info": { "name": "Get Batch Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/batch-processing/: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 detailed status of a batch processing job.\n\nReturns current progress percentage, file counts (total,\nprocessed, failed, skipped), and timestamps." }, { "info": { "name": "List Batch Job Items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/batch-processing/:job_id/items", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query", "description": "Filter items by status" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List items in a batch job with optional status filtering.\n\nUseful for finding failed items, viewing completed items,\nor debugging processing issues." }, { "info": { "name": "Cancel Batch Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/beta/batch-processing/:job_id/cancel", "headers": [ { "name": "temporal-namespace", "value": "" } ], "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a running batch processing job.\n\nStops processing and marks pending items as cancelled.\nItems currently being processed may still complete." }, { "info": { "name": "Get Item Processing Results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/batch-processing/items/:item_id/processing-results", "params": [ { "name": "item_id", "value": "", "type": "path" }, { "name": "job_type", "value": "", "type": "query", "description": "Filter results by job type" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all processing results for a specific item.\n\nReturns the complete processing history for an item including\nwhat operations were performed, parameters used, and where\noutputs are stored. Optionally filter by `job_type`." }, { "info": { "name": "List Pipeline Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/beta/pipelines/:pipeline_id/files", "params": [ { "name": "pipeline_id", "value": "", "type": "path" }, { "name": "data_source_id", "value": "", "type": "query", "description": "Filter by data source ID." }, { "name": "file_name_contains", "value": "", "type": "query", "description": "Filter by files whose names contain this substring (case-insensitive)." }, { "name": "statuses", "value": "", "type": "query", "description": "Filter by pipeline file statuses." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to return. Defaults to 50, max 1000." }, { "name": "page_token", "value": "", "type": "query", "description": "Page token for pagination, from a previous response." }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List files for a pipeline with pagination and filtering." } ] } ], "bundled": true }