{ "openapi": "3.1.0", "info": { "title": "nData Processing API", "version": "1.0.0", "description": "New jobs process live asynchronously through the private processor. Historical jobs retain their recorded processing mode. Customer schemas use nData's documented Draft 2020-12 subset with local JSON Pointers only; Markdown templates are best effort. This is a release reference with documented default limits, not a live deployment configuration or availability claim. Read https://api.ndata.io/v1/openapi.json for effective runtime limits." }, "servers": [ { "url": "https://api.ndata.io/v1" } ], "security": [ { "ApiKeyAuth": [] } ], "x-ndata-schema-policy": { "version": "custom-schema.v1", "dialect": "https://json-schema.org/draft/2020-12/schema", "limits": { "max_bytes": 16384, "max_nodes": 5000, "max_depth": 8, "max_properties": 200, "property_name_max_chars": 128, "description_max_chars": 256, "descriptions_max_chars": 4096, "enum_max_values": 100, "structural_max_depth": 64, "max_items": 100, "max_string_length": 8000, "grammar_max_work": 100000 }, "keywords": [ "$defs", "$ref", "$schema", "additionalProperties", "const", "description", "enum", "exclusiveMaximum", "exclusiveMinimum", "items", "maxItems", "maxLength", "maximum", "minItems", "minLength", "minimum", "properties", "required", "type" ], "root_types": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "x-ndata-prompt-policy": { "version": "prompt.v1", "limits": { "max_chars": 4000, "max_bytes": 16384 }, "normalization": "trim_outer_whitespace", "trim_characters": "\t\n\u000b\f\r \u001c\u001d\u001e\u001f…             

  　" }, "x-ndata-processing-budget": { "window": "UTC day", "reset": "next UTC midnight", "exhausted_accepted_job_error_code": "processing_budget_exceeded", "workspace_limits": { "free": { "jobs": 100, "attempts": 200, "work_units": 1000 }, "build": { "jobs": 1000, "attempts": 2000, "work_units": 10000 }, "scale": { "jobs": 10000, "attempts": 20000, "work_units": 100000 } }, "operation_work_units": { "extraction": 5, "transcription": 2 }, "work_units_note": "Provisional internal processing weights, not dollars or provider cost claims." }, "x-ndata-request-max-bytes": 1000000, "x-ndata-batch-policy": { "max_urls": 1000, "max_request_bytes": 4194304, "page_default": 50, "page_max": 100, "webhook": { "max_attempts": 32, "retry_horizon_seconds": 86400, "max_body_bytes": 1048576, "delivery": "at_least_once", "ordered": false } }, "x-cage-schema-policy": { "version": "custom-schema.v1", "dialect": "https://json-schema.org/draft/2020-12/schema", "limits": { "max_bytes": 16384, "max_nodes": 5000, "max_depth": 8, "max_properties": 200, "property_name_max_chars": 128, "description_max_chars": 256, "descriptions_max_chars": 4096, "enum_max_values": 100, "structural_max_depth": 64, "max_items": 100, "max_string_length": 8000, "grammar_max_work": 100000 }, "keywords": [ "$defs", "$ref", "$schema", "additionalProperties", "const", "description", "enum", "exclusiveMaximum", "exclusiveMinimum", "items", "maxItems", "maxLength", "maximum", "minItems", "minLength", "minimum", "properties", "required", "type" ], "root_types": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "x-cage-prompt-policy": { "version": "prompt.v1", "limits": { "max_chars": 4000, "max_bytes": 16384 }, "normalization": "trim_outer_whitespace", "trim_characters": "\t\n\u000b\f\r \u001c\u001d\u001e\u001f…             

  　" }, "x-cage-processing-budget": { "window": "UTC day", "reset": "next UTC midnight", "exhausted_accepted_job_error_code": "processing_budget_exceeded", "workspace_limits": { "free": { "jobs": 100, "attempts": 200, "work_units": 1000 }, "build": { "jobs": 1000, "attempts": 2000, "work_units": 10000 }, "scale": { "jobs": 10000, "attempts": 20000, "work_units": 100000 } }, "operation_work_units": { "extraction": 5, "transcription": 2 }, "work_units_note": "Provisional internal processing weights, not dollars or provider cost claims." }, "x-cage-request-max-bytes": 1000000, "x-cage-batch-policy": { "max_urls": 1000, "max_request_bytes": 4194304, "page_default": 50, "page_max": 100, "webhook": { "max_attempts": 32, "retry_horizon_seconds": 86400, "max_body_bytes": 1048576, "delivery": "at_least_once", "ordered": false } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "ExtractionRequest": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "prompt": { "type": "string", "description": "Additional question or focus. Outer Unicode whitespace is trimmed. It does not suppress other default extraction fields; custom output controls the entire requested shape.", "minLength": 1, "maxLength": 4000 }, "output": { "oneOf": [ { "type": "object", "properties": { "format": { "const": "json" }, "schema": { "type": "object", "description": "Draft 2020-12 schema restricted by the x-ndata-schema-policy document extension." } }, "required": [ "format" ], "additionalProperties": false }, { "type": "object", "properties": { "format": { "const": "markdown" }, "template": { "type": "string", "minLength": 1, "maxLength": 8000 } }, "required": [ "format", "template" ], "additionalProperties": false } ] }, "webhook_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2048, "description": "Public HTTPS callback URL on port 443. Supply with webhook_secret. No redirects or private destinations." }, "webhook_secret": { "type": "string", "minLength": 16, "maxLength": 512, "writeOnly": true, "description": "Customer-generated signing secret, supplied together with webhook_url. Never returned in job responses." } }, "required": [ "url" ], "additionalProperties": false, "dependentRequired": { "webhook_url": [ "webhook_secret" ], "webhook_secret": [ "webhook_url" ] } }, "TranscriptionRequest": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "mode": { "type": "string", "enum": [ "native", "generated" ], "default": "native" }, "timestamps": { "type": "string", "enum": [ "flat", "sentence", "word" ], "default": "flat" }, "webhook_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2048, "description": "Public HTTPS callback URL on port 443. Supply with webhook_secret. No redirects or private destinations." }, "webhook_secret": { "type": "string", "minLength": 16, "maxLength": 512, "writeOnly": true, "description": "Customer-generated signing secret, supplied together with webhook_url. Never returned in job responses." } }, "required": [ "url" ], "additionalProperties": false, "dependentRequired": { "webhook_url": [ "webhook_secret" ], "webhook_secret": [ "webhook_url" ] } }, "ExtractionResult": { "type": "object", "properties": { "simulated": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "format": { "enum": [ "json", "markdown" ] }, "schema_version": { "type": [ "string", "null" ] }, "output": {} }, "required": [ "simulated", "format", "schema_version", "output" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "format": { "const": "markdown" } } }, "then": { "properties": { "output": { "type": "string" }, "schema_version": { "type": "null" } } } } ] }, "TranscriptionResult": { "type": "object", "properties": { "simulated": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "schema_version": { "const": "transcription.v1" }, "source": { "enum": [ "native", "generated" ] }, "timestamps": { "enum": [ "flat", "sentence", "word" ] }, "timing_basis": { "enum": [ null, "word", "source_segment" ] }, "language": { "type": [ "string", "null" ] }, "text": { "type": "string" }, "segments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 }, "text": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "text" ], "additionalProperties": false }, "maxItems": 100000 }, "words": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 }, "text": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "text" ], "additionalProperties": false }, "maxItems": 100000 } }, "required": [ "simulated", "schema_version", "source", "timestamps", "timing_basis", "language", "text", "segments", "words" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "timestamps": { "const": "flat" } } }, "then": { "properties": { "segments": { "type": "null" }, "words": { "type": "null" }, "timing_basis": { "type": "null" } } } }, { "if": { "properties": { "timestamps": { "const": "sentence" } } }, "then": { "properties": { "segments": { "type": "array", "minItems": 1 }, "words": { "type": "null" }, "timing_basis": { "enum": [ "word", "source_segment" ] } } } }, { "if": { "properties": { "timestamps": { "const": "word" } } }, "then": { "properties": { "words": { "type": "array", "minItems": 1 }, "segments": { "type": "null" }, "timing_basis": { "enum": [ "word" ] } } } } ] }, "Job": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "extraction", "transcription" ] }, "status": { "enum": [ "queued", "running", "completed", "failed" ] }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "options": { "type": "object" }, "processing_mode": { "enum": [ "simulated", "live" ] }, "credits_reserved": { "type": "integer", "minimum": 0 }, "credits_charged": { "type": "integer", "minimum": 0 }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "duration_ms": { "type": [ "integer", "null" ], "minimum": 0 }, "media_duration_seconds": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "simulated": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "format": { "enum": [ "json", "markdown" ] }, "schema_version": { "type": [ "string", "null" ] }, "output": {} }, "required": [ "simulated", "format", "schema_version", "output" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "format": { "const": "markdown" } } }, "then": { "properties": { "output": { "type": "string" }, "schema_version": { "type": "null" } } } } ] }, { "type": "object", "properties": { "simulated": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "schema_version": { "const": "transcription.v1" }, "source": { "enum": [ "native", "generated" ] }, "timestamps": { "enum": [ "flat", "sentence", "word" ] }, "timing_basis": { "enum": [ null, "word", "source_segment" ] }, "language": { "type": [ "string", "null" ] }, "text": { "type": "string" }, "segments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 }, "text": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "text" ], "additionalProperties": false }, "maxItems": 100000 }, "words": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 }, "text": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "text" ], "additionalProperties": false }, "maxItems": 100000 } }, "required": [ "simulated", "schema_version", "source", "timestamps", "timing_basis", "language", "text", "segments", "words" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "timestamps": { "const": "flat" } } }, "then": { "properties": { "segments": { "type": "null" }, "words": { "type": "null" }, "timing_basis": { "type": "null" } } } }, { "if": { "properties": { "timestamps": { "const": "sentence" } } }, "then": { "properties": { "segments": { "type": "array", "minItems": 1 }, "words": { "type": "null" }, "timing_basis": { "enum": [ "word", "source_segment" ] } } } }, { "if": { "properties": { "timestamps": { "const": "word" } } }, "then": { "properties": { "words": { "type": "array", "minItems": 1 }, "segments": { "type": "null" }, "timing_basis": { "enum": [ "word" ] } } } } ] } ] }, "error": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ], "additionalProperties": false } ] } }, "required": [ "id", "type", "status", "url", "options", "processing_mode", "credits_reserved", "credits_charged", "created_at", "started_at", "completed_at", "duration_ms", "media_duration_seconds", "result", "error" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "type": { "const": "extraction" } } }, "then": { "properties": { "options": { "type": "object", "properties": { "prompt": { "type": [ "string", "null" ] }, "output": { "oneOf": [ { "type": "object", "properties": { "format": { "const": "json" }, "schema": { "type": "object", "description": "Draft 2020-12 schema restricted by the x-ndata-schema-policy document extension." } }, "required": [ "format" ], "additionalProperties": false }, { "type": "object", "properties": { "format": { "const": "markdown" }, "template": { "type": "string", "minLength": 1, "maxLength": 8000 } }, "required": [ "format", "template" ], "additionalProperties": false } ] } }, "required": [ "prompt", "output" ], "additionalProperties": false }, "result": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "simulated": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "format": { "enum": [ "json", "markdown" ] }, "schema_version": { "type": [ "string", "null" ] }, "output": {} }, "required": [ "simulated", "format", "schema_version", "output" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "format": { "const": "markdown" } } }, "then": { "properties": { "output": { "type": "string" }, "schema_version": { "type": "null" } } } } ] } ] } } } }, { "if": { "properties": { "type": { "const": "transcription" } } }, "then": { "properties": { "options": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "native", "generated" ], "default": "native" }, "timestamps": { "type": "string", "enum": [ "flat", "sentence", "word" ], "default": "flat" } }, "required": [ "mode", "timestamps" ], "additionalProperties": false }, "result": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "simulated": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "schema_version": { "const": "transcription.v1" }, "source": { "enum": [ "native", "generated" ] }, "timestamps": { "enum": [ "flat", "sentence", "word" ] }, "timing_basis": { "enum": [ null, "word", "source_segment" ] }, "language": { "type": [ "string", "null" ] }, "text": { "type": "string" }, "segments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 }, "text": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "text" ], "additionalProperties": false }, "maxItems": 100000 }, "words": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 }, "text": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "text" ], "additionalProperties": false }, "maxItems": 100000 } }, "required": [ "simulated", "schema_version", "source", "timestamps", "timing_basis", "language", "text", "segments", "words" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "timestamps": { "const": "flat" } } }, "then": { "properties": { "segments": { "type": "null" }, "words": { "type": "null" }, "timing_basis": { "type": "null" } } } }, { "if": { "properties": { "timestamps": { "const": "sentence" } } }, "then": { "properties": { "segments": { "type": "array", "minItems": 1 }, "words": { "type": "null" }, "timing_basis": { "enum": [ "word", "source_segment" ] } } } }, { "if": { "properties": { "timestamps": { "const": "word" } } }, "then": { "properties": { "words": { "type": "array", "minItems": 1 }, "segments": { "type": "null" }, "timing_basis": { "enum": [ "word" ] } } } } ] } ] } } } } ] }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "Quota": { "type": "object", "properties": { "credits": { "type": "object", "properties": { "balance": { "type": "integer", "minimum": 0 }, "reserved": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 }, "costs": { "type": "object", "properties": { "extraction": { "type": "integer", "minimum": 1 }, "transcription": { "type": "integer", "minimum": 1 } }, "required": [ "extraction", "transcription" ], "additionalProperties": false } }, "required": [ "balance", "reserved", "available", "costs" ], "additionalProperties": false }, "requests": { "type": "object", "properties": { "observed_at": { "type": "string", "format": "date-time" }, "reset_at": { "type": "string", "format": "date-time" }, "lane": { "enum": [ "submit", "read" ] }, "pool": { "enum": [ "global", "workspace", "key" ] }, "global": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "workspace": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "key": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false } ] }, "lanes": { "type": "object", "properties": { "submit": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "key": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false } ] } }, "required": [ "workspace", "key" ], "additionalProperties": false }, "read": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "key": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false } ] } }, "required": [ "workspace", "key" ], "additionalProperties": false } }, "required": [ "submit", "read" ], "additionalProperties": false } }, "required": [ "observed_at", "reset_at", "lane", "pool", "global", "workspace", "key", "lanes" ], "additionalProperties": false }, "in_flight": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "outstanding": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "batch": { "type": "object", "properties": { "max_urls": { "type": "integer", "minimum": 1 }, "max_request_bytes": { "type": "integer", "minimum": 1 }, "waiting": { "type": "integer", "minimum": 0 } }, "required": [ "max_urls", "max_request_bytes", "waiting" ], "additionalProperties": false }, "processing_budget": { "type": "object", "properties": { "window_start": { "type": "string", "format": "date-time" }, "reset_at": { "type": "string", "format": "date-time" }, "jobs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "attempts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "work_units": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false } }, "required": [ "window_start", "reset_at", "jobs", "attempts", "work_units" ], "additionalProperties": false } }, "required": [ "credits", "requests", "in_flight", "outstanding", "batch", "processing_budget" ], "additionalProperties": false }, "UsageResult": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "credits_used": { "type": "integer", "minimum": 0 }, "jobs_completed": { "type": "integer", "minimum": 0 }, "credits_reserved": { "type": "integer", "minimum": 0 }, "credits_available": { "type": "integer", "minimum": 0 } }, "required": [ "credits_used", "jobs_completed", "credits_reserved", "credits_available" ], "additionalProperties": false }, "quota": { "type": "object", "properties": { "credits": { "type": "object", "properties": { "balance": { "type": "integer", "minimum": 0 }, "reserved": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 }, "costs": { "type": "object", "properties": { "extraction": { "type": "integer", "minimum": 1 }, "transcription": { "type": "integer", "minimum": 1 } }, "required": [ "extraction", "transcription" ], "additionalProperties": false } }, "required": [ "balance", "reserved", "available", "costs" ], "additionalProperties": false }, "requests": { "type": "object", "properties": { "observed_at": { "type": "string", "format": "date-time" }, "reset_at": { "type": "string", "format": "date-time" }, "lane": { "enum": [ "submit", "read" ] }, "pool": { "enum": [ "global", "workspace", "key" ] }, "global": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "workspace": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "key": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false } ] }, "lanes": { "type": "object", "properties": { "submit": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "key": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false } ] } }, "required": [ "workspace", "key" ], "additionalProperties": false }, "read": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false }, "key": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 }, "rate_per_second": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limit", "used", "remaining", "rate_per_second" ], "additionalProperties": false } ] } }, "required": [ "workspace", "key" ], "additionalProperties": false } }, "required": [ "submit", "read" ], "additionalProperties": false } }, "required": [ "observed_at", "reset_at", "lane", "pool", "global", "workspace", "key", "lanes" ], "additionalProperties": false }, "in_flight": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "outstanding": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "batch": { "type": "object", "properties": { "max_urls": { "type": "integer", "minimum": 1 }, "max_request_bytes": { "type": "integer", "minimum": 1 }, "waiting": { "type": "integer", "minimum": 0 } }, "required": [ "max_urls", "max_request_bytes", "waiting" ], "additionalProperties": false }, "processing_budget": { "type": "object", "properties": { "window_start": { "type": "string", "format": "date-time" }, "reset_at": { "type": "string", "format": "date-time" }, "jobs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "attempts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false }, "work_units": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "used": { "type": "integer", "minimum": 0 }, "remaining": { "type": "integer", "minimum": 0 } }, "required": [ "limit", "used", "remaining" ], "additionalProperties": false } }, "required": [ "window_start", "reset_at", "jobs", "attempts", "work_units" ], "additionalProperties": false } }, "required": [ "credits", "requests", "in_flight", "outstanding", "batch", "processing_budget" ], "additionalProperties": false } }, "required": [ "summary", "quota" ], "additionalProperties": false }, "DefaultExtractionAnalysis": { "type": "object", "properties": { "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "summary", "key_points", "answer" ], "additionalProperties": false }, "instagram.post.v1": { "type": "object", "properties": { "platform": { "const": "instagram" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "image", "video", "audio" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "type", "summary" ], "additionalProperties": false } }, "summary": { "type": [ "string", "null" ] }, "answer": { "type": [ "string", "null" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Important terms explicitly supported by the content." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Concise descriptive labels grounded in the content; these need not be original hashtags." }, "topics": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Main subjects and meaningful subtopics covered by the post and media." }, "entities": { "type": "array", "description": "Explicitly named or identified people, organizations, products, places and creative works. Never identify an unnamed person from appearance.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "enum": [ "person", "organization", "product", "place", "work", "other" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "type" ] } }, "dates": { "type": "array", "description": "Important dates or deadlines. Preserve original wording. Normalize to ISO 8601 only when the complete date is unambiguous; never invent a year or resolve an unanchored relative date.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "normalized": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "facts": { "type": "array", "description": "Notable factual statements or claims made in the source. Preserve attribution and uncertainty; these are extracted claims, not independently verified facts.", "items": { "type": "object", "additionalProperties": false, "properties": { "statement": { "type": "string", "minLength": 1 }, "attribution": { "type": [ "string", "null" ] } }, "required": [ "statement" ] } }, "instructions": { "type": "array", "description": "Actionable procedures, recipes, routines and tutorials. Preserve complete ordered steps instead of compressing them into a summary.", "items": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Ordered steps preserving exact quantities, conditions, warnings and dependencies." }, "materials": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Explicitly stated tools, ingredients, equipment or other prerequisites." } }, "required": [ "title", "steps" ] } }, "quantities": { "type": "array", "description": "Important amounts, prices, measurements, durations, percentages and counts with their stated units and context.", "items": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "minLength": 1 }, "unit": { "type": [ "string", "null" ] }, "context": { "type": "string", "minLength": 1 } }, "required": [ "value", "context" ] } }, "quotes": { "type": "array", "description": "Important exact quotations. Attribute only when supported; preserve wording and original language.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "speaker": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "links": { "type": "array", "description": "Exact URLs explicitly present in source text, captions, speech or frames. Do not guess or complete an uncertain URL.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] } }, "required": [ "url" ] } }, "key_moments": { "type": "array", "description": "Important media moments with genuine supplied timestamps and source asset positions. Omit if timing is unavailable; never manufacture timestamps.", "items": { "type": "object", "additionalProperties": false, "properties": { "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": "string", "minLength": 1 } }, "required": [ "asset_position", "start", "description" ] } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "answer" ], "additionalProperties": false }, "youtube.post.v1": { "type": "object", "properties": { "platform": { "const": "youtube" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "image", "video", "audio" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "type", "summary" ], "additionalProperties": false } }, "summary": { "type": [ "string", "null" ] }, "answer": { "type": [ "string", "null" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Important terms explicitly supported by the content." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Concise descriptive labels grounded in the content; these need not be original hashtags." }, "topics": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Main subjects and meaningful subtopics covered by the post and media." }, "entities": { "type": "array", "description": "Explicitly named or identified people, organizations, products, places and creative works. Never identify an unnamed person from appearance.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "enum": [ "person", "organization", "product", "place", "work", "other" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "type" ] } }, "dates": { "type": "array", "description": "Important dates or deadlines. Preserve original wording. Normalize to ISO 8601 only when the complete date is unambiguous; never invent a year or resolve an unanchored relative date.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "normalized": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "facts": { "type": "array", "description": "Notable factual statements or claims made in the source. Preserve attribution and uncertainty; these are extracted claims, not independently verified facts.", "items": { "type": "object", "additionalProperties": false, "properties": { "statement": { "type": "string", "minLength": 1 }, "attribution": { "type": [ "string", "null" ] } }, "required": [ "statement" ] } }, "instructions": { "type": "array", "description": "Actionable procedures, recipes, routines and tutorials. Preserve complete ordered steps instead of compressing them into a summary.", "items": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Ordered steps preserving exact quantities, conditions, warnings and dependencies." }, "materials": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Explicitly stated tools, ingredients, equipment or other prerequisites." } }, "required": [ "title", "steps" ] } }, "quantities": { "type": "array", "description": "Important amounts, prices, measurements, durations, percentages and counts with their stated units and context.", "items": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "minLength": 1 }, "unit": { "type": [ "string", "null" ] }, "context": { "type": "string", "minLength": 1 } }, "required": [ "value", "context" ] } }, "quotes": { "type": "array", "description": "Important exact quotations. Attribute only when supported; preserve wording and original language.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "speaker": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "links": { "type": "array", "description": "Exact URLs explicitly present in source text, captions, speech or frames. Do not guess or complete an uncertain URL.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] } }, "required": [ "url" ] } }, "key_moments": { "type": "array", "description": "Important media moments with genuine supplied timestamps and source asset positions. Omit if timing is unavailable; never manufacture timestamps.", "items": { "type": "object", "additionalProperties": false, "properties": { "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": "string", "minLength": 1 } }, "required": [ "asset_position", "start", "description" ] } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "answer" ], "additionalProperties": false }, "tiktok.post.v1": { "type": "object", "properties": { "platform": { "const": "tiktok" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "image", "video", "audio" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "type", "summary" ], "additionalProperties": false } }, "summary": { "type": [ "string", "null" ] }, "answer": { "type": [ "string", "null" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Important terms explicitly supported by the content." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Concise descriptive labels grounded in the content; these need not be original hashtags." }, "topics": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Main subjects and meaningful subtopics covered by the post and media." }, "entities": { "type": "array", "description": "Explicitly named or identified people, organizations, products, places and creative works. Never identify an unnamed person from appearance.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "enum": [ "person", "organization", "product", "place", "work", "other" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "type" ] } }, "dates": { "type": "array", "description": "Important dates or deadlines. Preserve original wording. Normalize to ISO 8601 only when the complete date is unambiguous; never invent a year or resolve an unanchored relative date.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "normalized": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "facts": { "type": "array", "description": "Notable factual statements or claims made in the source. Preserve attribution and uncertainty; these are extracted claims, not independently verified facts.", "items": { "type": "object", "additionalProperties": false, "properties": { "statement": { "type": "string", "minLength": 1 }, "attribution": { "type": [ "string", "null" ] } }, "required": [ "statement" ] } }, "instructions": { "type": "array", "description": "Actionable procedures, recipes, routines and tutorials. Preserve complete ordered steps instead of compressing them into a summary.", "items": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Ordered steps preserving exact quantities, conditions, warnings and dependencies." }, "materials": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Explicitly stated tools, ingredients, equipment or other prerequisites." } }, "required": [ "title", "steps" ] } }, "quantities": { "type": "array", "description": "Important amounts, prices, measurements, durations, percentages and counts with their stated units and context.", "items": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "minLength": 1 }, "unit": { "type": [ "string", "null" ] }, "context": { "type": "string", "minLength": 1 } }, "required": [ "value", "context" ] } }, "quotes": { "type": "array", "description": "Important exact quotations. Attribute only when supported; preserve wording and original language.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "speaker": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "links": { "type": "array", "description": "Exact URLs explicitly present in source text, captions, speech or frames. Do not guess or complete an uncertain URL.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] } }, "required": [ "url" ] } }, "key_moments": { "type": "array", "description": "Important media moments with genuine supplied timestamps and source asset positions. Omit if timing is unavailable; never manufacture timestamps.", "items": { "type": "object", "additionalProperties": false, "properties": { "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": "string", "minLength": 1 } }, "required": [ "asset_position", "start", "description" ] } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "answer" ], "additionalProperties": false }, "linkedin.post.v1": { "type": "object", "properties": { "platform": { "const": "linkedin" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "image", "video", "audio" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "type", "summary" ], "additionalProperties": false } }, "summary": { "type": [ "string", "null" ] }, "answer": { "type": [ "string", "null" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Important terms explicitly supported by the content." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Concise descriptive labels grounded in the content; these need not be original hashtags." }, "topics": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Main subjects and meaningful subtopics covered by the post and media." }, "entities": { "type": "array", "description": "Explicitly named or identified people, organizations, products, places and creative works. Never identify an unnamed person from appearance.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "enum": [ "person", "organization", "product", "place", "work", "other" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "type" ] } }, "dates": { "type": "array", "description": "Important dates or deadlines. Preserve original wording. Normalize to ISO 8601 only when the complete date is unambiguous; never invent a year or resolve an unanchored relative date.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "normalized": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "facts": { "type": "array", "description": "Notable factual statements or claims made in the source. Preserve attribution and uncertainty; these are extracted claims, not independently verified facts.", "items": { "type": "object", "additionalProperties": false, "properties": { "statement": { "type": "string", "minLength": 1 }, "attribution": { "type": [ "string", "null" ] } }, "required": [ "statement" ] } }, "instructions": { "type": "array", "description": "Actionable procedures, recipes, routines and tutorials. Preserve complete ordered steps instead of compressing them into a summary.", "items": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Ordered steps preserving exact quantities, conditions, warnings and dependencies." }, "materials": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Explicitly stated tools, ingredients, equipment or other prerequisites." } }, "required": [ "title", "steps" ] } }, "quantities": { "type": "array", "description": "Important amounts, prices, measurements, durations, percentages and counts with their stated units and context.", "items": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "minLength": 1 }, "unit": { "type": [ "string", "null" ] }, "context": { "type": "string", "minLength": 1 } }, "required": [ "value", "context" ] } }, "quotes": { "type": "array", "description": "Important exact quotations. Attribute only when supported; preserve wording and original language.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "speaker": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "links": { "type": "array", "description": "Exact URLs explicitly present in source text, captions, speech or frames. Do not guess or complete an uncertain URL.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] } }, "required": [ "url" ] } }, "key_moments": { "type": "array", "description": "Important media moments with genuine supplied timestamps and source asset positions. Omit if timing is unavailable; never manufacture timestamps.", "items": { "type": "object", "additionalProperties": false, "properties": { "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": "string", "minLength": 1 } }, "required": [ "asset_position", "start", "description" ] } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "answer" ], "additionalProperties": false }, "reddit.post.v1": { "type": "object", "properties": { "platform": { "const": "reddit" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "image", "video", "audio" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "type", "summary" ], "additionalProperties": false } }, "summary": { "type": [ "string", "null" ] }, "answer": { "type": [ "string", "null" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Important terms explicitly supported by the content." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Concise descriptive labels grounded in the content; these need not be original hashtags." }, "topics": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Main subjects and meaningful subtopics covered by the post and media." }, "entities": { "type": "array", "description": "Explicitly named or identified people, organizations, products, places and creative works. Never identify an unnamed person from appearance.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "enum": [ "person", "organization", "product", "place", "work", "other" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "type" ] } }, "dates": { "type": "array", "description": "Important dates or deadlines. Preserve original wording. Normalize to ISO 8601 only when the complete date is unambiguous; never invent a year or resolve an unanchored relative date.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "normalized": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "facts": { "type": "array", "description": "Notable factual statements or claims made in the source. Preserve attribution and uncertainty; these are extracted claims, not independently verified facts.", "items": { "type": "object", "additionalProperties": false, "properties": { "statement": { "type": "string", "minLength": 1 }, "attribution": { "type": [ "string", "null" ] } }, "required": [ "statement" ] } }, "instructions": { "type": "array", "description": "Actionable procedures, recipes, routines and tutorials. Preserve complete ordered steps instead of compressing them into a summary.", "items": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Ordered steps preserving exact quantities, conditions, warnings and dependencies." }, "materials": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Explicitly stated tools, ingredients, equipment or other prerequisites." } }, "required": [ "title", "steps" ] } }, "quantities": { "type": "array", "description": "Important amounts, prices, measurements, durations, percentages and counts with their stated units and context.", "items": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "minLength": 1 }, "unit": { "type": [ "string", "null" ] }, "context": { "type": "string", "minLength": 1 } }, "required": [ "value", "context" ] } }, "quotes": { "type": "array", "description": "Important exact quotations. Attribute only when supported; preserve wording and original language.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "speaker": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "links": { "type": "array", "description": "Exact URLs explicitly present in source text, captions, speech or frames. Do not guess or complete an uncertain URL.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] } }, "required": [ "url" ] } }, "key_moments": { "type": "array", "description": "Important media moments with genuine supplied timestamps and source asset positions. Omit if timing is unavailable; never manufacture timestamps.", "items": { "type": "object", "additionalProperties": false, "properties": { "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": "string", "minLength": 1 } }, "required": [ "asset_position", "start", "description" ] } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "answer" ], "additionalProperties": false }, "x.post.v1": { "type": "object", "properties": { "platform": { "const": "x" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "image", "video", "audio" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "type", "summary" ], "additionalProperties": false } }, "summary": { "type": [ "string", "null" ] }, "answer": { "type": [ "string", "null" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Important terms explicitly supported by the content." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Concise descriptive labels grounded in the content; these need not be original hashtags." }, "topics": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Main subjects and meaningful subtopics covered by the post and media." }, "entities": { "type": "array", "description": "Explicitly named or identified people, organizations, products, places and creative works. Never identify an unnamed person from appearance.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "enum": [ "person", "organization", "product", "place", "work", "other" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "type" ] } }, "dates": { "type": "array", "description": "Important dates or deadlines. Preserve original wording. Normalize to ISO 8601 only when the complete date is unambiguous; never invent a year or resolve an unanchored relative date.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "normalized": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "facts": { "type": "array", "description": "Notable factual statements or claims made in the source. Preserve attribution and uncertainty; these are extracted claims, not independently verified facts.", "items": { "type": "object", "additionalProperties": false, "properties": { "statement": { "type": "string", "minLength": 1 }, "attribution": { "type": [ "string", "null" ] } }, "required": [ "statement" ] } }, "instructions": { "type": "array", "description": "Actionable procedures, recipes, routines and tutorials. Preserve complete ordered steps instead of compressing them into a summary.", "items": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Ordered steps preserving exact quantities, conditions, warnings and dependencies." }, "materials": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Explicitly stated tools, ingredients, equipment or other prerequisites." } }, "required": [ "title", "steps" ] } }, "quantities": { "type": "array", "description": "Important amounts, prices, measurements, durations, percentages and counts with their stated units and context.", "items": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "minLength": 1 }, "unit": { "type": [ "string", "null" ] }, "context": { "type": "string", "minLength": 1 } }, "required": [ "value", "context" ] } }, "quotes": { "type": "array", "description": "Important exact quotations. Attribute only when supported; preserve wording and original language.", "items": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1 }, "speaker": { "type": [ "string", "null" ] } }, "required": [ "text" ] } }, "links": { "type": "array", "description": "Exact URLs explicitly present in source text, captions, speech or frames. Do not guess or complete an uncertain URL.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] } }, "required": [ "url" ] } }, "key_moments": { "type": "array", "description": "Important media moments with genuine supplied timestamps and source asset positions. Omit if timing is unavailable; never manufacture timestamps.", "items": { "type": "object", "additionalProperties": false, "properties": { "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": "string", "minLength": 1 } }, "required": [ "asset_position", "start", "description" ] } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "answer" ], "additionalProperties": false }, "instagram.post.v2": { "type": "object", "properties": { "platform": { "const": "instagram" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "youtube.post.v2": { "type": "object", "properties": { "platform": { "const": "youtube" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "tiktok.post.v2": { "type": "object", "properties": { "platform": { "const": "tiktok" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "linkedin.post.v2": { "type": "object", "properties": { "platform": { "const": "linkedin" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "reddit.post.v2": { "type": "object", "properties": { "platform": { "const": "reddit" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "x.post.v2": { "type": "object", "properties": { "platform": { "const": "x" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "threads.post.v2": { "type": "object", "properties": { "platform": { "const": "threads" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "handle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "handle", "url" ], "additionalProperties": false }, "text": { "type": [ "string", "null" ] }, "media": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "integer", "minimum": 1 }, "type": { "enum": [ "image", "video", "audio" ] } }, "required": [ "position", "type" ], "additionalProperties": false } }, "summary": { "type": "string", "minLength": 1 }, "key_points": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "answer": { "type": [ "string", "null" ], "minLength": 1 }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "entity", "claim", "date", "quantity", "instruction", "quote", "link", "on_screen_text", "key_moment", "other" ] }, "text": { "type": "string", "minLength": 1 }, "attribution": { "type": "string", "minLength": 1 }, "asset_position": { "type": "integer", "minimum": 1 }, "start": { "type": "number", "minimum": 0 }, "end": { "type": "number", "minimum": 0 } }, "required": [ "type", "text" ], "additionalProperties": false } }, "limitations": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "platform", "url", "author", "text", "media", "summary", "key_points", "answer" ], "additionalProperties": false }, "JobWebhook": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "event": { "type": "string", "enum": [ "job.completed", "job.failed" ] }, "created_at": { "type": "string", "format": "date-time" }, "job": { "$ref": "#/components/schemas/Job" } }, "required": [ "event_id", "event", "created_at", "job" ], "additionalProperties": false }, "BatchSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "extraction", "transcription" ] }, "status": { "enum": [ "queued", "running", "completed" ] }, "outcome": { "enum": [ null, "all_succeeded", "partial_failure", "all_failed" ] }, "counts": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "queued": { "type": "integer", "minimum": 0 }, "running": { "type": "integer", "minimum": 0 }, "completed": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 } }, "required": [ "total", "queued", "running", "completed", "failed" ], "additionalProperties": false }, "credits": { "type": "object", "properties": { "reserved_total": { "type": "integer", "minimum": 0 }, "held": { "type": "integer", "minimum": 0 }, "charged": { "type": "integer", "minimum": 0 }, "released": { "type": "integer", "minimum": 0 } }, "required": [ "reserved_total", "held", "charged", "released" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "items": { "type": "string" }, "deliveries": { "type": "string" } }, "required": [ "self", "items", "deliveries" ], "additionalProperties": false } }, "required": [ "id", "type", "status", "outcome", "counts", "credits", "created_at", "completed_at", "links" ], "additionalProperties": false }, "Batch": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "extraction", "transcription" ] }, "status": { "enum": [ "queued", "running", "completed" ] }, "outcome": { "enum": [ null, "all_succeeded", "partial_failure", "all_failed" ] }, "counts": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "queued": { "type": "integer", "minimum": 0 }, "running": { "type": "integer", "minimum": 0 }, "completed": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 } }, "required": [ "total", "queued", "running", "completed", "failed" ], "additionalProperties": false }, "credits": { "type": "object", "properties": { "reserved_total": { "type": "integer", "minimum": 0 }, "held": { "type": "integer", "minimum": 0 }, "charged": { "type": "integer", "minimum": 0 }, "released": { "type": "integer", "minimum": 0 } }, "required": [ "reserved_total", "held", "charged", "released" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "items": { "type": "string" }, "deliveries": { "type": "string" } }, "required": [ "self", "items", "deliveries" ], "additionalProperties": false }, "delivery": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "paused": { "type": "boolean" }, "events_created": { "type": "integer", "minimum": 0 }, "acknowledged": { "type": "integer", "minimum": 0 }, "exhausted": { "type": "integer", "minimum": 0 } }, "required": [ "enabled", "paused", "events_created", "acknowledged", "exhausted" ], "additionalProperties": false } }, "required": [ "id", "type", "status", "outcome", "counts", "credits", "created_at", "completed_at", "links", "delivery" ], "additionalProperties": false }, "BatchItem": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0 }, "job_id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "platform": { "enum": [ "instagram", "youtube", "tiktok", "linkedin", "reddit", "x", "threads" ] }, "status": { "enum": [ "queued", "running", "completed", "failed" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ], "additionalProperties": false } }, "required": [ "index", "job_id", "url", "platform", "status", "links" ], "additionalProperties": false }, "WebhookDelivery": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "event": { "enum": [ "job.completed", "job.failed", "batch.completed" ] }, "status": { "enum": [ "pending", "delivering", "delivered", "paused", "exhausted" ] }, "attempts": { "type": "integer", "minimum": 0 }, "generation": { "type": "integer", "minimum": 1 }, "next_attempt_at": { "type": [ "string", "null" ], "format": "date-time" }, "delivered_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_status": { "type": [ "integer", "null" ] }, "failure_code": { "type": [ "string", "null" ] } }, "required": [ "event_id", "event", "status", "attempts", "generation", "next_attempt_at", "delivered_at", "last_status", "failure_code" ], "additionalProperties": false }, "BatchItemPage": { "type": "object", "properties": { "items": { "type": "array", "maxItems": 100, "items": { "$ref": "#/components/schemas/BatchItem" } }, "total": { "type": "integer", "minimum": 0 }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "total", "next_cursor" ], "additionalProperties": false }, "BatchDeliveryPage": { "type": "object", "properties": { "items": { "type": "array", "maxItems": 100, "items": { "$ref": "#/components/schemas/WebhookDelivery" } }, "total": { "type": "integer", "minimum": 0 }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "total", "next_cursor" ], "additionalProperties": false }, "BatchJobWebhook": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "event": { "type": "string", "enum": [ "job.completed", "job.failed" ] }, "created_at": { "type": "string", "format": "date-time" }, "job": { "$ref": "#/components/schemas/Job" }, "batch_id": { "type": "string", "format": "uuid" }, "index": { "type": "integer", "minimum": 0 } }, "required": [ "event_id", "event", "created_at", "job", "batch_id", "index" ], "additionalProperties": false }, "BatchCompletedWebhook": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "event": { "const": "batch.completed" }, "created_at": { "type": "string", "format": "date-time" }, "batch": { "$ref": "#/components/schemas/BatchSummary" } }, "required": [ "event_id", "event", "created_at", "batch" ], "additionalProperties": false }, "BatchWebhook": { "oneOf": [ { "$ref": "#/components/schemas/BatchJobWebhook" }, { "$ref": "#/components/schemas/BatchCompletedWebhook" } ] }, "ExtractionBatchRequest": { "type": "object", "properties": { "prompt": { "type": "string", "description": "Additional question or focus. Outer Unicode whitespace is trimmed. It does not suppress other default extraction fields; custom output controls the entire requested shape.", "minLength": 1, "maxLength": 4000 }, "output": { "oneOf": [ { "type": "object", "properties": { "format": { "const": "json" }, "schema": { "type": "object", "description": "Draft 2020-12 schema restricted by the x-ndata-schema-policy document extension." } }, "required": [ "format" ], "additionalProperties": false }, { "type": "object", "properties": { "format": { "const": "markdown" }, "template": { "type": "string", "minLength": 1, "maxLength": 8000 } }, "required": [ "format", "template" ], "additionalProperties": false } ] }, "webhook_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2048, "description": "Public HTTPS callback URL on port 443. Supply with webhook_secret. No redirects or private destinations." }, "webhook_secret": { "type": "string", "minLength": 16, "maxLength": 512, "writeOnly": true, "description": "Customer-generated signing secret, supplied together with webhook_url. Never returned in job responses." }, "urls": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "description": "Ordered mixed-platform URLs. Duplicate inputs create distinct jobs. Options apply to every URL." } }, "required": [ "urls" ], "additionalProperties": false, "dependentRequired": { "webhook_url": [ "webhook_secret" ], "webhook_secret": [ "webhook_url" ] } }, "TranscriptionBatchRequest": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "native", "generated" ], "default": "native" }, "timestamps": { "type": "string", "enum": [ "flat", "sentence", "word" ], "default": "flat" }, "webhook_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2048, "description": "Public HTTPS callback URL on port 443. Supply with webhook_secret. No redirects or private destinations." }, "webhook_secret": { "type": "string", "minLength": 16, "maxLength": 512, "writeOnly": true, "description": "Customer-generated signing secret, supplied together with webhook_url. Never returned in job responses." }, "urls": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "description": "Ordered mixed-platform URLs. Duplicate inputs create distinct jobs. Options apply to every URL." } }, "required": [ "urls" ], "additionalProperties": false, "dependentRequired": { "webhook_url": [ "webhook_secret" ], "webhook_secret": [ "webhook_url" ] } } } }, "paths": { "/extractions": { "post": { "operationId": "createExtraction", "summary": "Submit an asynchronous extraction job", "x-required-scopes": [ "extractions:write" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionRequest" }, "examples": { "default": { "value": { "url": "https://www.youtube.com/watch?v=example" } }, "prompt": { "value": { "url": "https://www.youtube.com/watch?v=example", "prompt": "What is demonstrated?" } }, "custom_json": { "value": { "url": "https://www.youtube.com/watch?v=example", "output": { "format": "json", "schema": { "type": "object", "properties": { "answer": { "type": [ "string", "null" ] } }, "required": [ "answer" ], "additionalProperties": false } } } }, "markdown": { "value": { "url": "https://www.youtube.com/watch?v=example", "output": { "format": "markdown", "template": "# Summary\n\n## Steps" } } } } } } }, "callbacks": { "terminalJob": { "{$request.body#/webhook_url}": { "post": { "summary": "At-least-once terminal job event. Deduplicate by event_id and verify the raw body before parsing.", "security": [], "parameters": [ { "name": "ndata-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "t=,v1=. HMAC-SHA256 of timestamp + '.' + raw body using webhook_secret. Enforce freshness (300 seconds by default)." }, { "name": "ndata-Event-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Cage-Signature", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Compatibility alias for ndata-Signature; carries the identical HMAC value." }, { "name": "Cage-Event-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Compatibility alias for ndata-Event-Id; carries the identical event ID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobWebhook" } } } }, "responses": { "2XX": { "description": "Acknowledged. Other statuses and network failures retry up to 12 attempts with exponential backoff." } } } } } }, "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Identical replay", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/extractions/{id}": { "get": { "operationId": "getExtraction", "summary": "Get a extraction job", "x-required-scopes": [ "extractions:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Job status and optional result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions": { "post": { "operationId": "createTranscription", "summary": "Submit an asynchronous transcription job", "x-required-scopes": [ "transcriptions:write" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionRequest" }, "examples": { "native_flat": { "value": { "url": "https://www.youtube.com/watch?v=example", "mode": "native", "timestamps": "flat" } }, "native_sentence": { "value": { "url": "https://www.youtube.com/watch?v=example", "mode": "native", "timestamps": "sentence" } }, "native_word": { "value": { "url": "https://www.youtube.com/watch?v=example", "mode": "native", "timestamps": "word" } }, "generated_flat": { "value": { "url": "https://www.youtube.com/watch?v=example", "mode": "generated", "timestamps": "flat" } }, "generated_sentence": { "value": { "url": "https://www.youtube.com/watch?v=example", "mode": "generated", "timestamps": "sentence" } }, "generated_word": { "value": { "url": "https://www.youtube.com/watch?v=example", "mode": "generated", "timestamps": "word" } } } } } }, "callbacks": { "terminalJob": { "{$request.body#/webhook_url}": { "post": { "summary": "At-least-once terminal job event. Deduplicate by event_id and verify the raw body before parsing.", "security": [], "parameters": [ { "name": "ndata-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "t=,v1=. HMAC-SHA256 of timestamp + '.' + raw body using webhook_secret. Enforce freshness (300 seconds by default)." }, { "name": "ndata-Event-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Cage-Signature", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Compatibility alias for ndata-Signature; carries the identical HMAC value." }, { "name": "Cage-Event-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Compatibility alias for ndata-Event-Id; carries the identical event ID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobWebhook" } } } }, "responses": { "2XX": { "description": "Acknowledged. Other statuses and network failures retry up to 12 attempts with exponential backoff." } } } } } }, "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Identical replay", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions/{id}": { "get": { "operationId": "getTranscription", "summary": "Get a transcription job", "x-required-scopes": [ "transcriptions:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Job status and optional result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/extractions/batches": { "post": { "operationId": "createExtractionBatch", "summary": "Submit a mixed-platform extraction batch", "description": "Validates all inputs and reserves all child credits atomically. Processing is independent per child. The batch completes even when some or all children fail; failed children release their reservations.", "x-required-scopes": [ "extractions:write" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "Workspace-scoped across single jobs, batches and portal submissions. Replay the identical ordered payload to recover an uncertain request." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionBatchRequest" } } } }, "callbacks": { "batchStream": { "{$request.body#/webhook_url}": { "post": { "summary": "Immutable per-child terminal JSON plus one batch.completed summary. Events may arrive out of order; deduplicate by event_id.", "security": [], "parameters": [ { "name": "ndata-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "t=,v1=. HMAC-SHA256 of timestamp + '.' + raw body using webhook_secret. Enforce freshness (300 seconds by default)." }, { "name": "ndata-Event-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Cage-Signature", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Compatibility alias for ndata-Signature; carries the identical HMAC value." }, { "name": "Cage-Event-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Compatibility alias for ndata-Event-Id; carries the identical event ID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchWebhook" } } } }, "responses": { "2XX": { "description": "Acknowledged after durable receiver acceptance. Non-2xx and network failures retry with jitter up to 32 claims within 86400 seconds. Delivery failures never change job credits." } } } } } }, "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "202": { "description": "Batch accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Identical replay", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/extractions/batches/{batch_id}": { "get": { "operationId": "getExtractionBatch", "summary": "Batch counts, credit totals and delivery progress", "x-required-scopes": [ "extractions:read" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Batch counts, credit totals and delivery progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/extractions/batches/{batch_id}/items": { "get": { "operationId": "listExtractionBatchItems", "summary": "Ordered child inventory; read each job link for full results", "x-required-scopes": [ "extractions:read" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "maxLength": 4096 }, "description": "Opaque next_cursor from this batch and collection." } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Ordered child inventory; read each job link for full results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchItemPage" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/extractions/batches/{batch_id}/deliveries": { "get": { "operationId": "listExtractionBatchDeliveries", "summary": "Delivery metadata without callback credentials or payload bodies", "x-required-scopes": [ "extractions:read" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "maxLength": 4096 }, "description": "Opaque next_cursor from this batch and collection." } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Delivery metadata without callback credentials or payload bodies", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeliveryPage" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/extractions/batches/{batch_id}/deliveries/{event_id}/redeliver": { "post": { "operationId": "redeliverExtractionBatchEvent", "summary": "Redeliver an exhausted event with the original bytes and event ID", "description": "Empty body only. Starts a new fenced retry generation. Already acknowledged or active events return 409. Paused batches remain paused.", "x-required-scopes": [ "extractions:write" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "Workspace-scoped across single jobs, batches and portal submissions. Replay the identical ordered payload to recover an uncertain request." } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "202": { "description": "Redelivery scheduled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Identical redelivery replay", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions/batches": { "post": { "operationId": "createTranscriptionBatch", "summary": "Submit a mixed-platform transcription batch", "description": "Validates all inputs and reserves all child credits atomically. Processing is independent per child. The batch completes even when some or all children fail; failed children release their reservations.", "x-required-scopes": [ "transcriptions:write" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "Workspace-scoped across single jobs, batches and portal submissions. Replay the identical ordered payload to recover an uncertain request." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionBatchRequest" } } } }, "callbacks": { "batchStream": { "{$request.body#/webhook_url}": { "post": { "summary": "Immutable per-child terminal JSON plus one batch.completed summary. Events may arrive out of order; deduplicate by event_id.", "security": [], "parameters": [ { "name": "ndata-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "t=,v1=. HMAC-SHA256 of timestamp + '.' + raw body using webhook_secret. Enforce freshness (300 seconds by default)." }, { "name": "ndata-Event-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Cage-Signature", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Compatibility alias for ndata-Signature; carries the identical HMAC value." }, { "name": "Cage-Event-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Compatibility alias for ndata-Event-Id; carries the identical event ID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchWebhook" } } } }, "responses": { "2XX": { "description": "Acknowledged after durable receiver acceptance. Non-2xx and network failures retry with jitter up to 32 claims within 86400 seconds. Delivery failures never change job credits." } } } } } }, "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "202": { "description": "Batch accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Identical replay", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "headers": { "Location": { "schema": { "type": "string" } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions/batches/{batch_id}": { "get": { "operationId": "getTranscriptionBatch", "summary": "Batch counts, credit totals and delivery progress", "x-required-scopes": [ "transcriptions:read" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Batch counts, credit totals and delivery progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions/batches/{batch_id}/items": { "get": { "operationId": "listTranscriptionBatchItems", "summary": "Ordered child inventory; read each job link for full results", "x-required-scopes": [ "transcriptions:read" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "maxLength": 4096 }, "description": "Opaque next_cursor from this batch and collection." } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Ordered child inventory; read each job link for full results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchItemPage" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions/batches/{batch_id}/deliveries": { "get": { "operationId": "listTranscriptionBatchDeliveries", "summary": "Delivery metadata without callback credentials or payload bodies", "x-required-scopes": [ "transcriptions:read" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "maxLength": 4096 }, "description": "Opaque next_cursor from this batch and collection." } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Delivery metadata without callback credentials or payload bodies", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeliveryPage" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/transcriptions/batches/{batch_id}/deliveries/{event_id}/redeliver": { "post": { "operationId": "redeliverTranscriptionBatchEvent", "summary": "Redeliver an exhausted event with the original bytes and event ID", "description": "Empty body only. Starts a new fenced retry generation. Already acknowledged or active events return 409. Paused batches remain paused.", "x-required-scopes": [ "transcriptions:write" ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "Workspace-scoped across single jobs, batches and portal submissions. Replay the identical ordered payload to recover an uncertain request." } ], "responses": { "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "202": { "description": "Redelivery scheduled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "200": { "description": "Identical redelivery replay", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/usage": { "get": { "operationId": "getUsage", "summary": "Workspace credit usage and quota snapshot", "x-required-scopes": [ "usage:read" ], "responses": { "200": { "description": "Workspace usage and quota, including this request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageResult" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "400": { "description": "Invalid request or schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "403": { "description": "Missing scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "413": { "description": "Request body exceeds configured limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "429": { "description": "Request-rate, queued/running job, or daily processing budget exceeded. Retry-After is seconds; daily processing budgets reset at the next UTC midnight. No new job reservation or worker attempt is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "processing_budget_exceeded": { "summary": "The workspace daily processing budget is exhausted", "value": { "error": { "code": "processing_budget_exceeded", "message": "The daily processing budget has been reached. Retry after the UTC day resets.", "details": { "quota": "processing_budget", "counter": "jobs" } } } } } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "X-RateLimit-Limit": { "description": "Burst capacity of the most restrictive pool.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Remaining": { "description": "Whole requests immediately available in that pool after this request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "UTC epoch seconds when the selected pool refills or permits the next request.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Limit": { "description": "Shared workspace burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Workspace-Remaining": { "description": "Workspace requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Limit": { "description": "This API key's burst capacity for this lane.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Key-Remaining": { "description": "API key requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Limit": { "description": "Service-wide HTTP burst capacity.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Global-Remaining": { "description": "Service-wide requests immediately available.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Pool": { "description": "Pool currently closest to exhaustion, or blocking this request.", "schema": { "type": "string", "enum": [ "global", "workspace", "key" ] } }, "X-RateLimit-Lane": { "description": "Request lane used for admission.", "schema": { "type": "string", "enum": [ "submit", "read" ] } } } } } } }, "/openapi.json": { "get": { "operationId": "getOpenAPI", "security": [], "summary": "Implemented API specification", "responses": { "200": { "description": "OpenAPI document" } } } } }, "x-ndata-documentation": { "generated": "Generated by scripts/export_public_docs.py. Do not edit manually.", "kind": "release-reference", "runtime_specification": "https://api.ndata.io/v1/openapi.json" } }