{ "openapi": "3.0.3", "info": { "title": "Source Image Finder API", "version": "1.3.0", "description": "Single Page, exact-URL Multiple URLs, and Business/Scale Store Catalog processing. API v1.3 adds bearer-authenticated catalog preview, selected-product jobs, status, retry, cancellation and organized ZIP downloads. The v1.2 ZIP receipt and failed-file retry interface and all earlier /api/v1 endpoints remain available. Processing costs 2 credits for a successful webpage or successful catalog product; failed catalog products are uncharged. No completion webhooks." }, "servers": [ { "url": "https://sourceimagefinder.com/api/v1", "description": "Deployed site" }, { "url": "http://127.0.0.1:8787/api/v1", "description": "Local development" } ], "paths": { "/usage": { "get": { "summary": "Read shared account credits and limits", "operationId": "getUsage", "description": "Requires the jobs:read permission.", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usage" } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/jobs": { "post": { "summary": "Start a paid Single Page scan", "operationId": "createJob", "description": "Requires the jobs:write permission.", "security": [ { "ApiKey": [] } ], "responses": { "202": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Location": { "schema": { "type": "string" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "New UUID per new processing request; reuse for retries. Successful receipts retained for 24 hours. Never switch keys after an uncertain submission.", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 4096 } }, "required": [ "url" ], "additionalProperties": false } } } } } }, "/bulk": { "post": { "summary": "Start a paid Multiple URLs run", "operationId": "createBulkRun", "description": "Requires the jobs:write permission.", "security": [ { "ApiKey": [] } ], "responses": { "202": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Location": { "schema": { "type": "string" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "New UUID per new processing request; reuse for retries. Successful receipts retained for 24 hours. Never switch keys after an uncertain submission.", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "urls": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "string", "format": "uri", "maxLength": 4096 } } }, "required": [ "urls" ], "additionalProperties": false } } } } } }, "/bulk/{id}": { "get": { "summary": "Read a Multiple URLs run, URLs, and page jobs", "operationId": "getBulkRun", "description": "Requires jobs:read. Each ordered job entry includes its requested webpage URL.", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "$ref": "#/components/schemas/BulkRun" } }, "required": [ "run" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/jobs/{id}": { "get": { "summary": "Read job status", "operationId": "getJob", "description": "Requires the jobs:read permission.", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "job": { "$ref": "#/components/schemas/Job" } }, "required": [ "job" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/jobs/{id}/results": { "get": { "summary": "Read completed image metadata", "operationId": "getJobResults", "description": "Requires the jobs:read permission.", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Results" } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } }, { "name": "scope", "in": "query", "description": "Result set. useful excludes site-ui and review-media and is the default; all returns every detected asset.", "schema": { "type": "string", "enum": [ "useful", "all" ], "default": "useful" } } ] } }, "/jobs/{id}/cancel": { "post": { "summary": "Cancel an unfinished job", "operationId": "cancelJob", "description": "Requires the jobs:write permission.", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "job": { "$ref": "#/components/schemas/Job" } }, "required": [ "job" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/jobs/{id}/zip": { "post": { "summary": "Download original useful or selected images", "operationId": "downloadZip", "description": "Requires the downloads:read permission. Every successful ZIP response supplies X-SIF-Download-ID and X-SIF-Download-Status headers. Poll GET /downloads/{id} with the same account and downloads:read scope to verify completeness and POST /downloads/{id}/retry with {} to retry failed image files (no additional processing credits).", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "ZIP archive. Review media is excluded; site UI is excluded unless explicitly selected. A source failure report may be included. Split large downloads using image_ids.", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "X-SIF-Download-ID": { "description": "Server-generated ZIP receipt UUID, valid for 30 minutes after the most recent receipt update (in-memory, lost on server restart).", "schema": { "type": "string", "format": "uuid" } }, "X-SIF-Download-Status": { "description": "Relative URL of the bearer-authenticated ZIP receipt status endpoint.", "schema": { "type": "string" } } }, "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "image_ids": { "type": "array", "minItems": 1, "maxItems": 10000, "items": { "type": "string", "maxLength": 4096 } } }, "required": [], "additionalProperties": false } } } } } }, "/bulk/{id}/cancel": { "post": { "summary": "Cancel unfinished pages in a Multiple URLs run", "operationId": "cancelBulkRun", "description": "Requires jobs:write. Completed pages remain available.", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Run cancellation requested", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "$ref": "#/components/schemas/BulkRun" }, "cancel_failures": { "type": "integer", "minimum": 0 } }, "required": [ "run", "cancel_failures" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/bulk/{id}/retry-failed": { "post": { "summary": "Retry failed pages in a Multiple URLs run", "operationId": "retryFailedBulkRun", "description": "Requires jobs:write. The run must be terminal. Retried pages consume credits only when processing succeeds.", "security": [ { "ApiKey": [] } ], "responses": { "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "202": { "description": "Retry accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "$ref": "#/components/schemas/BulkRun" }, "retried": { "type": "integer", "minimum": 1 } }, "required": [ "run", "retried" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/bulk/{id}/retry-unfinished": { "post": { "summary": "Retry failed or cancelled pages in a Multiple URLs run", "operationId": "retryUnfinishedBulkRun", "description": "Requires jobs:write. The run must be terminal. Retried pages consume credits only when processing succeeds.", "security": [ { "ApiKey": [] } ], "responses": { "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "202": { "description": "Retry accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "$ref": "#/components/schemas/BulkRun" }, "retried": { "type": "integer", "minimum": 1 } }, "required": [ "run", "retried" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/bulk/{id}/zip": { "post": { "summary": "Download completed Multiple URLs pages together", "operationId": "downloadBulkRunZip", "description": "Requires downloads:read. The run must be terminal. Select completed page jobs with job_ids or omit job_ids to include all completed pages. If the export requires multiple ZIP files, a 409 download_split_required error returns details.parts; repeat the request with part set to 1 through that count. Every successful ZIP response supplies X-SIF-Download-ID and X-SIF-Download-Status headers. Poll GET /downloads/{id} with the same account and downloads:read scope to verify completeness and POST /downloads/{id}/retry with {} to retry failed image files (no additional processing credits).", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "ZIP file", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-SIF-Download-ID": { "description": "Server-generated ZIP receipt UUID, valid for 30 minutes after the most recent receipt update (in-memory, lost on server restart).", "schema": { "type": "string", "format": "uuid" } }, "X-SIF-Download-Status": { "description": "Relative URL of the bearer-authenticated ZIP receipt status endpoint.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked, or expired API key", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient credits or payment requires attention", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope or paid plan required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource missing or belongs to another account", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Work active, job not ready, conflicting retry, or incomplete submission", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Result expired", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request or download too large", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON content type required", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; obey Retry-After", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service temporarily unavailable", "headers": { "X-Request-ID": { "description": "Request UUID for support.", "schema": { "type": "string", "format": "uuid" } }, "X-API-Version": { "schema": { "type": "string", "enum": [ "1" ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix time in seconds for the last applied request window.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "job_ids": { "type": "array", "minItems": 1, "maxItems": 1000, "uniqueItems": true, "items": { "type": "string", "format": "uuid" } }, "mode": { "type": "string", "enum": [ "focused", "all-useful" ], "default": "focused" }, "part": { "type": "integer", "minimum": 1 } } } } } } } }, "/downloads/{id}": { "get": { "operationId": "getZipDownloadStatus", "summary": "Read ZIP completeness and failed-file retry status", "description": "Requires downloads:read. Receipt is in memory for up to 30 minutes since its latest update. Each request checks account ownership of the original retained source job(s). Missing or other-account IDs return 404. A successful scan and download are not guaranteed to include every requested source image.", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "X-SIF-Download-ID from an earlier ZIP response." } ], "responses": { "200": { "description": "Current completeness receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "download": { "$ref": "#/components/schemas/ZipDownload" } } } } } }, "401": { "description": "Invalid API key" }, "403": { "description": "Key lacks downloads:read" }, "404": { "description": "Unknown, expired, or other-account download ID" }, "410": { "description": "Underlying job results expired" }, "429": { "description": "Rate limit exceeded" } } } }, "/downloads/{id}/retry": { "post": { "operationId": "retryZipFailedFiles", "summary": "Retry only failed image files in an earlier ZIP", "description": "Requires downloads:read and the owning account. Send {}. Uses the existing ZIP delivery stream, not a new scan. No new page-processing credits. The retry archive contains only files that failed in the preceding attempt; use both archives to obtain the completed set. Inspect the same download ID again. A retry is limited to 1,000 failed files and a 30-minute in-memory receipt window. This is not an idempotent network operation.", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false } } } }, "responses": { "200": { "description": "Retry ZIP with only previously failed image files", "headers": { "X-SIF-Download-ID": { "schema": { "type": "string", "format": "uuid" } }, "X-SIF-Download-Status": { "schema": { "type": "string" } } }, "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Invalid API key" }, "403": { "description": "Missing download scope" }, "404": { "description": "Unknown or other-account download ID" }, "409": { "description": "No failures, still building, or retry limit exceeded" }, "410": { "description": "Underlying job results expired" }, "429": { "description": "Rate limit exceeded" }, "503": { "description": "Delivery capacity exhausted" } } } }, "/catalog/previews": { "post": { "summary": "Create a product preview without charging scan credits (jobs:read)", "security": [ { "ApiKey": [] } ], "x-required-scope": "jobs:read", "responses": { "201": { "description": "Preview ID, product count, expiration and read link" }, "400": { "description": "Invalid URL or filters" }, "401": { "description": "API authentication required" }, "429": { "description": "Rate limited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "example": "https://example.com/collections/all" }, "filters": { "type": "object", "additionalProperties": false, "properties": { "collectionHandle": { "type": "string" }, "vendor": { "type": "string" } } } } } } } } } }, "/catalog/previews/{id}": { "get": { "summary": "Read an owned preview 10 products per page (jobs:read)", "security": [ { "ApiKey": [] } ], "x-required-scope": "jobs:read", "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid bearer token" }, "403": { "description": "Plan or scope required" }, "404": { "description": "Not found or not owned" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 1 } } ] } }, "/catalog/jobs": { "post": { "summary": "Process explicit product handles from a retained preview, Business or Scale (jobs:write)", "security": [ { "ApiKey": [] } ], "x-required-scope": "jobs:write", "responses": { "202": { "description": "Idempotent catalog job receipt" }, "400": { "description": "Invalid selection" }, "401": { "description": "API authentication required" }, "403": { "description": "Business/Scale plan or jobs:write scope required" }, "409": { "description": "Active run, expired selection, or idempotency conflict" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "preview_id", "product_handles" ], "properties": { "preview_id": { "type": "string", "format": "uuid" }, "product_handles": { "type": "array", "minItems": 1, "maxItems": 1000, "uniqueItems": true, "items": { "type": "string" } } } } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ] } }, "/catalog/jobs/{id}": { "get": { "summary": "Get catalog job progress, product statuses, and product-level recovery metrics (jobs:read)", "security": [ { "ApiKey": [] } ], "x-required-scope": "jobs:read", "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid bearer token" }, "403": { "description": "Plan or scope required" }, "404": { "description": "Not found or not owned" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/catalog/jobs/{id}/retry-failed": { "post": { "summary": "Retry failed catalog products, with new reservations only for retried products (jobs:write)", "security": [ { "ApiKey": [] } ], "x-required-scope": "jobs:write", "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid bearer token" }, "403": { "description": "Plan or scope required" }, "404": { "description": "Not found or not owned" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/catalog/jobs/{id}/cancel": { "post": { "summary": "Cancel unfinished catalog processing (jobs:write)", "security": [ { "ApiKey": [] } ], "x-required-scope": "jobs:write", "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid input" }, "401": { "description": "Missing/invalid bearer token" }, "403": { "description": "Plan or scope required" }, "404": { "description": "Not found or not owned" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/catalog/jobs/{id}/zip": { "post": { "summary": "Download the completed product gallery ZIP, with v1.2 receipt headers (downloads:read)", "security": [ { "ApiKey": [] } ], "x-required-scope": "downloads:read", "responses": { "200": { "description": "ZIP archive. Includes X-SIF-Download-ID and X-SIF-Download-Status headers", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-SIF-Download-ID": { "description": "Opaque ZIP receipt ID", "schema": { "type": "string", "format": "uuid" } }, "X-SIF-Download-Status": { "description": "Status endpoint path", "schema": { "type": "string" } } } }, "409": { "description": "Run incomplete or split ZIP requires part" }, "403": { "description": "Insufficient scope" }, "404": { "description": "Run not found/owned" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "focused", "all-useful" ], "default": "focused" }, "part": { "type": "integer", "minimum": 1 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } } }, "components": { "securitySchemes": { "ApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "sif_v1_...", "description": "Create under Account > API keys. New keys do not expire automatically and can be revoked at any time. Send only in Authorization, never in URLs." } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "details": { "type": "object", "additionalProperties": true, "description": "Optional structured details for errors such as split ZIP part counts." } }, "required": [ "code", "message", "request_id" ] } }, "required": [ "error" ] }, "Receipt": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "job", "bulk" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ] }, "Job": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "status": { "type": "string", "enum": [ "queued", "processing", "completed", "failed", "cancelled" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 100 }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "nullable": true }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "results": { "type": "string" }, "zip": { "type": "string" } }, "required": [ "self", "results", "zip" ] } }, "required": [ "id", "url", "status", "progress", "created_at", "updated_at", "expires_at", "error", "links" ] }, "ImageRef": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 }, "format": { "type": "string", "nullable": true }, "bytes": { "type": "integer", "minimum": 0 } }, "required": [ "url", "width", "height", "format", "bytes" ] }, "Image": { "type": "object", "properties": { "id": { "type": "string" }, "category": { "type": "string", "enum": [ "product-gallery", "product-detail", "review-media", "brand-asset", "site-ui", "background", "other" ] }, "label": { "type": "string", "enum": [ "PAGE MAX", "BEST AVAILABLE", "SOURCE RECOVERED", "POSSIBLE BETTER VERSION" ] }, "alt_text": { "type": "string" }, "product_linked": { "type": "boolean" }, "variant_ids": { "type": "array", "items": { "type": "string" } }, "page_max": { "$ref": "#/components/schemas/ImageRef" }, "best": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 }, "format": { "type": "string", "nullable": true }, "bytes": { "type": "integer", "minimum": 0 }, "verdict": { "type": "string", "enum": [ "displayed", "page-max", "best-available", "source-recovered", "possible" ] } }, "required": [ "url", "width", "height", "format", "bytes", "verdict" ] }, "pixel_gain": { "type": "number" }, "page_versions": { "type": "array", "items": { "$ref": "#/components/schemas/ImageRef" } } }, "required": [ "id", "category", "label", "alt_text", "product_linked", "variant_ids", "page_max", "best", "pixel_gain", "page_versions" ] }, "Results": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "final_url": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "scanned_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "next_offset": { "type": "integer", "nullable": true } }, "required": [ "offset", "limit", "total", "next_offset" ] }, "scope": { "type": "string", "enum": [ "useful", "all" ] } }, "required": [ "job_id", "url", "final_url", "title", "scanned_at", "expires_at", "scope", "images", "pagination" ] }, "BulkRun": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "queued", "processing", "completed", "completed_with_errors" ] }, "total": { "type": "integer" }, "completed": { "type": "integer" }, "failed": { "type": "integer" }, "cancelled": { "type": "integer" }, "expired": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "jobs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "queued", "processing", "completed", "failed", "cancelled", "expired" ] }, "progress": { "type": "number" }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "results": { "type": "string" }, "zip": { "type": "string" } }, "required": [ "self", "results", "zip" ] }, "url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "url", "status", "progress", "links" ] } }, "retry_count": { "type": "integer", "minimum": 0 }, "last_retry_job_count": { "type": "integer", "minimum": 0 }, "cancel_requested_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "status", "total", "completed", "failed", "cancelled", "expired", "created_at", "expires_at", "jobs", "retry_count", "last_retry_job_count", "cancel_requested_at" ] }, "Usage": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "free", "pro", "business", "scale" ] }, "credits": { "type": "object", "properties": { "used": { "type": "integer" }, "reserved": { "type": "integer" }, "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "resets_at": { "type": "string", "format": "date-time" }, "per_page": { "type": "integer", "enum": [ 2 ] } }, "required": [ "used", "reserved", "limit", "remaining", "resets_at", "per_page" ] }, "payment_needs_attention": { "type": "boolean" }, "limits": { "type": "object", "properties": { "urls_per_run": { "type": "integer" }, "active_single_page_jobs": { "type": "integer" }, "requests_per_minute": { "type": "integer" }, "starts_per_window": { "type": "integer" }, "start_window_seconds": { "type": "integer" }, "result_retention_hours": { "type": "number" } }, "required": [ "urls_per_run", "active_single_page_jobs", "requests_per_minute", "starts_per_window", "start_window_seconds", "result_retention_hours" ] }, "billing_refresh_required": { "type": "boolean" } }, "required": [ "plan", "credits", "payment_needs_attention", "limits", "billing_refresh_required" ] }, "ZipDownload": { "type": "object", "description": "Short-lived in-memory ZIP receipt, not the archived ZIP itself.", "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "building", "ready", "failed" ] }, "totalFiles": { "type": "integer", "minimum": 0 }, "includedFiles": { "type": "integer", "minimum": 0 }, "failedFiles": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" }, "retryAvailable": { "type": "boolean" }, "retryLimit": { "type": "integer" }, "error": { "type": "string", "nullable": true }, "failures": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "integer", "nullable": true }, "error": { "type": "string" } } } }, "additionalFailures": { "type": "integer" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "state", "totalFiles", "includedFiles", "failedFiles", "complete", "retryAvailable", "retryLimit", "failures", "additionalFailures", "expiresAt" ] }, "CatalogPreview": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "total": { "type": "integer" }, "page": { "type": "integer" }, "page_size": { "type": "integer", "example": 10 }, "products": { "type": "array", "items": { "type": "object", "properties": { "handle": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "variantCount": { "type": "integer" } } } }, "expires_at": { "type": "string", "format": "date-time" } } } } } }