{ "openapi": "3.1.0", "info": { "title": "web2print.app API", "version": "1", "description": "Templates, prepress and imposition for print shops. Every call is scoped to the workspace that owns the API key or OAuth token. Reference with examples: https://web2print.app/developers/", "contact": { "email": "support@web2print.app" } }, "servers": [ { "url": "https://api.web2print.app" } ], "security": [ { "bearer": [] } ], "tags": [ { "name": "Ping", "externalDocs": { "url": "https://web2print.app/developers/#ping" } }, { "name": "Capabilities", "externalDocs": { "url": "https://web2print.app/developers/#capabilities" } }, { "name": "Account", "externalDocs": { "url": "https://web2print.app/developers/#account" } }, { "name": "Members", "externalDocs": { "url": "https://web2print.app/developers/#members" } }, { "name": "Sessions", "externalDocs": { "url": "https://web2print.app/developers/#sessions" } }, { "name": "Templates", "externalDocs": { "url": "https://web2print.app/developers/#templates" } }, { "name": "Designs", "externalDocs": { "url": "https://web2print.app/developers/#designs" } }, { "name": "Folders", "externalDocs": { "url": "https://web2print.app/developers/#folders" } }, { "name": "Batches", "externalDocs": { "url": "https://web2print.app/developers/#batches" } }, { "name": "Files", "externalDocs": { "url": "https://web2print.app/developers/#files" } }, { "name": "Fonts", "externalDocs": { "url": "https://web2print.app/developers/#fonts" } }, { "name": "Jobs", "externalDocs": { "url": "https://web2print.app/developers/#jobs" } }, { "name": "Queue", "externalDocs": { "url": "https://web2print.app/developers/#queue" } }, { "name": "Actions", "externalDocs": { "url": "https://web2print.app/developers/#actions" } }, { "name": "Barcodes", "externalDocs": { "url": "https://web2print.app/developers/#barcodes" } }, { "name": "Proofs", "externalDocs": { "url": "https://web2print.app/developers/#proofs" } }, { "name": "Colors", "externalDocs": { "url": "https://web2print.app/developers/#colors" } }, { "name": "Impositions", "externalDocs": { "url": "https://web2print.app/developers/#impositions" } }, { "name": "Sheets", "externalDocs": { "url": "https://web2print.app/developers/#sheets" } }, { "name": "Invoices", "externalDocs": { "url": "https://web2print.app/developers/#invoices" } }, { "name": "Transactions", "externalDocs": { "url": "https://web2print.app/developers/#transactions" } }, { "name": "WebhookEndpoints", "externalDocs": { "url": "https://web2print.app/developers/#webhookendpoints" } }, { "name": "Orders", "externalDocs": { "url": "https://web2print.app/developers/#orders" } }, { "name": "MisLinks", "externalDocs": { "url": "https://web2print.app/developers/#mislinks" } } ], "paths": { "/v1/account": { "get": { "tags": [ "Account" ], "operationId": "accountGet", "summary": "Workspace, plan and entitlements", "description": "JSON view: {data: account}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account/inbox": { "patch": { "tags": [ "Account" ], "operationId": "accountPatchInbox", "summary": "Save the workspace's file naming patterns and/or hot folders", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account/limits": { "get": { "tags": [ "Account" ], "operationId": "accountGetLimits", "summary": "Render allowances, storage and seats against the summed licenses", "description": "JSON view: {data: {object: limits, internal, modules:{m:{...}}, storage:{used_gb, max_gb (0 = no limit)}, sessions, members:{used, max (null = no limit)}, over, restricted}}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account/prepress": { "patch": { "tags": [ "Account" ], "operationId": "accountPatchPrepress", "summary": "Save the workspace's backer swatches (adhesive, underbase backers)", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account/storage": { "get": { "tags": [ "Account" ], "operationId": "accountGetStorage", "summary": "Check storage before uploading", "description": "JSON view: 200 {data: {object: storage, used_bytes, max_bytes, free_bytes, adding_bytes, fits: true, max_file_bytes}}; 402 plan_limit (limit.kind storage) when it does not fit; 400 when bytes is not a whole number", "parameters": [ { "name": "bytes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "A plan limit was hit (plan_limit): error.limit says which and by how much.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account/upgrades": { "get": { "tags": [ "Account" ], "operationId": "accountGetUpgrades", "summary": "Prorated upgrade options", "description": "JSON view: {data: {object: upgrades, licenses:[{license, plan, options:[quote]}], can_manage}}", "parameters": [ { "name": "need", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Account" ], "operationId": "accountPostUpgrades", "summary": "Upgrade a license now", "description": "JSON view: 200 {data: {object: upgrade, quote, invoice}}; 402 payment_method_required when money is owed and there is no default bank account or card; 402 payment_error when the charge fails", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "A plan limit was hit (plan_limit): error.limit says which and by how much.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account/usage": { "get": { "tags": [ "Account" ], "operationId": "accountGetUsage", "summary": "Usage for a billing month", "description": "JSON view: {data: usage}", "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/actions": { "get": { "tags": [ "Actions" ], "operationId": "actionsGet", "summary": "List the workspace's actions", "description": "JSON view {data: [prepress_action]}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Actions" ], "operationId": "actionsPost", "summary": "Save a new action", "description": "JSON view 201 {data: prepress_action}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/actions/{uuid}": { "patch": { "tags": [ "Actions" ], "operationId": "actionsPatch", "summary": "Rename an action or replace its steps", "description": "JSON view {data: prepress_action}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Actions" ], "operationId": "actionsDelete", "summary": "Delete an action", "description": "JSON view {data: {id, deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/barcodes": { "get": { "tags": [ "Barcodes" ], "operationId": "barcodesGet", "summary": "The symbologies on offer, or one barcode's state", "description": "JSON view: list {data: [symbology], engine_ready} or {data: barcode}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Barcodes" ], "operationId": "barcodesPost", "summary": "Make a barcode", "description": "JSON view {data: barcode} (status pending)", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/barcodes/{uuid}": { "get": { "tags": [ "Barcodes" ], "operationId": "barcodesGetOne", "summary": "The symbologies on offer, or one barcode's state", "description": "JSON view: list {data: [symbology], engine_ready} or {data: barcode}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches": { "get": { "tags": [ "Batches" ], "operationId": "batchesGet", "summary": "List batches", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "template", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Batches" ], "operationId": "batchesPost", "summary": "Create a batch", "description": "JSON view: 201 {data: batch}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches/{uuid}": { "get": { "tags": [ "Batches" ], "operationId": "batchesGetOne", "summary": "Fetch one batch", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches/{uuid}/archive": { "post": { "tags": [ "Batches" ], "operationId": "batchesPostArchive", "summary": "Ask for the whole batch as one zip", "description": "JSON view: 200|202 {data: batch}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches/{uuid}/cancel": { "post": { "tags": [ "Batches" ], "operationId": "batchesPostCancel", "summary": "Cancel a batch", "description": "JSON view: {data: batch}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches/{uuid}/rows": { "get": { "tags": [ "Batches" ], "operationId": "batchesGetRows", "summary": "Rows of a batch with their status and PDF links", "description": "JSON view: {data: [row], has_more, next}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/capabilities": { "get": { "tags": [ "Capabilities" ], "operationId": "capabilitiesGet", "summary": "What the fleet can do right now", "description": "JSON view: {object: capabilities, engine: {jar, worker, workers}, features: {name: bool}, stacked_steps: bool, text_binding: bool, document: {schema, layers, warps, shapes, fits, anchors, max_layers, max_colors, max_fonts}, checked_at}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/colors": { "get": { "tags": [ "Colors" ], "operationId": "colorsGet", "summary": "One book's colors, or colors matching a search across every book", "description": "JSON view {data: [color]}", "parameters": [ { "name": "book", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Colors" ], "operationId": "colorsPost", "summary": "Add a color to one of the workspace's books", "description": "JSON view 201 {data: color}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/colors/books": { "get": { "tags": [ "Colors" ], "operationId": "colorsGetBooks", "summary": "The color books the workspace can use", "description": "JSON view {data: [{name, shared, count}]}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Colors" ], "operationId": "colorsDeleteBooks", "summary": "Remove one of the workspace's own books and every color in it", "description": "JSON view {data: {removed}}", "parameters": [ { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/colors/books/ase": { "get": { "tags": [ "Colors" ], "operationId": "colorsGetBooksAse", "summary": "One book as an Adobe Swatch Exchange file, built from the library as it is now", "description": "The .ase file, or a JSON error view (400 no book, 404 empty or unknown book)", "parameters": [ { "name": "book", "in": "query", "schema": { "type": "string" } }, { "name": "shared", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/colors/import": { "post": { "tags": [ "Colors" ], "operationId": "colorsPostImport", "summary": "Import an Illustrator swatch export (.ase) or a CSV into a book", "description": "JSON view 201 {data: {book, created, updated, skipped, parsed}}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/colors/{uuid}": { "patch": { "tags": [ "Colors" ], "operationId": "colorsPatch", "summary": "Edit one of the workspace's own colors", "description": "JSON view {data: color}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Colors" ], "operationId": "colorsDelete", "summary": "Remove one of the workspace's own colors", "description": "JSON view {data: {deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs": { "get": { "tags": [ "Designs" ], "operationId": "designsGet", "summary": "List designs", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "template", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Designs" ], "operationId": "designsPost", "summary": "Start a design", "description": "JSON view: 201 {data: design with document}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs/assets": { "get": { "tags": [ "Designs" ], "operationId": "designsGetAssets", "summary": "Fonts, colors and distress patterns for the designer's pickers", "description": "JSON view: {fonts: [...], colors: [...], distress: [...]}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs/barcodes": { "post": { "tags": [ "Designs" ], "operationId": "designsPostBarcodes", "summary": "Draw one barcode layer the way the template will print it", "description": "JSON view: 202 barcode_preview (BarcodePreview::view); 400 bad settings or engine too old", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs/barcodes/{uuid}": { "get": { "tags": [ "Designs" ], "operationId": "designsGetBarcodes", "summary": "One barcode drawing, for the designer's poll", "description": "JSON view: barcode_preview", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs/fonts/{uuid}": { "get": { "tags": [ "Designs" ], "operationId": "designsGetFonts", "summary": "The bytes of one font, so the canvas draws text in the face that will print", "description": "The font file, or a JSON error view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs/{uuid}": { "get": { "tags": [ "Designs" ], "operationId": "designsGetOne", "summary": "Fetch one design with its document", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Designs" ], "operationId": "designsPatch", "summary": "Autosave", "description": "JSON view: {data: design}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Designs" ], "operationId": "designsDelete", "summary": "Delete a design", "description": "JSON view: 204", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "204": { "description": "Done." }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/designs/{uuid}/save": { "post": { "tags": [ "Designs" ], "operationId": "designsPostSave", "summary": "Save as template", "description": "JSON view: 202 {data: {design, job}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files": { "get": { "tags": [ "Files" ], "operationId": "filesGet", "summary": "List files", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "kind", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "mine", "in": "query", "schema": { "type": "string" } }, { "name": "shelf", "in": "query", "schema": { "type": "string" } }, { "name": "batch", "in": "query", "schema": { "type": "string" } }, { "name": "template", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPost", "summary": "Upload an image for image variables", "description": "JSON view: 201|200 {data: file}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}": { "get": { "tags": [ "Files" ], "operationId": "filesGetOne", "summary": "Fetch one file", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/compare": { "get": { "tags": [ "Files" ], "operationId": "filesGetCompare", "summary": "This PDF's earlier versions and, with ?against=, where its comparison with one stands", "description": "JSON {versions: Compare::versions(), comparison: Compare::view()|null}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostCompare", "summary": "Compare a PDF with an earlier version or another PDF", "description": "JSON view: Compare::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/cuts": { "get": { "tags": [ "Files" ], "operationId": "filesGetCuts", "summary": "The newest cut file of a PDF, for the cutting table or plotter", "description": "JSON view: CutFiles::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostCuts", "summary": "Make a cut file for a PDF", "description": "JSON view: CutFiles::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/films": { "get": { "tags": [ "Files" ], "operationId": "filesGetFilms", "summary": "The newest film set of a PDF, for Output films", "description": "JSON view: Films::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostFilms", "summary": "Make a film set for a PDF", "description": "JSON view: Films::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/objects": { "get": { "tags": [ "Files" ], "operationId": "filesGetObjects", "summary": "Where the lift of a placed PDF stands", "description": "JSON view: ArtObjects::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "with_text", "in": "query", "schema": { "type": "string" } }, { "name": "object_gap", "in": "query", "schema": { "type": "string" } }, { "name": "vectorize", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostObjects", "summary": "Lift a placed PDF's shapes for Explode", "description": "JSON view: ArtObjects::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/preflight": { "get": { "tags": [ "Files" ], "operationId": "filesGetPreflight", "summary": "The engine's full preflight report of a PDF, verbatim", "description": "JSON view: Preflight::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "positive_pt", "in": "query", "schema": { "type": "string" } }, { "name": "negative_pt", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostPreflight", "summary": "Make the engine's full preflight report of a PDF: everything downstream production reads, as the engine writes it (document name, size, Illustrator variables; per page the boxes, colour families, process and spot colours with CMYK and coverage, fonts, raster images and minimum effective DPI, live text / vector / raster flags)", "description": "JSON view: Preflight::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/separations": { "get": { "tags": [ "Files" ], "operationId": "filesGetSeparations", "summary": "The plates of a PDF, for the Separation Preview", "description": "JSON view: Separations::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostSeparations", "summary": "Start the plates of a PDF", "description": "JSON view: Separations::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/files/{uuid}/softproof": { "get": { "tags": [ "Files" ], "operationId": "filesGetSoftproof", "summary": "Where a soft proof of a PDF stands", "description": "JSON view: SoftProof::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Files" ], "operationId": "filesPostSoftproof", "summary": "Start a soft proof of a PDF", "description": "JSON view: SoftProof::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/folders": { "get": { "tags": [ "Folders" ], "operationId": "foldersGet", "summary": "The folder tree", "description": "JSON view {data: [folder], has_more: false}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Folders" ], "operationId": "foldersPost", "summary": "Create a folder", "description": "JSON view 201 {data: folder}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/folders/{uuid}": { "patch": { "tags": [ "Folders" ], "operationId": "foldersPatch", "summary": "Rename or move a folder", "description": "JSON view {data: folder}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Folders" ], "operationId": "foldersDelete", "summary": "Delete a folder", "description": "JSON view {data: {id, deleted: true, moved_templates, moved_folders}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/fonts": { "get": { "tags": [ "Fonts" ], "operationId": "fontsGet", "summary": "List fonts", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Fonts" ], "operationId": "fontsPost", "summary": "Upload fonts", "description": "JSON view: 201 {data: [{file, font|error}]}, or 400 error", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/fonts/{uuid}": { "get": { "tags": [ "Fonts" ], "operationId": "fontsGetOne", "summary": "Fetch one font", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/fonts/{uuid}/disable": { "post": { "tags": [ "Fonts" ], "operationId": "fontsPostDisable", "summary": "Disable a font", "description": "JSON view: {data: font}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/fonts/{uuid}/enable": { "post": { "tags": [ "Fonts" ], "operationId": "fontsPostEnable", "summary": "Enable a font again", "description": "JSON view: {data: font}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions": { "get": { "tags": [ "Impositions" ], "operationId": "impositionsGet", "summary": "List impositions", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Impositions" ], "operationId": "impositionsPost", "summary": "Start an imposition", "description": "JSON view 201 {data: imposition (full)}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}": { "get": { "tags": [ "Impositions" ], "operationId": "impositionsGetOne", "summary": "Fetch one imposition in full", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}/approve": { "post": { "tags": [ "Impositions" ], "operationId": "impositionsPostApprove", "summary": "Approve and compose the sheets", "description": "JSON view {data: imposition (full)}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}/cancel": { "post": { "tags": [ "Impositions" ], "operationId": "impositionsPostCancel", "summary": "Cancel an imposition", "description": "JSON view {data: imposition (full)}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}/layout": { "patch": { "tags": [ "Impositions" ], "operationId": "impositionsPatchLayout", "summary": "Save edited sheets", "description": "JSON view {data: imposition (full)}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}/repack": { "post": { "tags": [ "Impositions" ], "operationId": "impositionsPostRepack", "summary": "Work an auto imposition out again with changed settings", "description": "JSON view {data: imposition (full)}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}/roam": { "post": { "tags": [ "Impositions" ], "operationId": "impositionsPostRoam", "summary": "ROAM one sheet of the imposition: every plate of the whole run, before approving", "description": "JSON view: Plans::roam()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/impositions/{uuid}/strategy": { "post": { "tags": [ "Impositions" ], "operationId": "impositionsPostStrategy", "summary": "Pick a strategy", "description": "JSON view {data: imposition (full)}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/invoices": { "get": { "tags": [ "Invoices" ], "operationId": "invoicesGet", "summary": "List invoices", "description": "JSON: the list {data: [invoice], has_more, next}, or {data: invoice + line_items, transactions}; 403 for members, 404 unknown id", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/invoices/{uuid}": { "get": { "tags": [ "Invoices" ], "operationId": "invoicesGetOne", "summary": "Fetch one invoice invoice", "description": "JSON: the list {data: [invoice], has_more, next}, or {data: invoice + line_items, transactions}; 403 for members, 404 unknown id", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/jdf": { "post": { "tags": [ "Orders" ], "operationId": "ordersPost", "summary": "File a JDF ticket as an order", "description": "JSON view 201 {data: order}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/jobs": { "get": { "tags": [ "Jobs" ], "operationId": "jobsGet", "summary": "List jobs", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "lane", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/jobs/{uuid}": { "get": { "tags": [ "Jobs" ], "operationId": "jobsGetOne", "summary": "Fetch one job", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/jobs/{uuid}/cancel": { "post": { "tags": [ "Jobs" ], "operationId": "jobsPostCancel", "summary": "Cancel a job", "description": "JSON view: {data: job}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members": { "get": { "tags": [ "Members" ], "operationId": "membersGet", "summary": "List everyone on the workspace", "description": "JSON view: {data: [member], has_more, next, seats: {used, max}, can_manage, roles: [{key, name}] (what the role menus offer), require_two_step}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Members" ], "operationId": "membersPost", "summary": "Invite someone", "description": "JSON view: 201 {data: member}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members/roles": { "get": { "tags": [ "Members" ], "operationId": "membersGetRoles", "summary": "Every role on the workspace", "description": "JSON view: {object: list, data: [{key, name, perms[], summary, builtin, people}], permissions: [{key, label}], you: {role, perms[]}}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Members" ], "operationId": "membersPostRoles", "summary": "Add a custom role", "description": "JSON view: 201 {data: role}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members/roles/{key}": { "patch": { "tags": [ "Members" ], "operationId": "membersPatchRoles", "summary": "Change a custom role (name and/or permissions)", "description": "JSON view: {data: role}", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Members" ], "operationId": "membersDeleteRoles", "summary": "Delete a custom role", "description": "JSON view: {data: {object: role, key, deleted: true}}", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members/security": { "patch": { "tags": [ "Members" ], "operationId": "membersPatchSecurity", "summary": "Workspace sign-in rules", "description": "JSON view: {data: {object: sign_in_rules, require_two_step, people_with_two_step, people}}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members/{uuid}": { "patch": { "tags": [ "Members" ], "operationId": "membersPatch", "summary": "Change someone's role, or their home site", "description": "JSON view: {data: member}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Members" ], "operationId": "membersDelete", "summary": "Remove someone from the workspace", "description": "JSON view: {data: {object: member, id, deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members/{uuid}/2fa": { "delete": { "tags": [ "Members" ], "operationId": "membersDelete2fa", "summary": "Turn off someone's two-step sign-in", "description": "JSON view: {data: member}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/members/{uuid}/resend": { "post": { "tags": [ "Members" ], "operationId": "membersPostResend", "summary": "Resend an invite", "description": "JSON view: {data: member}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/mis-links": { "get": { "tags": [ "MisLinks" ], "operationId": "misLinksGet", "summary": "List the workspace's MIS links, or one", "description": "JSON view {data: mis_link} or {data: [mis_link]}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "MisLinks" ], "operationId": "misLinksPost", "summary": "Add an MIS link", "description": "JSON view 201 {data: mis_link}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/mis-links/{uuid}": { "get": { "tags": [ "MisLinks" ], "operationId": "misLinksGetOne", "summary": "List the workspace's MIS links, or one", "description": "JSON view {data: mis_link} or {data: [mis_link]}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "MisLinks" ], "operationId": "misLinksPatch", "summary": "Change an MIS link", "description": "JSON view {data: mis_link}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "MisLinks" ], "operationId": "misLinksDelete", "summary": "Remove an MIS link", "description": "JSON view {data: {id, object: mis_link, deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/mis-links/{uuid}/test": { "post": { "tags": [ "MisLinks" ], "operationId": "misLinksPostTest", "summary": "Send a test signal now", "description": "JSON view {data: {ok, http_code, error, body}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/orders": { "get": { "tags": [ "Orders" ], "operationId": "ordersGet", "summary": "List the workspace's orders, or one", "description": "JSON view {data: order} or paged {data: [order], has_more, next}", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "job_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/orders/{uuid}": { "get": { "tags": [ "Orders" ], "operationId": "ordersGetOne", "summary": "List the workspace's orders, or one", "description": "JSON view {data: order} or paged {data: [order], has_more, next}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/ping": { "get": { "tags": [ "Ping" ], "operationId": "pingGet", "summary": "Check the key works and the API is reachable", "description": "JSON: {data: {object: \"ping\", time (ISO-8601 UTC), workspace: {id, name}}}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs": { "get": { "tags": [ "Proofs" ], "operationId": "proofsGet", "summary": "List proofs, or get one", "description": "JSON view {data: proof} or {data: [proof], has_more, next}", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "all", "in": "query", "schema": { "type": "string" } }, { "name": "item", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Proofs" ], "operationId": "proofsPost", "summary": "Send a proof", "description": "JSON view 201 {data: proof + links: [{reviewer, name, email, url, invite}]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}": { "get": { "tags": [ "Proofs" ], "operationId": "proofsGetOne", "summary": "List proofs, or get one", "description": "JSON view {data: proof} or {data: [proof], has_more, next}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}/annotations": { "post": { "tags": [ "Proofs" ], "operationId": "proofsPostAnnotations", "summary": "Comment on the proof as the shop", "description": "JSON view 201 {data: annotation}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}/annotations/{aid}/resolve": { "post": { "tags": [ "Proofs" ], "operationId": "proofsPostAnnotationsResolve", "summary": "Resolve a comment", "description": "JSON view {data: annotation}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Proofs" ], "operationId": "proofsDeleteAnnotationsResolve", "summary": "Open a resolved comment again", "description": "JSON view {data: annotation}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}/cancel": { "post": { "tags": [ "Proofs" ], "operationId": "proofsPostCancel", "summary": "Withdraw a pending proof", "description": "JSON view {data: proof}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}/resend": { "post": { "tags": [ "Proofs" ], "operationId": "proofsPostResend", "summary": "Mail the open step's reviewers again", "description": "JSON view {data: {links: [...]}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}/reviewers/{rid}/link": { "post": { "tags": [ "Proofs" ], "operationId": "proofsPostReviewersLink", "summary": "A fresh link for one reviewer, to paste into a message", "description": "JSON view {data: {reviewer, name, email, url}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/proofs/{uuid}/versions": { "post": { "tags": [ "Proofs" ], "operationId": "proofsPostVersions", "summary": "Send a new version", "description": "JSON view 201 {data: proof + links}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue": { "get": { "tags": [ "Queue" ], "operationId": "queueGet", "summary": "List an inbox", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "count", "in": "query", "schema": { "type": "string" } }, { "name": "stage", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "site", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "unmapped", "in": "query", "schema": { "type": "string" } }, { "name": "backers", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Queue" ], "operationId": "queuePost", "summary": "Add a file to an inbox", "description": "JSON view 201 {data: [queue_item]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/action": { "post": { "tags": [ "Queue" ], "operationId": "queuePostAction", "summary": "Run a saved Prepress action on an item's PDF: its steps run one after another, each billed like the same tool applied by hand", "description": "JSON view 202 {data: queue_item}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/combine": { "post": { "tags": [ "Queue" ], "operationId": "queuePostCombine", "summary": "Combine several Prepress items into one PDF, pages in the order given (free)", "description": "JSON view 202 {data: [queue_item]} the source items, the first carrying the job state", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/done": { "post": { "tags": [ "Queue" ], "operationId": "queuePostDone", "summary": "Mark Prepress items done", "description": "JSON view {data: [queue_item]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/move": { "post": { "tags": [ "Queue" ], "operationId": "queuePostMove", "summary": "Bulk send-to", "description": "JSON view {data: [queue_item]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/patterns": { "post": { "tags": [ "Queue" ], "operationId": "queuePostPatterns", "summary": "Try naming patterns on the waiting inbox without saving them", "description": "JSON view {patterns[{pattern, error, fields[]}], rows[{name, pattern, fields}], mapped, unmapped}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/preflight": { "get": { "tags": [ "Queue" ], "operationId": "queueGetPreflight", "summary": "The workspace's preflight profiles", "description": "JSON view {data: [{id, name, rules{}, created_at}], default: id|null, can_edit}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Queue" ], "operationId": "queuePostPreflight", "summary": "Save the workspace's preflight profiles (the whole list, in order) and the default", "description": "JSON view {data: profiles[], default: id|null}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/remap": { "post": { "tags": [ "Queue" ], "operationId": "queuePostRemap", "summary": "Run the workspace's naming patterns again over waiting items", "description": "JSON view {items, mapped, unmapped}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/reopen": { "post": { "tags": [ "Queue" ], "operationId": "queuePostReopen", "summary": "Put done Prepress items back in the inbox", "description": "JSON view {data: [queue_item]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/rules": { "get": { "tags": [ "Queue" ], "operationId": "queueGetRules", "summary": "The workspace's inbox rules and what the rule editor can offer", "description": "JSON view {data: rules[], choices: {actions[{id,name}], people[{id,name}], hot_folders[{id,name,stage}], fields[], profiles[{id,name}] (preflight profiles)}, can_edit}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Queue" ], "operationId": "queuePostRules", "summary": "Save the workspace's inbox rules (the whole list, in order)", "description": "JSON view {data: rules[]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/rules/preview": { "post": { "tags": [ "Queue" ], "operationId": "queuePostRulesPreview", "summary": "Which waiting files one draft rule matches right now (nothing is done)", "description": "JSON view {object: rule_preview, count, items[{id, name}], checked}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/tags": { "post": { "tags": [ "Queue" ], "operationId": "queuePostTags", "summary": "Bulk tag: add or remove free tags and set fields on many items at once", "description": "JSON view {data: [queue_item]}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}": { "get": { "tags": [ "Queue" ], "operationId": "queueGetOne", "summary": "Fetch one inbox item", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Queue" ], "operationId": "queuePatch", "summary": "Edit an item, or send it to the other inbox", "description": "JSON view {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Queue" ], "operationId": "queueDelete", "summary": "Remove an item from its inbox (the file itself stays in Files)", "description": "JSON view {data: {id, removed: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/action": { "post": { "tags": [ "Queue" ], "operationId": "queuePostActionOne", "summary": "Run a saved Prepress action on an item's PDF: its steps run one after another, each billed like the same tool applied by hand", "description": "JSON view 202 {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/check": { "post": { "tags": [ "Queue" ], "operationId": "queuePostCheck", "summary": "Start the free preflight check of an item's PDF", "description": "JSON view {data: prepress_check}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Queue" ], "operationId": "queueGetCheck", "summary": "Poll the preflight check of an item's PDF", "description": "JSON view {data: prepress_check}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profile", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/claim": { "post": { "tags": [ "Queue" ], "operationId": "queuePostClaim", "summary": "Claim (or renew) an item", "description": "JSON view {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Queue" ], "operationId": "queueDeleteClaim", "summary": "Release a claim", "description": "JSON view {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/match": { "post": { "tags": [ "Queue" ], "operationId": "queuePostMatch", "summary": "Match the spot inks of an item's PDF to a color book (free)", "description": "JSON view {data: color_match} (see ColorMatch::view), 400 when the book is empty", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Queue" ], "operationId": "queueGetMatch", "summary": "Poll the color book match of an item's PDF", "description": "JSON view {data: color_match}; ?book=&max_de= picks the run (no book given: the newest)", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "book", "in": "query", "schema": { "type": "string" } }, { "name": "max_de", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/press": { "post": { "tags": [ "Queue" ], "operationId": "queuePostPress", "summary": "Start the free press check of an item's PDF: ink coverage per plate, and thin lines and gaps against the limits given", "description": "JSON view {data: press_check} (see PressCheck::view), 400 on a bad limit", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Queue" ], "operationId": "queueGetPress", "summary": "Poll the press check of an item's PDF", "description": "JSON view {data: press_check}; ?line_pt=&gap_pt= picks the thin-line run (else the newest)", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "line_pt", "in": "query", "schema": { "type": "string" } }, { "name": "gap_pt", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/recolor": { "post": { "tags": [ "Queue" ], "operationId": "queuePostRecolor", "summary": "Change spot inks of an item's PDF (the item counts against the plan once, on its first billed change; later changes are free)", "description": "JSON view 202 {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/retype/art": { "post": { "tags": [ "Queue" ], "operationId": "queuePostRetypeArt", "summary": "Lift the item's vector shapes so the Retype room can draw them and snap the box to the letters it contains (the designer's lift, free, one per file)", "description": "JSON view art_objects", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Queue" ], "operationId": "queueGetRetypeArt", "summary": "Poll the lift of the item's shapes", "description": "JSON view art_objects", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/retype/try": { "post": { "tags": [ "Queue" ], "operationId": "queuePostRetypeTry", "summary": "Start (or reuse) a free retype try on a vector item: what \"Retype\" would remove inside the box and the outlines of the text it would set", "description": "JSON view retype_try", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Queue" ], "operationId": "queueGetRetypeTry", "summary": "Poll a retype try (?key= from the POST)", "description": "JSON view retype_try", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/revert": { "post": { "tags": [ "Queue" ], "operationId": "queuePostRevert", "summary": "Put an item back on the file it had before its last Prepress change", "description": "JSON view {data: queue_item}; with pages: {data: {object: list, data: [restored queue_item], removed: [uuid]}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/split": { "post": { "tags": [ "Queue" ], "operationId": "queuePostSplit", "summary": "Split an item's PDF into one item per page (free)", "description": "JSON view 202 {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/tool": { "post": { "tags": [ "Queue" ], "operationId": "queuePostTool", "summary": "Apply one Prepress tool to an item's file (the item counts against the plan once, on its first billed change; later changes are free)", "description": "JSON view 202 {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/vectorize": { "post": { "tags": [ "Queue" ], "operationId": "queuePostVectorize", "summary": "Turn an image item into a vector PDF with the chosen settings (one billed page)", "description": "JSON view 202 {data: queue_item}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/queue/{uuid}/vectorize/try": { "post": { "tags": [ "Queue" ], "operationId": "queuePostVectorizeTry", "summary": "Try a vectorize on an image item, free", "description": "JSON view vectorize_try", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Queue" ], "operationId": "queueGetVectorizeTry", "summary": "Poll a vectorize try (?key= from the POST)", "description": "JSON view vectorize_try", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sessions": { "get": { "tags": [ "Sessions" ], "operationId": "sessionsGet", "summary": "List sessions", "description": "JSON view", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Sessions" ], "operationId": "sessionsPost", "summary": "Open a session", "description": "JSON view: 201 {data: session} (taken_over: true when a seat was taken)", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sessions/{uuid}": { "get": { "tags": [ "Sessions" ], "operationId": "sessionsGetOne", "summary": "Fetch one session", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Sessions" ], "operationId": "sessionsDelete", "summary": "Close a session", "description": "JSON view: {data: session}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sessions/{uuid}/heartbeat": { "post": { "tags": [ "Sessions" ], "operationId": "sessionsPostHeartbeat", "summary": "Heartbeat", "description": "JSON view: {data: session}; 409 conflict {reason: taken_over|ended, by?: name, by_me?: bool}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sheets": { "get": { "tags": [ "Sheets" ], "operationId": "sheetsGet", "summary": "Presets and saved sheets", "description": "JSON view {data: [sheet], presets: [preset], engine: {pack_rules, nest, nest_cut_art}}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Sheets" ], "operationId": "sheetsPost", "summary": "Save a new sheet", "description": "JSON view 201 {data: sheet}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sheets/layout": { "post": { "tags": [ "Sheets" ], "operationId": "sheetsPostLayout", "summary": "Lay sample pieces out on a sheet without saving anything", "description": "JSON view {data: {spec, area, layout, marks}}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sheets/{uuid}": { "patch": { "tags": [ "Sheets" ], "operationId": "sheetsPatch", "summary": "Edit a sheet", "description": "JSON view {data: sheet}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Sheets" ], "operationId": "sheetsDelete", "summary": "Delete a sheet", "description": "JSON view {data: {id, deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates": { "get": { "tags": [ "Templates" ], "operationId": "templatesGet", "summary": "List templates", "description": "JSON view: {data: template} or {data: [template], has_more, next}", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "folder", "in": "query", "schema": { "type": "string" } }, { "name": "deep", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Templates" ], "operationId": "templatesPost", "summary": "Upload a new template", "description": "JSON view: 201 {data: template}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/sample": { "post": { "tags": [ "Templates" ], "operationId": "templatesPostSample", "summary": "Add the bundled sample template (a 3.5x2 in business card with four text variables, Liberation Sans, two spot colors) to the bound tenant's library", "description": "JSON view: 201 {data: template}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}": { "get": { "tags": [ "Templates" ], "operationId": "templatesGetOne", "summary": "Fetch one template", "description": "JSON view: {data: template} or {data: [template], has_more, next}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Templates" ], "operationId": "templatesPatch", "summary": "Rename a template, move it to a folder, or set where its runs go", "description": "JSON view: {data: template}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Templates" ], "operationId": "templatesDelete", "summary": "Delete a template (soft)", "description": "JSON view: {data: {id, deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/download": { "get": { "tags": [ "Templates" ], "operationId": "templatesGetDownload", "summary": "Download links for a template version's own files", "description": "JSON view: {data: {object: template_download, version, original: file|null, pdf: file|null}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/package": { "post": { "tags": [ "Templates" ], "operationId": "templatesPostPackage", "summary": "Build, or hand out, the relinked Illustrator package of a version", "description": "200 {data: {object: template_package, version, file}} | 202 {data: job}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/previews": { "post": { "tags": [ "Templates" ], "operationId": "templatesPostPreviews", "summary": "Render a live preview of the template with the given values", "description": "JSON view: 200|202 {data: job}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/text": { "get": { "tags": [ "Templates" ], "operationId": "templatesGetText", "summary": "The live text of an Illustrator master, story by story, so an integration can make variables of text the designer never bound (`--list-text`)", "description": "JSON view: TextStories::view()", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/text/bind": { "post": { "tags": [ "Templates" ], "operationId": "templatesPostTextBind", "summary": "Bind text stories of an Illustrator master to variables, as the designer's Variables panel would, and file the result as the template's next version (`--bind-variables`)", "description": "JSON view: 202 TextStories::bindView(); body {bindings: [{id, key}], version?: int (default current), wait?}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/variables": { "patch": { "tags": [ "Templates" ], "operationId": "templatesPatchVariables", "summary": "Change how one variable of the template's current version is labeled and how its values sit in their frames", "description": "JSON view: {data: variable}; body {name: variable name, label?: string 1-80, fit?: contain|shrink|cover|null, anchor?: left|center|right|null, represents?: {w, h} inches | \"W x H\" | null}; null = the default (contain, center, the frame stands for nothing). represents is for image fields only: the physical area the frame stands for, so an image is placed at its real size inside it (ADD-LIST 27)", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Templates" ], "operationId": "templatesGetVariables", "summary": "Variables of the template's current version", "description": "JSON view: {data: [variable]}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/versions": { "get": { "tags": [ "Templates" ], "operationId": "templatesGetVersions", "summary": "List a template's versions", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Templates" ], "operationId": "templatesPostVersions", "summary": "Upload a new version of an existing template (same body as POST /v1/templates)", "description": "JSON view: 201|200 {data: template_version}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/versions/{n}": { "get": { "tags": [ "Templates" ], "operationId": "templatesGetVersionsOne", "summary": "Fetch one version by number", "description": "JSON view", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "n", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/templates/{uuid}/versions/{n}/restore": { "post": { "tags": [ "Templates" ], "operationId": "templatesPostVersionsRestore", "summary": "Make an earlier (or later) ready version the template's current one again", "description": "JSON view: {data: template}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "n", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "transactionsGet", "summary": "List payments", "description": "JSON: the list {data: [transaction], has_more, next}, or {data: transaction}; 403 for members, 404 unknown id", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/transactions/{uuid}": { "get": { "tags": [ "Transactions" ], "operationId": "transactionsGetOne", "summary": "Fetch one payment payment", "description": "JSON: the list {data: [transaction], has_more, next}, or {data: transaction}; 403 for members, 404 unknown id", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "The request is invalid (invalid_request_error).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, or the workspace lacks the app (app_not_enabled).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints": { "get": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsGet", "summary": "List the workspace's endpoints, or one", "description": "JSON view {data: [webhook_endpoint]} or {data: webhook_endpoint}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsPost", "summary": "Add an endpoint", "description": "JSON view 201 {data: webhook_endpoint + secret}", "parameters": [ { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints/events": { "get": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsGetEvents", "summary": "The event catalog", "description": "JSON list {data: [{object: webhook_event_type, type, group, description}], has_more: false}", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints/{uuid}": { "get": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsGetOne", "summary": "List the workspace's endpoints, or one", "description": "JSON view {data: [webhook_endpoint]} or {data: webhook_endpoint}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsPatch", "summary": "Change an endpoint", "description": "JSON view {data: webhook_endpoint}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsDelete", "summary": "Remove an endpoint with its delivery history", "description": "JSON view {data: {id, object, deleted: true}}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints/{uuid}/deliveries": { "get": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsGetDeliveries", "summary": "Recent deliveries to an endpoint", "description": "JSON view {data: [webhook_delivery], has_more, next}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/after" }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints/{uuid}/resend": { "post": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsPostResend", "summary": "Send a delivery again", "description": "JSON view 202 {data: webhook_delivery}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints/{uuid}/secret": { "post": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsPostSecret", "summary": "Replace the signing secret", "description": "JSON view {data: webhook_endpoint + secret}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook-endpoints/{uuid}/test": { "post": { "tags": [ "WebhookEndpoints" ], "operationId": "webhookEndpointsPostTest", "summary": "Send a test event to this endpoint", "description": "JSON view 202 {data: webhook_delivery}", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idempotency" }, { "$ref": "#/components/parameters/wait" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } }, "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "401": { "description": "Missing, unknown or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict with the object's state, or an Idempotency-Key reused with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (rate_limited, or rate_limited_over_usage in restricted mode). Retry after Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "A secret API key (sk_...) from Settings, API, or an OAuth 2.1 access token." } }, "schemas": { "Object": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object" } } }, "List": { "type": "object", "required": [ "data", "has_more" ], "properties": { "data": { "type": "array", "items": { "type": "object" } }, "has_more": { "type": "boolean" }, "next": { "type": [ "string", "null" ], "description": "Pass as after= for the next page." } } }, "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "type" ], "additionalProperties": true, "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "limit": { "type": "object", "description": "On 402 plan_limit: kind, used, allowed, unit." } } } } } }, "parameters": { "limit": { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, "after": { "name": "after", "in": "query", "description": "The next value of the previous page.", "schema": { "type": "string" } }, "idempotency": { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "maxLength": 128 }, "description": "Repeat a request safely: the same key with the same request returns the first response." }, "wait": { "name": "wait", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 30000 }, "description": "Synchronous option: hold the response until every job this request starts is final, up to this many milliseconds (at most 30000; also accepted as a JSON body field). 200 with the finished object when they finished, 202 with the object still pending when the time ran out (poll GET /v1/jobs/:uuid). 503 with Retry-After when this server cannot hold another waiting request; nothing was started. Set your client timeout above the wait you ask for." } } } }