{ "openapi": "3.1.0", "info": { "title": "nikuniku.ai public API", "version": "1.0.0-local", "description": "Generated from apps/api/src/http/v1-spec.ts. Local acceptance only; not deployed." }, "servers": [ { "url": "/" } ], "components": { "securitySchemes": { "session": { "type": "apiKey", "in": "cookie", "name": "nk_session" }, "api_key": { "type": "http", "scheme": "bearer", "description": "nk_ API key from /v1/keys" } }, "schemas": { "Admission_Id": { "type": "string", "maxLength": 128, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "Admission_Hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "Admission_Units": { "type": "integer", "minimum": 1, "maximum": 1000000000000 }, "Admission_DraftInput": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "draft_json" ], "properties": { "workspace_id": { "$ref": "#/components/schemas/Admission_Id" }, "draft_json": { "type": "string", "description": "Existing canonical encodeDraft/decodeDraft v1, UTF8 at most65536 bytes; outer request at most71680 bytes. Ready confirmed original revision required; no silent demo workspace/price remapping." } } }, "Admission_QuoteInput": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "project_id" ], "properties": { "workspace_id": { "$ref": "#/components/schemas/Admission_Id" }, "project_id": { "$ref": "#/components/schemas/Admission_Id" } } }, "Admission_SubmitCommand": { "type": "object", "additionalProperties": false, "required": [ "quote_id", "acknowledged_input_hash", "user_acknowledged_max_units", "idempotency_key" ], "properties": { "quote_id": { "$ref": "#/components/schemas/Admission_Id" }, "acknowledged_input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "user_acknowledged_max_units": { "$ref": "#/components/schemas/Admission_Units" }, "idempotency_key": { "$ref": "#/components/schemas/Admission_Id" } } }, "Admission_SubmitInput": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "command" ], "properties": { "workspace_id": { "$ref": "#/components/schemas/Admission_Id" }, "command": { "$ref": "#/components/schemas/Admission_SubmitCommand" } } }, "Admission_DraftResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "input_hash", "revision" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "revision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } }, "Admission_QuoteResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "unit_version", "quote_id", "input_hash", "max_units", "expires_at" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "quote_id": { "$ref": "#/components/schemas/Admission_Id" }, "input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "max_units": { "$ref": "#/components/schemas/Admission_Units" }, "expires_at": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "release_revision": { "$ref": "#/components/schemas/Admission_Id" } } }, "Admission_AdmissionResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "unit_version", "job_id", "quote_id", "input_hash", "max_units" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "job_id": { "$ref": "#/components/schemas/Admission_Id" }, "quote_id": { "$ref": "#/components/schemas/Admission_Id" }, "input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "max_units": { "$ref": "#/components/schemas/Admission_Units" } } }, "Admission_Error": { "type": "object", "additionalProperties": false, "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "DENIED", "NOT_FOUND", "TOO_LARGE", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "ADMISSION_UNAVAILABLE", "CONCURRENCY_LIMIT", "REQUEST_ABORTED" ] } } }, "Admission_StoredDraftResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "workspace_id", "project_id", "revision", "input_hash", "draft_json" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "workspace_id": { "$ref": "#/components/schemas/Admission_Id" }, "project_id": { "$ref": "#/components/schemas/Admission_Id" }, "revision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "draft_json": { "type": "string", "description": "Original canonical stored v1 draft, max65536 UTF8 bytes. Verify source/hash then clear historical confirmation in browser; never current consent." } } }, "Admission_AlreadyAdmittedResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "unit_version", "job_id", "quote_id", "input_hash", "max_units", "status" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "job_id": { "$ref": "#/components/schemas/Admission_Id" }, "quote_id": { "$ref": "#/components/schemas/Admission_Id" }, "input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "max_units": { "$ref": "#/components/schemas/Admission_Units" }, "status": { "const": "admitted" } } }, "Admission_ClosedRequestResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "unit_version", "quote_id", "input_hash", "status", "acknowledged_max_units", "closed_at" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "quote_id": { "$ref": "#/components/schemas/Admission_Id" }, "input_hash": { "$ref": "#/components/schemas/Admission_Hash" }, "status": { "const": "closed" }, "acknowledged_max_units": { "$ref": "#/components/schemas/Admission_Units" }, "closed_at": { "type": "integer", "minimum": 1, "maximum": 9007199254680991 } } }, "Admission_CloseRequestResult": { "oneOf": [ { "$ref": "#/components/schemas/Admission_ClosedRequestResult" }, { "$ref": "#/components/schemas/Admission_AlreadyAdmittedResult" } ] }, "Job_Error": { "type": "object", "required": [ "code" ], "properties": { "code": { "enum": [ "DENIED", "INVALID_INPUT", "NOT_FOUND", "READ_UNAVAILABLE" ] } } }, "Job_Snapshot": { "type": "object", "required": [ "schema_version", "simulation_only", "workspace_id", "job_id", "input_hash", "input_revision", "state", "outcome", "billing", "output", "model_release" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "input_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "input_revision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "state": { "enum": [ "queued", "submitted", "running", "verifying", "succeeded", "failed", "outcome_pending", "cancel_requested", "cancelled" ] }, "outcome": { "enum": [ "pending", "delivered", "not_executed" ] }, "billing": { "type": "object", "required": [ "unit_version", "state", "held_units", "charged_units", "compensated_units" ], "properties": { "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "state": { "enum": [ "reserved", "settled", "released" ] }, "held_units": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "charged_units": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compensated_units": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "output": { "type": [ "object", "null" ], "description": "Original synthetic output metadata; no download or regeneration authority.", "required": [ "output_id", "sha256", "release" ], "properties": { "output_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "release": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } }, "model_release": { "type": [ "object", "null" ], "description": "Historical frozen model metadata, not current runtime acceptance. Full nested sold_spec type remains owned by generation/inspection.ts.", "required": [ "release_revision", "manifest_sha256", "contract_version", "model_repo_sha", "service_adapter_version", "sold_spec", "simulation_only", "current_acceptance" ], "properties": { "release_revision": { "type": "string" }, "manifest_sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "contract_version": { "type": "string" }, "model_repo_sha": { "type": "string", "pattern": "^[a-f0-9]{40}$" }, "service_adapter_version": { "type": "string" }, "sold_spec": { "type": "object" }, "simulation_only": { "type": "boolean" }, "current_acceptance": { "const": "not_checked" } } } } }, "Progress_Error": { "$ref": "#/components/schemas/Job_Error" }, "Progress_ProgressView": { "type": "object", "additionalProperties": false, "required": [ "projection", "snapshot", "progress" ], "properties": { "projection": { "const": "progress_v1" }, "snapshot": { "$ref": "#/components/schemas/Job_Snapshot" }, "progress": { "type": "object", "additionalProperties": false, "required": [ "preparation", "engine" ], "properties": { "preparation": { "type": "object", "additionalProperties": false, "required": [ "state", "input_hash", "input_revision" ], "properties": { "state": { "const": "inputs_confirmed" }, "input_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "input_revision": { "type": "integer", "minimum": 1 } } }, "engine": { "type": "object", "additionalProperties": false, "required": [ "state", "basis", "read_at", "estimated_start_at" ], "properties": { "state": { "type": "string", "enum": [ "waiting_capacity", "capacity_requested", "capacity_ready", "claimed", "running", "reconciling", "unavailable", "complete" ] }, "basis": { "const": "persisted_simulator_state" }, "read_at": { "type": "integer", "minimum": 1 }, "estimated_start_at": { "type": "null" } } } } } } }, "Progress_ProvenanceView": { "type": "object", "additionalProperties": false, "required": [ "projection", "snapshot", "progress", "input_versions" ], "properties": { "projection": { "const": "provenance_v1" }, "snapshot": { "$ref": "#/components/schemas/Job_Snapshot" }, "progress": { "$ref": "#/components/schemas/Progress_ProgressView/properties/progress" }, "input_versions": { "type": "object", "additionalProperties": false, "required": [ "capabilities_revision", "price_version" ], "properties": { "capabilities_revision": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "price_version": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } } } }, "Billing_Error": { "type": "object", "additionalProperties": false, "required": [ "code" ], "properties": { "code": { "enum": [ "DENIED", "INVALID_INPUT", "NOT_FOUND", "READ_CANCELLED", "READ_UNAVAILABLE" ] } } }, "Billing_BillingSnapshot": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "workspace_id", "job_id", "state", "outcome", "billing" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "state": { "enum": [ "queued", "submitted", "running", "verifying", "succeeded", "failed", "outcome_pending", "cancel_requested", "cancelled" ] }, "outcome": { "enum": [ "pending", "delivered", "not_executed" ] }, "billing": { "type": "object", "additionalProperties": false, "required": [ "unit_version", "state", "held_units", "charged_units", "compensated_units" ], "properties": { "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "state": { "enum": [ "reserved", "settled", "released" ] }, "held_units": { "type": "integer", "minimum": 1, "maximum": 1000000000000 }, "charged_units": { "type": "integer", "minimum": 0, "maximum": 1000000000000 }, "compensated_units": { "type": "integer", "minimum": 0, "maximum": 1000000000000 } } } } }, "Billing_LedgerCursor": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "workspace_id", "job_id", "after", "watermark" ], "properties": { "schema_version": { "const": 1 }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "after": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "watermark": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 9007199254740991 } } }, "Billing_LedgerEntry": { "type": "object", "additionalProperties": false, "required": [ "entry_id", "sequence", "transaction_id", "lot_id", "account", "signed_units", "operation", "correction_of_transaction_id" ], "properties": { "entry_id": { "type": "string", "pattern": "^entry_[1-9][0-9]*$" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "transaction_id": { "type": "string", "pattern": "^tx_[a-f0-9]{64}$" }, "lot_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "account": { "enum": [ "available", "reserved", "consumed" ] }, "signed_units": { "type": "integer", "minimum": -1000000000000, "maximum": 1000000000000, "not": { "const": 0 } }, "operation": { "enum": [ "reserve", "finalize", "compensate" ] }, "correction_of_transaction_id": { "type": [ "string", "null" ], "pattern": "^tx_[a-f0-9]{64}$" } } }, "Billing_LedgerPage": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "scope", "workspace_id", "job_id", "unit_version", "watermark", "entries", "next_cursor", "resume_cursor" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "scope": { "const": "original_job_only" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "watermark": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "entries": { "type": "array", "maxItems": 100, "items": { "$ref": "#/components/schemas/Billing_LedgerEntry" } }, "next_cursor": { "oneOf": [ { "$ref": "#/components/schemas/Billing_LedgerCursor" }, { "type": "null" } ] }, "resume_cursor": { "oneOf": [ { "$ref": "#/components/schemas/Billing_LedgerCursor" }, { "type": "null" } ] } } }, "Cancel_Id": { "type": "string", "maxLength": 128, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "Cancel_CancelInput": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "job_id" ], "properties": { "workspace_id": { "$ref": "#/components/schemas/Cancel_Id" }, "job_id": { "$ref": "#/components/schemas/Cancel_Id" } } }, "Cancel_CancelResult": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "simulation_only", "job_id", "state" ], "properties": { "schema_version": { "const": 1 }, "simulation_only": { "type": "boolean" }, "job_id": { "$ref": "#/components/schemas/Cancel_Id" }, "state": { "type": "string", "enum": [ "cancelled", "cancel_requested", "outcome_pending", "succeeded", "failed", "verifying" ] } } }, "Cancel_Error": { "type": "object", "additionalProperties": false, "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "DENIED", "NOT_FOUND", "TOO_LARGE", "IDEMPOTENCY_CONFLICT", "OUTCOME_CONFLICT", "CANCEL_UNAVAILABLE" ] } } } } }, "paths": { "/v1/billing/wallet": { "get": { "summary": "Wallet balance of a workspace in its credit unit (credit_v1: 1 credit = US$0.01)", "parameters": [ { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "unit_version", "available_units", "reserved_units", "consumed_units" ], "properties": { "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "available_units": { "type": "integer" }, "reserved_units": { "type": "integer" }, "consumed_units": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "SESSION_INVALID", "FORBIDDEN", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/wallet": { "get": { "summary": "Wallet balance of a workspace for an API key with billing:read (credit_v1: 1 credit = US$0.01)", "parameters": [ { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "unit_version", "available_units", "reserved_units", "consumed_units" ], "properties": { "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "available_units": { "type": "integer" }, "reserved_units": { "type": "integer" }, "consumed_units": { "type": "integer" } } } } }, "example": { "ok": true, "data": { "unit_version": "credit_v1", "available_units": 1000, "reserved_units": 0, "consumed_units": 0 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/recharge/orders": { "post": { "summary": "Create a USDT recharge order for a priced offer on the chosen network (pay_currency, default usdttrc20; one order and one invoice per idempotency_key); pay at checkout_url on nowpayments.io on that network only", "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "offer_id", "idempotency_key" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "offer_id": { "type": "string", "pattern": "^usd[0-9]{1,6}$" }, "idempotency_key": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "pay_currency": { "type": "string", "enum": [ "usdttrc20", "usdtbsc", "usdterc20", "usdtmatic", "usdtsol", "usdtton", "usdtarb", "usdtarc20" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "order_id", "offer_id", "usd_cents", "credits", "unit_version", "price_version", "pay_currency", "state", "checkout_url", "created_at" ], "properties": { "order_id": { "type": "string", "pattern": "^ord_[a-f0-9]{40}$" }, "offer_id": { "type": "string" }, "usd_cents": { "type": "integer", "minimum": 1 }, "credits": { "type": "integer", "minimum": 1 }, "unit_version": { "const": "credit_v1" }, "price_version": { "type": "string" }, "pay_currency": { "type": "string", "enum": [ "usdttrc20", "usdtbsc", "usdterc20", "usdtmatic", "usdtsol", "usdtton", "usdtarb", "usdtarc20" ] }, "state": { "type": "string", "enum": [ "dispatching", "invoice_bound", "unknown", "credited", "review_required" ] }, "checkout_url": { "type": [ "string", "null" ] }, "created_at": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "IDEMPOTENCY_CONFLICT", "UNIT_UNSUPPORTED", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/recharge/orders/{order_id}": { "get": { "summary": "Read a recharge order; credited means the credits are in the wallet", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "order_id", "offer_id", "usd_cents", "credits", "unit_version", "price_version", "pay_currency", "state", "checkout_url", "created_at" ], "properties": { "order_id": { "type": "string", "pattern": "^ord_[a-f0-9]{40}$" }, "offer_id": { "type": "string" }, "usd_cents": { "type": "integer", "minimum": 1 }, "credits": { "type": "integer", "minimum": 1 }, "unit_version": { "const": "credit_v1" }, "price_version": { "type": "string" }, "pay_currency": { "type": "string", "enum": [ "usdttrc20", "usdtbsc", "usdterc20", "usdtmatic", "usdtsol", "usdtton", "usdtarb", "usdtarc20" ] }, "state": { "type": "string", "enum": [ "dispatching", "invoice_bound", "unknown", "credited", "review_required" ] }, "checkout_url": { "type": [ "string", "null" ] }, "created_at": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "SESSION_INVALID", "FORBIDDEN", "NOT_FOUND", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/recharge/fiat-orders": { "post": { "summary": "Create a WeChat Pay / Alipay recharge order for a priced offer (method from /v1/pricing fiat.methods; one order and one checkout per idempotency_key). The checkout is the offer price x surcharge_bp/10000 in whole CNY at the rate fixed on the order; the order credits the offer's credits", "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "offer_id", "idempotency_key", "method" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "offer_id": { "type": "string", "pattern": "^usd[0-9]{1,6}$" }, "idempotency_key": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "method": { "type": "string", "enum": [ "alipay", "wechat" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "order_id", "offer_id", "method", "usd_cents", "credits", "surcharge_bp", "pay_currency", "pay_yuan", "state", "checkout_url", "credited_units", "created_at" ], "properties": { "order_id": { "type": "string", "pattern": "^nk_[a-f0-9]{40}$" }, "offer_id": { "type": "string" }, "method": { "type": "string", "enum": [ "alipay", "wechat" ] }, "usd_cents": { "type": "integer" }, "credits": { "type": "integer" }, "surcharge_bp": { "type": "integer" }, "pay_currency": { "const": "CNY" }, "pay_yuan": { "type": "integer" }, "state": { "type": "string", "enum": [ "dispatching", "checkout_bound", "unknown", "credited", "expired", "review_required" ] }, "checkout_url": { "type": [ "string", "null" ] }, "credited_units": { "type": [ "integer", "null" ] }, "created_at": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "IDEMPOTENCY_CONFLICT", "UNIT_UNSUPPORTED", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/recharge/fiat-orders/{order_id}": { "get": { "summary": "Read a WeChat Pay / Alipay order after checking it with the provider; credited means the credits are in the wallet", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "order_id", "offer_id", "method", "usd_cents", "credits", "surcharge_bp", "pay_currency", "pay_yuan", "state", "checkout_url", "credited_units", "created_at" ], "properties": { "order_id": { "type": "string", "pattern": "^nk_[a-f0-9]{40}$" }, "offer_id": { "type": "string" }, "method": { "type": "string", "enum": [ "alipay", "wechat" ] }, "usd_cents": { "type": "integer" }, "credits": { "type": "integer" }, "surcharge_bp": { "type": "integer" }, "pay_currency": { "const": "CNY" }, "pay_yuan": { "type": "integer" }, "state": { "type": "string", "enum": [ "dispatching", "checkout_bound", "unknown", "credited", "expired", "review_required" ] }, "checkout_url": { "type": [ "string", "null" ] }, "credited_units": { "type": [ "integer", "null" ] }, "created_at": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "SESSION_INVALID", "FORBIDDEN", "NOT_FOUND", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/payments/nowpayments/ipn": { "post": { "summary": "NOWPayments payment notification (HMAC-SHA512 over the raw body in x-nowpayments-sig); credit follows only from the authoritative payment read", "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "received", "result" ], "properties": { "received": { "const": true }, "result": { "type": "string", "enum": [ "credited", "already_credited", "pending", "review_required", "unknown_order" ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "INVALID_SIGNATURE", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/ops/metrics": { "get": { "summary": "Operator engine metrics for jobs admitted in [from,to) (default: the last 24 hours, at most 31 days): success rate over finished jobs, latency distributions and executor GPU spend", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,15}$" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,15}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "window", "truncated", "jobs", "success_rate", "denominator", "latency_ms", "cost" ], "properties": { "schema_version": { "const": 1 }, "window": { "type": "object", "additionalProperties": false, "required": [ "from", "to" ], "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } } }, "truncated": { "type": "boolean" }, "jobs": { "type": "object", "additionalProperties": false, "required": [ "admitted", "succeeded", "failed", "cancelled", "in_flight" ], "properties": { "admitted": { "type": "integer" }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" }, "cancelled": { "type": "integer" }, "in_flight": { "type": "integer" } } }, "success_rate": { "type": [ "number", "null" ] }, "denominator": { "type": "object", "additionalProperties": false, "required": [ "finished", "excluded_cancelled", "excluded_in_flight" ], "properties": { "finished": { "type": "integer" }, "excluded_cancelled": { "type": "integer" }, "excluded_in_flight": { "type": "integer" } } }, "latency_ms": { "type": "object", "additionalProperties": false, "required": [ "admit_to_claim", "admit_to_verified" ], "properties": { "admit_to_claim": { "type": "object", "additionalProperties": false, "required": [ "count", "p50", "p90", "p99", "max" ], "properties": { "count": { "type": "integer" }, "p50": { "type": [ "integer", "null" ] }, "p90": { "type": [ "integer", "null" ] }, "p99": { "type": [ "integer", "null" ] }, "max": { "type": [ "integer", "null" ] } } }, "admit_to_verified": { "type": "object", "additionalProperties": false, "required": [ "count", "p50", "p90", "p99", "max" ], "properties": { "count": { "type": "integer" }, "p50": { "type": [ "integer", "null" ] }, "p90": { "type": [ "integer", "null" ] }, "p99": { "type": [ "integer", "null" ] }, "max": { "type": [ "integer", "null" ] } } } } }, "cost": { "type": "object", "additionalProperties": false, "required": [ "source", "machines", "unpriced_machines", "gpu_usd", "usd_per_second", "usd_per_succeeded_job" ], "properties": { "source": { "const": "executor_rentals" }, "machines": { "type": "integer" }, "unpriced_machines": { "type": "integer" }, "gpu_usd": { "type": "number" }, "usd_per_second": { "type": "number" }, "usd_per_succeeded_job": { "type": [ "number", "null" ] } } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "RATE_LIMITED" ] } }, "/v1/ops/workspaces/{workspace_id}": { "get": { "summary": "Operator view of a workspace: members, wallet, job counts by state and active keys (ops:read; audited)", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "active", "members", "wallet", "jobs", "active_keys" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "active": { "type": "boolean" }, "members": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "user_id", "active" ], "properties": { "user_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "active": { "type": "boolean" } } } }, "wallet": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "unit_version", "available_units", "reserved_units", "consumed_units" ], "properties": { "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "available_units": { "type": "integer" }, "reserved_units": { "type": "integer" }, "consumed_units": { "type": "integer" } } }, { "type": "null" } ] }, "jobs": { "type": "object", "additionalProperties": false, "required": [ "total", "by_state" ], "properties": { "total": { "type": "integer" }, "by_state": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "active_keys": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED" ] } }, "/v1/ops/jobs/{job_id}": { "get": { "summary": "Operator view of a job: state, outcome, charge, admission time and any takedown (ops:read; audited)", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "job_id", "state", "outcome", "charge_units", "quote_id", "admitted_at", "takedown" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "state": { "type": "string" }, "outcome": { "type": "string" }, "charge_units": { "type": [ "integer", "null" ] }, "quote_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "admitted_at": { "type": [ "integer", "null" ] }, "takedown": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "reason", "taken_at" ], "properties": { "reason": { "type": "string" }, "taken_at": { "type": "integer" } } }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED" ] } }, "/v1/ops/ledger": { "get": { "summary": "Operator view of a workspace ledger: wallet and the 50 newest posted transactions with net movement per account (ops:read; audited)", "parameters": [ { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "wallet", "transactions" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "wallet": { "type": "object", "additionalProperties": false, "required": [ "unit_version", "available_units", "reserved_units", "consumed_units" ], "properties": { "unit_version": { "type": "string", "enum": [ "fixture_credit_v1", "credit_v1" ] }, "available_units": { "type": "integer" }, "reserved_units": { "type": "integer" }, "consumed_units": { "type": "integer" } } }, "transactions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "transaction_id", "business_key", "available", "reserved", "consumed" ], "properties": { "transaction_id": { "type": "string" }, "business_key": { "type": "string" }, "available": { "type": "integer" }, "reserved": { "type": "integer" }, "consumed": { "type": "integer" } } } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED" ] } }, "/v1/ops/jobs/{job_id}/takedown": { "post": { "summary": "Take down a job output: the customer output link becomes 410 OUTPUT_REMOVED; the first takedown stands (ops:write; audited with the reason)", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "reason" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "job_id", "taken_at" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "taken_at": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED" ] } }, "/v1/ops/users/{user_id}/freeze": { "post": { "summary": "Freeze an account: its sessions and keys stop working until unfrozen (ops:write; audited with the reason; not your own account)", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "reason" ], "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 500 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "user_id", "active" ], "properties": { "user_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "active": { "type": "boolean" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED", "OPS_CONFLICT" ] } }, "/v1/ops/users/{user_id}/unfreeze": { "post": { "summary": "Unfreeze an account (ops:write; audited with the reason)", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "reason" ], "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 500 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "user_id", "active" ], "properties": { "user_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "active": { "type": "boolean" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED", "OPS_CONFLICT" ] } }, "/v1/ops/orders": { "get": { "summary": "Operator view of a workspace live recharge orders with refunded and still refundable (unspent) credits (ops:read; audited)", "parameters": [ { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "orders" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "orders": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "order_id", "state", "usd_cents", "credits", "credited_units", "paid_usdt_micro", "pay_currency", "payment_id", "created_at", "refunded_units", "refundable_units" ], "properties": { "order_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "state": { "type": "string" }, "usd_cents": { "type": "integer" }, "credits": { "type": "integer" }, "credited_units": { "type": [ "integer", "null" ] }, "paid_usdt_micro": { "type": [ "string", "null" ] }, "pay_currency": { "type": "string" }, "payment_id": { "type": [ "string", "null" ] }, "created_at": { "type": "integer" }, "refunded_units": { "type": "integer" }, "refundable_units": { "type": "integer" } } } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED" ] } }, "/v1/ops/orders/{order_id}/refunds": { "post": { "summary": "Refund part or all of a credited live order: revokes that many unspent credits (1 credit = US$0.01) now; the USDT payout is sent separately and recorded with /paid (ops:write; idempotent per key; audited)", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "units", "reason", "idempotency_key" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "units": { "type": "integer", "minimum": 1, "maximum": 1000000000 }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "idempotency_key": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "refund_id", "workspace_id", "order_id", "units", "usd_cents", "state", "payout_ref", "created_at", "paid_at" ], "properties": { "refund_id": { "type": "string", "pattern": "^rfd_[a-f0-9]{40}$" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "order_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "units": { "type": "integer" }, "usd_cents": { "type": "integer" }, "state": { "type": "string", "enum": [ "credits_revoked", "paid" ] }, "payout_ref": { "type": [ "string", "null" ] }, "created_at": { "type": "integer" }, "paid_at": { "type": [ "integer", "null" ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED", "IDEMPOTENCY_CONFLICT", "ORDER_NOT_REFUNDABLE", "REFUND_EXCEEDS_UNSPENT" ] } }, "/v1/ops/orders/{order_id}/credit": { "post": { "summary": "Credit a live order in review (short, over or late payment) after NOWPayments shows that payment belongs to the order and settled with money received; issues the order credits once (ops:write; audited with the reason)", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "payment_id", "reason" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "payment_id": { "type": "string", "pattern": "^[1-9][0-9]{0,19}$" }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "order_id", "offer_id", "usd_cents", "credits", "unit_version", "price_version", "pay_currency", "state", "checkout_url", "created_at" ], "properties": { "order_id": { "type": "string", "pattern": "^ord_[a-f0-9]{40}$" }, "offer_id": { "type": "string" }, "usd_cents": { "type": "integer", "minimum": 1 }, "credits": { "type": "integer", "minimum": 1 }, "unit_version": { "const": "credit_v1" }, "price_version": { "type": "string" }, "pay_currency": { "type": "string", "enum": [ "usdttrc20", "usdtbsc", "usdterc20", "usdtmatic", "usdtsol", "usdtton", "usdtarb", "usdtarc20" ] }, "state": { "type": "string", "enum": [ "dispatching", "invoice_bound", "unknown", "credited", "review_required" ] }, "checkout_url": { "type": [ "string", "null" ] }, "created_at": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "PAYMENTS_UNAVAILABLE" ] } }, "/v1/ops/refunds/{refund_id}/paid": { "post": { "summary": "Record the payout reference of a refund once (ops:write; audited)", "parameters": [ { "name": "refund_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "payout_ref" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "payout_ref": { "type": "string", "minLength": 1, "maxLength": 128 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "refund_id", "workspace_id", "order_id", "units", "usd_cents", "state", "payout_ref", "created_at", "paid_at" ], "properties": { "refund_id": { "type": "string", "pattern": "^rfd_[a-f0-9]{40}$" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "order_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "units": { "type": "integer" }, "usd_cents": { "type": "integer" }, "state": { "type": "string", "enum": [ "credits_revoked", "paid" ] }, "payout_ref": { "type": [ "string", "null" ] }, "created_at": { "type": "integer" }, "paid_at": { "type": [ "integer", "null" ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED", "REFUND_ALREADY_PAID" ] } }, "/v1/ops/reconciliation": { "get": { "summary": "Reconciliation report: ledger self-check per workspace, credited orders re-read from NOWPayments, notifications that never credited, stuck orders, overdue refund payouts and idle executor rentals (ops:read; audited)", "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "schema_version", "generated_at", "checked", "findings" ], "properties": { "schema_version": { "const": 1 }, "generated_at": { "type": "integer" }, "checked": { "type": "object", "additionalProperties": false, "required": [ "workspaces", "credited_orders", "provider_rechecked", "unpaid_notifications" ], "properties": { "workspaces": { "type": "integer" }, "credited_orders": { "type": "integer" }, "provider_rechecked": { "type": "integer" }, "unpaid_notifications": { "type": "integer" } } }, "findings": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "kind", "subject", "detail" ], "properties": { "kind": { "type": "string", "enum": [ "ledger_drift", "provider_mismatch", "provider_unreachable", "notified_not_credited", "order_review_required", "order_unknown_stale", "refund_payout_overdue", "gpu_idle_rental" ] }, "subject": { "type": "string" }, "detail": { "type": "string" } } } } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "API_KEY_REQUIRED", "DENIED", "RATE_LIMITED" ] } }, "/v1/reports": { "post": { "summary": "Report content (no sign-in): non-consensual intimate imagery, minor safety, impersonation, copyright or other. Operators are notified at once; reports are acted on within 48 hours (due_at). At most 5 reports per hour per source", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "category", "target", "detail" ], "properties": { "category": { "type": "string", "enum": [ "ncii", "minor_safety", "impersonation", "copyright", "other" ] }, "target": { "type": "string", "minLength": 1, "maxLength": 500 }, "detail": { "type": "string", "minLength": 1, "maxLength": 2000 }, "contact_email": { "type": "string", "maxLength": 254 } } }, "example": { "category": "ncii", "target": "https://studio.nikuniku.ai/jobs?job=job_7a7f98e7535633ad57b14fe4dce0fa03f502687d5693298800f44760eadfff26", "detail": "This video shows me without my consent.", "contact_email": "reporter@example.com" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "report_id", "received_at", "due_at" ], "properties": { "report_id": { "type": "string" }, "received_at": { "type": "integer" }, "due_at": { "type": "integer" } } } } }, "example": { "ok": true, "data": { "report_id": "rpt_485af1ffb394464357ad6a82eaac00678becf4b5", "received_at": 1700000000000, "due_at": 1700172800000 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "REPORTS_UNAVAILABLE" ] } }, "/v1/ops/reports": { "get": { "summary": "Content reports: open ones by due time in pages of 200 (overdue flagged; after = the previous next_cursor; open_total counts all) and the 50 most recently resolved (ops:read; audited)", "parameters": [ { "name": "after", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "open", "open_total", "next_cursor", "recent" ], "properties": { "open": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "report_id", "category", "target", "job_id", "detail", "contact_email", "received_at", "due_at", "overdue", "state", "resolved_at", "resolution" ], "properties": { "report_id": { "type": "string" }, "category": { "type": "string" }, "target": { "type": "string" }, "job_id": { "type": [ "string", "null" ] }, "detail": { "type": "string" }, "contact_email": { "type": [ "string", "null" ] }, "received_at": { "type": "integer" }, "due_at": { "type": "integer" }, "overdue": { "type": "boolean" }, "state": { "type": "string" }, "resolved_at": { "type": [ "integer", "null" ] }, "resolution": { "type": [ "string", "null" ] } } } }, "open_total": { "type": "integer" }, "next_cursor": { "type": [ "string", "null" ] }, "recent": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "report_id", "category", "target", "job_id", "detail", "contact_email", "received_at", "due_at", "overdue", "state", "resolved_at", "resolution" ], "properties": { "report_id": { "type": "string" }, "category": { "type": "string" }, "target": { "type": "string" }, "job_id": { "type": [ "string", "null" ] }, "detail": { "type": "string" }, "contact_email": { "type": [ "string", "null" ] }, "received_at": { "type": "integer" }, "due_at": { "type": "integer" }, "overdue": { "type": "boolean" }, "state": { "type": "string" }, "resolved_at": { "type": [ "integer", "null" ] }, "resolution": { "type": [ "string", "null" ] } } } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "RATE_LIMITED" ] } }, "/v1/ops/reports/{report_id}/resolve": { "post": { "summary": "Resolve a content report once: actioned takes the output down (job_id, else the job named in the report; workspace_id when that job id is held by more than one workspace), rejected only closes it (ops:write; audited with the reason)", "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resolution", "reason" ], "properties": { "resolution": { "type": "string", "enum": [ "actioned", "rejected" ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "job_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "report_id", "state", "takedown" ], "properties": { "report_id": { "type": "string" }, "state": { "type": "string" }, "takedown": { "type": [ "object", "null" ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "SUBJECT_NOT_FOUND", "RATE_LIMITED", "REPORT_RESOLVED" ] } }, "/v1/ops/alerts": { "get": { "summary": "Open operator alerts: 5xx rate, payment notification failures, idle GPU rentals and reconciliation differences (ops:read; audited)", "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "alerts" ], "properties": { "alerts": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "kind", "subject", "detail", "first_at", "last_at", "count" ], "properties": { "kind": { "type": "string", "enum": [ "error_rate", "ipn_failure", "gpu_idle", "reconciliation", "content_report" ] }, "subject": { "type": "string" }, "detail": { "type": "string" }, "first_at": { "type": "integer" }, "last_at": { "type": "integer" }, "count": { "type": "integer" } } } } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "API_KEY_REQUIRED", "DENIED", "RATE_LIMITED" ] } }, "/v1/pricing": { "get": { "summary": "Public price list (no sign-in): price version, credit value, credits per output second and recharge offers; purchasable is false until payments are configured; fiat lists the WeChat Pay / Alipay methods open now and their surcharge", "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "price_version", "unit", "usd_micros_per_credit", "credits_per_output_second", "purchasable", "fiat", "offers" ], "properties": { "price_version": { "type": "string" }, "unit": { "const": "credit_v1" }, "usd_micros_per_credit": { "type": "integer", "minimum": 1 }, "credits_per_output_second": { "type": "integer", "minimum": 1 }, "purchasable": { "type": "boolean" }, "fiat": { "type": "object", "additionalProperties": false, "required": [ "methods", "surcharge_bp" ], "properties": { "methods": { "type": "array", "items": { "type": "string", "enum": [ "alipay", "wechat" ] } }, "surcharge_bp": { "type": "integer", "minimum": 10000 } } }, "offers": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "offer_id", "usd_cents", "credits" ], "properties": { "offer_id": { "type": "string", "pattern": "^usd[0-9]{1,6}$" }, "usd_cents": { "type": "integer", "minimum": 1 }, "credits": { "type": "integer", "minimum": 1 } } } } } } } }, "example": { "ok": true, "data": { "price_version": "price-p2-2026-11-02", "unit": "credit_v1", "usd_micros_per_credit": 10000, "credits_per_output_second": 8, "offers": [ { "offer_id": "usd20", "usd_cents": 2000, "credits": 2000 }, { "offer_id": "usd50", "usd_cents": 5000, "credits": 5000 }, { "offer_id": "usd100", "usd_cents": 10000, "credits": 10000 }, { "offer_id": "usd200", "usd_cents": 20000, "credits": 20000 } ], "purchasable": false, "fiat": { "methods": [], "surcharge_bp": 12000 } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [] } }, "/v1/auth/link": { "post": { "summary": "Request a one-time sign-in link (same response whether or not the email is registered)", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "email", "locale" ], "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "locale": { "type": "string", "enum": [ "en", "zh-Hant", "zh-Hans", "ja", "ko", "vi", "id", "th", "es", "pt-BR", "fr", "de", "ar", "hi" ] }, "turnstile_token": { "type": "string", "minLength": 1, "maxLength": 2048 } } } } } }, "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "accepted" ], "properties": { "accepted": { "const": true } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "EMAIL_NOT_CONFIGURED", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED" ] } }, "/v1/auth/turnstile": { "get": { "summary": "Cloudflare Turnstile site key for the sign-in page (null when this deployment does not require Turnstile); POST /v1/auth/link then needs turnstile_token", "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "site_key" ], "properties": { "site_key": { "type": [ "string", "null" ], "maxLength": 128 } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [] } }, "/v1/auth/oauth": { "get": { "summary": "Sign-in providers configured on this deployment (google, discord)", "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "providers" ], "properties": { "providers": { "type": "array", "items": { "type": "string", "enum": [ "google", "discord" ] } } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [] } }, "/v1/auth/oauth/{provider}/start": { "get": { "summary": "Browser navigation: starts Google or Discord sign-in (302 to the provider; sets the HttpOnly nk_oauth state cookie). A rate-limited start is sent back to /signin#oauth_error=RATE_LIMITED", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en", "zh-Hant", "zh-Hans", "ja", "ko", "vi", "id", "th", "es", "pt-BR", "fr", "de", "ar", "hi" ] } } ], "security": [], "responses": { "302": { "description": "Redirect; see the Location header" }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "NOT_FOUND" ] } }, "/v1/auth/oauth/{provider}/callback": { "get": { "summary": "Browser navigation from the provider: refuses a state that differs from the nk_oauth cookie, exchanges the code (PKCE) and sends the browser to /signin#token= or /signin#oauth_error=", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048 } }, { "name": "error", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } } ], "security": [], "responses": { "302": { "description": "Redirect; see the Location header" }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "NOT_FOUND" ] } }, "/v1/auth/link/check": { "post": { "summary": "Name the account a sign-in link signs in to (masked email) without using the link; the sign-in page asks the person to confirm before redeeming", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "token" ], "properties": { "token": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "email_hint", "kind" ], "properties": { "email_hint": { "type": "string", "minLength": 5, "maxLength": 260 }, "kind": { "type": "string", "enum": [ "sign_in", "sign_up" ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED" ] } }, "/v1/auth/redeem": { "post": { "summary": "Redeem a sign-in link; sets the nk_session cookie (HttpOnly; Secure; SameSite=Lax)", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "token" ], "properties": { "token": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "terms_version": { "type": "string", "minLength": 1, "maxLength": 64 }, "privacy_version": { "type": "string", "minLength": 1, "maxLength": 64 }, "marketing": { "type": "boolean" }, "replace_session": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "user_id", "workspace_id", "csrf_token", "created" ], "properties": { "user_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "csrf_token": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "created": { "type": "boolean" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "ACCOUNT_DISABLED", "SESSION_CONFLICT" ] } }, "/v1/auth/session": { "post": { "summary": "Resume a session after a page reload: rotates the nk_session cookie and CSRF token (the previous ones stop working; absolute expiry unchanged) and returns the workspace. Body must be {}", "security": [ { "session": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [], "properties": {} } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "user_id", "workspace_id", "csrf_token" ], "properties": { "user_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "csrf_token": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "SESSION_INVALID", "ACCOUNT_DISABLED" ] } }, "/v1/auth/logout": { "post": { "summary": "Revoke the current session and clear its cookie", "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [], "properties": {} } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "SESSION_INVALID", "CSRF_INVALID" ] } }, "/v1/auth/logout-all": { "post": { "summary": "Revoke every session of the signed-in user", "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [], "properties": {} } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "SESSION_INVALID", "CSRF_INVALID" ] } }, "/v1/keys": { "get": { "summary": "List API key metadata for a workspace (never the key itself)", "parameters": [ { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "client_id", "name", "prefix", "scopes", "created_at", "revoked_at" ], "properties": { "client_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "prefix": { "type": "string", "minLength": 8, "maxLength": 8 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "asset:upload", "asset:read", "asset:revoke", "generation:quote", "generation:submit", "generation:read", "billing:read", "ops:read", "ops:write" ] } }, "created_at": { "type": "integer" }, "revoked_at": { "type": [ "integer", "null" ] } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "SESSION_INVALID", "FORBIDDEN" ] }, "post": { "summary": "Issue an API key; the plaintext key is returned once", "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "name", "scopes" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "scopes": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "asset:upload", "asset:read", "asset:revoke", "generation:quote", "generation:submit", "generation:read", "billing:read", "ops:read", "ops:write" ] } } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "client_id", "key", "prefix" ], "properties": { "client_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "key": { "type": "string", "pattern": "^nk_[A-Za-z0-9_-]{43}$" }, "prefix": { "type": "string", "minLength": 8, "maxLength": 8 } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED" ] } }, "/v1/keys/{client_id}/rotate": { "post": { "summary": "Issue a replacement key with the same scopes and revoke the old one", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "client_id", "key", "prefix" ], "properties": { "client_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "key": { "type": "string", "pattern": "^nk_[A-Za-z0-9_-]{43}$" }, "prefix": { "type": "string", "minLength": 8, "maxLength": 8 } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "KEY_NOT_FOUND", "KEY_REVOKED" ] } }, "/v1/keys/{client_id}": { "delete": { "summary": "Revoke an API key immediately", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "session": [] } ], "x-csrf": "X-CSRF-Token header must equal the csrf_token returned by /v1/auth/redeem", "responses": { "204": { "description": "No content" }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "KEY_NOT_FOUND", "KEY_REVOKED" ] } }, "/v1/assets": { "post": { "summary": "Declare a reference image upload (idempotent per idempotency_key); reserves workspace quota", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "declaration" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "declaration": { "type": "object", "additionalProperties": false, "required": [ "idempotency_key", "declared_bytes", "mime", "rights_ref" ], "properties": { "idempotency_key": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "declared_bytes": { "type": "integer", "minimum": 1, "maximum": 1048576 }, "mime": { "const": "image/png" }, "rights_ref": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } } } }, "example": { "workspace_id": "ws_8c41e2f07d9a4b6c3e5f1a2d", "declaration": { "idempotency_key": "ref-1", "declared_bytes": 209, "mime": "image/png", "rights_ref": "user-owned" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "asset_id", "state", "sha256", "actual_bytes", "declared_bytes" ], "properties": { "asset_id": { "type": "string", "pattern": "^asset_[a-f0-9]{40}$" }, "state": { "type": "string", "enum": [ "staged", "available", "quarantined", "revoked" ] }, "sha256": { "type": [ "string", "null" ], "pattern": "^[a-f0-9]{64}$" }, "actual_bytes": { "type": [ "integer", "null" ] }, "declared_bytes": { "type": "integer", "minimum": 1, "maximum": 1048576 } } } } }, "example": { "ok": true, "data": { "asset_id": "asset_0a5bff155ea09c8a28751a345b874d71a24151d9", "state": "staged", "sha256": null, "actual_bytes": null, "declared_bytes": 209 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "IDEMPOTENCY_CONFLICT", "QUOTA_EXCEEDED" ] } }, "/v1/assets/{asset_id}/content": { "put": { "summary": "Upload the declared PNG (8-bit RGBA, non-interlaced, <=512x512, exact declared size); invalid bytes quarantine the asset", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "image/png": { "schema": { "type": "string", "contentMediaType": "image/png" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "asset_id", "state", "sha256", "actual_bytes", "declared_bytes" ], "properties": { "asset_id": { "type": "string", "pattern": "^asset_[a-f0-9]{40}$" }, "state": { "type": "string", "enum": [ "staged", "available", "quarantined", "revoked" ] }, "sha256": { "type": [ "string", "null" ], "pattern": "^[a-f0-9]{64}$" }, "actual_bytes": { "type": [ "integer", "null" ] }, "declared_bytes": { "type": "integer", "minimum": 1, "maximum": 1048576 } } } } }, "example": { "ok": true, "data": { "asset_id": "asset_0a5bff155ea09c8a28751a345b874d71a24151d9", "state": "available", "sha256": "98d039935ea052be45ae7ecd072856bfa29472b9b9d03630dec74a240f9c80ab", "actual_bytes": 209, "declared_bytes": 209 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "422": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "NOT_FOUND", "IDEMPOTENCY_CONFLICT", "INVALID_MEDIA", "PAYLOAD_TOO_LARGE" ] } }, "/v1/assets/{asset_id}/revoke": { "post": { "summary": "Revoke an available asset (idempotent; metadata and audit kept, never reactivated)", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "revoked" ], "properties": { "revoked": { "const": true } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "NOT_FOUND" ] } }, "/v1/webhooks": { "post": { "summary": "Register an https endpoint for job.succeeded/job.failed events (at most 10 active); the whsec_ signing secret is returned once", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "url" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "url": { "type": "string", "format": "uri", "maxLength": 2048 } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "endpoint_id", "url", "secret" ], "properties": { "endpoint_id": { "type": "string", "pattern": "^whe_[a-f0-9]{32}$" }, "url": { "type": "string" }, "secret": { "type": "string", "pattern": "^whsec_[A-Za-z0-9_-]{43}$" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "LIMIT_EXCEEDED", "WEBHOOKS_UNAVAILABLE" ] }, "get": { "summary": "List webhook endpoints (never the secret)", "parameters": [ { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "endpoint_id", "url", "created_at", "revoked_at" ], "properties": { "endpoint_id": { "type": "string", "pattern": "^whe_[a-f0-9]{32}$" }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "created_at": { "type": "integer" }, "revoked_at": { "type": [ "integer", "null" ] } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "WEBHOOKS_UNAVAILABLE" ] } }, "/v1/webhooks/{endpoint_id}": { "delete": { "summary": "Revoke a webhook endpoint (idempotent, final); pending deliveries to it stop", "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "204": { "description": "No content" }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "NOT_FOUND", "WEBHOOKS_UNAVAILABLE" ] } }, "/v1/drafts": { "post": { "summary": "Save a generation draft (canonical draft_json, at most 64 KiB)", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Admission_DraftInput" }, "example": { "workspace_id": "ws_8c41e2f07d9a4b6c3e5f1a2d", "draft_json": "{\"project\":{\"schema_version\":1,\"workspace_id\":\"ws_8c41e2f07d9a4b6c3e5f1a2d\",\"project_id\":\"clip-1\",\"project_revision\":1,\"shot_revision\":1,\"capabilities_revision\":\"h3\",\"price_version\":\"price-p2-2026-11-02\",\"mode\":\"image_to_video\",\"prompt\":\"The character waves and smiles.\",\"duration_ms\":5083,\"asset_ids\":[\"asset_0a5bff155ea09c8a28751a345b874d71a24151d9\"]},\"character_source\":\"upload\",\"reference_id\":\"asset_0a5bff155ea09c8a28751a345b874d71a24151d9\",\"scene\":\"A sunny park.\",\"confirmed_revision\":1}" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Admission_DraftResult" } } }, "example": { "ok": true, "data": { "schema_version": 1, "simulation_only": false, "input_hash": "e5ca2d216f5fe803a80fc7e0bc8d273c991a7b5920f154b52c481820352da621", "revision": 1 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "REVISION_CONFLICT" ] } }, "/v1/prompts/check": { "post": { "summary": "Check a prompt against H3's official format for its mode (image_to_video = Ref2VA six sections); free, nothing is saved or charged", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "mode", "prompt" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "mode": { "type": "string", "maxLength": 64 }, "prompt": { "type": "string", "maxLength": 10000 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "format", "errors", "warnings" ], "properties": { "format": { "enum": [ "ref2va", "none" ] }, "errors": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "string" } } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED" ] } }, "/v1/prompts/draft": { "post": { "summary": "Turn a description in any language into H3's official prompt with the drafting model. Credits are held first (at most 6), charged by the model's reported token usage (at least 1) and released in full if it fails; idempotency_key replays the same prompt without a second charge", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id", "description", "idempotency_key" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "description": { "type": "string", "minLength": 1, "maxLength": 10000 }, "idempotency_key": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "draft_id", "prompt", "warnings", "reserved_units", "charged_units", "input_tokens", "output_tokens" ], "properties": { "draft_id": { "type": "string" }, "prompt": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } }, "reserved_units": { "type": "integer", "minimum": 1 }, "charged_units": { "type": "integer", "minimum": 1 }, "input_tokens": { "type": [ "integer", "null" ] }, "output_tokens": { "type": [ "integer", "null" ] } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "422": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "INSUFFICIENT_BALANCE", "IDEMPOTENCY_CONFLICT", "DRAFT_IN_PROGRESS", "CONCURRENCY_LIMIT", "DRAFT_LIMIT", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE" ] } }, "/v1/drafts/{project_id}": { "get": { "summary": "Read the stored draft for a project", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Admission_StoredDraftResult" } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "NOT_FOUND" ] } }, "/v1/quotes": { "post": { "summary": "Quote the current draft revision: max_units credits at the published price; nothing is charged until a job is submitted", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Admission_QuoteInput" }, "example": { "workspace_id": "ws_8c41e2f07d9a4b6c3e5f1a2d", "project_id": "clip-1" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Admission_QuoteResult" } } }, "example": { "ok": true, "data": { "schema_version": 1, "simulation_only": false, "unit_version": "credit_v1", "quote_id": "q_179608d31ee72cb8f70f8143bf2084bddcc96588d2be8bffb9954f408547038b", "input_hash": "e5ca2d216f5fe803a80fc7e0bc8d273c991a7b5920f154b52c481820352da621", "max_units": 48, "expires_at": 1700000060000 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "422": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "POLICY_REFUSED", "SAFETY_UNAVAILABLE" ] } }, "/v1/jobs": { "post": { "summary": "Submit a quoted job; command.idempotency_key returns the same job on replay and IDEMPOTENCY_CONFLICT on a different body", "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Admission_SubmitInput" }, "example": { "workspace_id": "ws_8c41e2f07d9a4b6c3e5f1a2d", "command": { "quote_id": "q_179608d31ee72cb8f70f8143bf2084bddcc96588d2be8bffb9954f408547038b", "acknowledged_input_hash": "e5ca2d216f5fe803a80fc7e0bc8d273c991a7b5920f154b52c481820352da621", "user_acknowledged_max_units": 48, "idempotency_key": "job-1" } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Admission_AdmissionResult" } } }, "example": { "ok": true, "data": { "schema_version": 1, "simulation_only": false, "unit_version": "credit_v1", "job_id": "job_b1d54a31977592f27fad9c131ab01a0d27cb9368281acf467f7bf20e5f106fa1", "quote_id": "q_179608d31ee72cb8f70f8143bf2084bddcc96588d2be8bffb9954f408547038b", "input_hash": "e5ca2d216f5fe803a80fc7e0bc8d273c991a7b5920f154b52c481820352da621", "max_units": 48 } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED" ] } }, "/v1/requests/{idempotency_key}": { "get": { "summary": "Read what a submit idempotency key resolved to", "parameters": [ { "name": "idempotency_key", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Admission_AdmissionResult" } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "NOT_FOUND" ] } }, "/v1/jobs/{job_id}": { "get": { "summary": "Read a job snapshot (state, outcome, billing summary, output reference)", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Job_Snapshot" } } }, "example": { "ok": true, "data": { "schema_version": 1, "simulation_only": false, "workspace_id": "ws_8c41e2f07d9a4b6c3e5f1a2d", "job_id": "job_b1d54a31977592f27fad9c131ab01a0d27cb9368281acf467f7bf20e5f106fa1", "input_hash": "e5ca2d216f5fe803a80fc7e0bc8d273c991a7b5920f154b52c481820352da621", "input_revision": 1, "state": "queued", "outcome": "pending", "billing": { "unit_version": "credit_v1", "state": "reserved", "held_units": 48, "charged_units": 0, "compensated_units": 0 }, "model_release": null, "output": null } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "READ_UNAVAILABLE" ] } }, "/v1/jobs/{job_id}/progress": { "get": { "summary": "Read job progress (persisted state; read time is not worker-health proof)", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Progress_ProgressView" } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "READ_UNAVAILABLE" ] } }, "/v1/jobs/{job_id}/provenance": { "get": { "summary": "Read job progress plus the immutable capability and price versions it was quoted under", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Progress_ProvenanceView" } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "READ_UNAVAILABLE" ] } }, "/v1/jobs/{job_id}/billing": { "get": { "summary": "Read the billing state of one job (no inputs, outputs or media)", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Billing_BillingSnapshot" } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "READ_UNAVAILABLE" ] } }, "/v1/jobs/{job_id}/ledger": { "get": { "summary": "Page the immutable ledger entries of one job; cursor is the JSON next_cursor or resume_cursor from a previous page", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048 } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Billing_LedgerPage" } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "READ_UNAVAILABLE" ] } }, "/v1/outputs/{token}": { "get": { "summary": "Download a delivered output through a link from GET /v1/jobs/{job_id}/output (signed, valid 5 minutes; supports one byte range for video players)", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "e", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "s", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [], "requestBody": { "required": true, "content": { "video/mp4": { "schema": { "type": "string", "contentMediaType": "video/mp4" } } } }, "responses": { "200": { "description": "No content" }, "206": { "description": "No content" }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "410": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "416": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "OUTPUT_LINK_INVALID", "OUTPUT_REMOVED", "OUTPUT_EXPIRED", "RANGE_NOT_SATISFIABLE", "RATE_LIMITED" ] } }, "/v1/jobs/{job_id}/output": { "get": { "summary": "Get a short-lived signed download link for the delivered output (private R2 object; the link expires in 5 minutes; outputs are kept 7 days, then 410 OUTPUT_EXPIRED)", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } }, { "name": "workspace_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "required": [ "output_id", "sha256", "url", "expires_at", "simulation_only" ], "properties": { "output_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "url": { "type": "string", "pattern": "^https://" }, "expires_at": { "type": "integer" }, "simulation_only": { "type": "boolean" } } } } }, "example": { "ok": true, "data": { "output_id": "att_9d39daf59fdc7bf59ad48897fedcc79e2a3197f2577743caf4b1ede4ff77ce67", "sha256": "e321869d4433f0d7564be9ef75591dda9a0c23837f19a7113bcd6a33eaea6d73", "url": "https://nikuniku-outputs.ACCOUNT.r2.cloudflarestorage.com/outputs%2Fws_8c41e2f07d9a4b6c3e5f1a2d%2Fjob_7a7f98e7535633ad57b14fe4dce0fa03f502687d5693298800f44760eadfff26%2Fatt_9d39daf59fdc7bf59ad48897fedcc79e2a3197f2577743caf4b1ede4ff77ce67.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=300&X-Amz-Signature=...", "expires_at": 1700000300000, "simulation_only": false } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "410": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "API_KEY_REQUIRED", "DENIED", "READ_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "OUTPUT_REMOVED", "OUTPUT_SIGNING_UNAVAILABLE" ] } }, "/v1/jobs/{job_id}/cancel": { "post": { "summary": "Cancel a job: before a worker claims it the reservation is released (cancelled); after a claim only cancel_requested is recorded. Replays return the current state", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } ], "security": [ { "api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "workspace_id" ], "properties": { "workspace_id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.:-]{0,127}$" } } }, "example": { "workspace_id": "ws_8c41e2f07d9a4b6c3e5f1a2d" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Cancel_CancelResult" } } }, "example": { "ok": true, "data": { "schema_version": 1, "simulation_only": false, "job_id": "job_b1d54a31977592f27fad9c131ab01a0d27cb9368281acf467f7bf20e5f106fa1", "state": "cancelled" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_INPUT", "CAPTCHA_REQUIRED", "CAPTCHA_FAILED", "CAPTCHA_UNAVAILABLE", "EMAIL_NOT_ALLOWED", "LINK_INVALID", "LINK_USED", "LINK_EXPIRED", "TERMS_REQUIRED", "SESSION_INVALID", "CSRF_INVALID", "FORBIDDEN", "SCOPE_EXCEEDED", "ACCOUNT_DISABLED", "KEY_NOT_FOUND", "NOT_FOUND", "METHOD_NOT_ALLOWED", "KEY_REVOKED", "SESSION_CONFLICT", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL", "API_KEY_REQUIRED", "DENIED", "CONCURRENCY_LIMIT", "REQUEST_CLOSED", "REVISION_CONFLICT", "IDEMPOTENCY_CONFLICT", "REQUOTE_REQUIRED", "QUOTE_STALE_OR_MISMATCH", "ASSET_UNAVAILABLE", "CAPABILITY_STALE", "POLICY_UNSUPPORTED", "RELEASE_CATALOG_REQUIRED", "INSUFFICIENT_BALANCE", "BUDGET_DENIED", "BUDGET_EXCEEDED", "PAID_LOT_REQUIRED", "READ_UNAVAILABLE", "CANCEL_UNAVAILABLE", "OUTPUT_UNAVAILABLE", "OUTPUT_EXPIRED", "PAYMENTS_UNAVAILABLE", "UNIT_UNSUPPORTED", "INVALID_SIGNATURE", "OUTPUT_SIGNING_UNAVAILABLE", "EMAIL_NOT_CONFIGURED", "INVALID_MEDIA", "QUOTA_EXCEEDED", "PAYLOAD_TOO_LARGE", "LIMIT_EXCEEDED", "DRAFT_UNUSABLE", "DRAFTING_UNAVAILABLE", "DRAFT_IN_PROGRESS", "DRAFT_LIMIT", "WEBHOOKS_UNAVAILABLE", "POLICY_REFUSED", "SAFETY_UNAVAILABLE", "OUTPUT_LINK_INVALID", "RANGE_NOT_SATISFIABLE", "OUTPUT_REMOVED", "SUBJECT_NOT_FOUND", "OPS_CONFLICT", "REPORT_RESOLVED", "REPORTS_UNAVAILABLE", "ORDER_NOT_REFUNDABLE", "ORDER_NOT_IN_REVIEW", "PAYMENT_MISMATCH", "PAYMENT_NOT_SETTLED", "REFUND_EXCEEDS_UNSPENT", "REFUND_ALREADY_PAID" ] }, "message": { "type": "string" } } } } } } } } }, "x-error-codes": [ "INVALID_INPUT", "UNSUPPORTED_MEDIA_TYPE", "API_KEY_REQUIRED", "DENIED", "CANCEL_UNAVAILABLE" ] } } } }