{"servers":[{"url":"https://api.spreadu.com/api/print-lab/v1","description":"Production"}],"info":{"title":"Spreadu Print Lab API","version":"1.3","description":"Lab-scoped access to Spreadu. See the integration guide for compatibility and changelog."},"externalDocs":{"url":"https://docs.spreadu.com/print-lab-api","description":"Print Lab API integration guide"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"PayloadTooLargeError":{"type":"object","properties":{"defined":{"type":"boolean","const":false,"description":"Always false: an error the operation does not declare, such as a platform refusal or an unexpected fault. A 400 can carry either value: a request body that cannot be decoded, such as invalid JSON, is refused before the operation runs, with false. Authentication refusals are declared and carry true. Branch on `code`, never on this field."},"code":{"type":"string","const":"PAYLOAD_TOO_LARGE","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"type":"integer","const":413,"description":"The HTTP status of the response."},"message":{"type":"string","description":"A readable explanation for people. Its wording can change."}},"required":["defined","code","status","message"]},"RateLimitedError":{"type":"object","properties":{"defined":{"type":"boolean","const":false,"description":"Always false: an error the operation does not declare, such as a platform refusal or an unexpected fault. A 400 can carry either value: a request body that cannot be decoded, such as invalid JSON, is refused before the operation runs, with false. Authentication refusals are declared and carry true. Branch on `code`, never on this field."},"code":{"type":"string","const":"RATE_LIMITED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"type":"integer","const":429,"description":"The HTTP status of the response."},"message":{"type":"string","description":"A readable explanation for people. Its wording can change."},"error":{"type":"string","const":"RATE_LIMITED","description":"Always RATE_LIMITED, the same as `code`."},"retryAfter":{"type":"integer","description":"Seconds until the request allowance resets, the same as the `Retry-After` header."}},"required":["defined","code","status","message","error","retryAfter"]},"InternalServerError":{"type":"object","properties":{"defined":{"type":"boolean","const":false,"description":"Always false: an error the operation does not declare, such as a platform refusal or an unexpected fault. A 400 can carry either value: a request body that cannot be decoded, such as invalid JSON, is refused before the operation runs, with false. Authentication refusals are declared and carry true. Branch on `code`, never on this field."},"code":{"type":"string","const":"INTERNAL_SERVER_ERROR","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"type":"integer","const":500,"description":"The HTTP status of the response."},"message":{"type":"string","description":"A readable explanation for people. Its wording can change."}},"required":["defined","code","status","message"]},"UndeclaredError":{"type":"object","properties":{"defined":{"const":false,"description":"Always false: an error the operation does not declare, such as a platform refusal or an unexpected fault. A 400 can carry either value: a request body that cannot be decoded, such as invalid JSON, is refused before the operation runs, with false. Authentication refusals are declared and carry true. Branch on `code`, never on this field."},"code":{"type":"string","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"type":"number","description":"The HTTP status of the response."},"message":{"type":"string","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"InvalidApiKeyError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"INVALID_API_KEY","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":401,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Invalid API key","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"ApiAccessDisabledError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"API_ACCESS_DISABLED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":403,"description":"The HTTP status of the response."},"message":{"type":"string","default":"API access is disabled","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"BadRequestError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"BAD_REQUEST","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":400,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Invalid request","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"CursorExpiredError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"CURSOR_EXPIRED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":410,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Event cursor expired","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"ModuleNotEnabledError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"MODULE_NOT_ENABLED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":403,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Module is not enabled","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Details of this error.","type":"object","properties":{"module":{"type":"string","description":"The module this operation belongs to, which is not enabled for your lab."}},"required":["module"],"additionalProperties":false}},"required":["defined","code","status","message","data"]},"InsufficientScopeError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"INSUFFICIENT_SCOPE","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":403,"description":"The HTTP status of the response."},"message":{"type":"string","default":"API key lacks the required scope","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Details of this error.","type":"object","properties":{"requiredScope":{"type":"string","description":"The scope this operation needs, which this key lacks."}},"required":["requiredScope"],"additionalProperties":false}},"required":["defined","code","status","message","data"]},"ExportNotFoundError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"EXPORT_NOT_FOUND","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":404,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Export not found","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"SandboxBusyError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"SANDBOX_BUSY","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"The sandbox is preparing files or handling another request. Retry shortly.","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"RevisionNotDownloadableError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"REVISION_NOT_DOWNLOADABLE","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Revision is not downloadable","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Details of this error.","type":"object","properties":{"downloadableRevision":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The revision a retry of the same request would accept now. Null when no revision is downloadable."}},"required":["downloadableRevision"],"additionalProperties":false}},"required":["defined","code","status","message","data"]},"FileNotFoundError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"FILE_NOT_FOUND","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":404,"description":"The HTTP status of the response."},"message":{"type":"string","default":"File not found","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"RevisionNotFoundError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"REVISION_NOT_FOUND","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":404,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Revision not found","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"WebhookUrlExistsError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"WEBHOOK_URL_EXISTS","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"A webhook endpoint with this URL already exists","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Sent only when this key created the existing endpoint.","type":"object","properties":{"webhookId":{"type":"string","description":"The existing endpoint with this URL. Update it instead."}},"required":["webhookId"],"additionalProperties":false}},"required":["defined","code","status","message"]},"ServiceUnavailableError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"SERVICE_UNAVAILABLE","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":503,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Webhook secret storage is unavailable","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"EndpointLimitReachedError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"ENDPOINT_LIMIT_REACHED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Webhook endpoint limit reached","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"WebhookNotFoundError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"WEBHOOK_NOT_FOUND","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":404,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Webhook endpoint not found","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"WebhookDisabledError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"WEBHOOK_DISABLED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Webhook endpoint is disabled","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"TestModeRequiredError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"TEST_MODE_REQUIRED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":403,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Use a test API key for simulator operations","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"IdempotencyConflictError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"IDEMPOTENCY_CONFLICT","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Idempotency key was already used for another request","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"SandboxStateConflictError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"SANDBOX_STATE_CONFLICT","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"The export cannot perform this transition","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"SandboxExportLimitError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"SANDBOX_EXPORT_LIMIT","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Reset or expire a sandbox export before creating another","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"SandboxExportLockedError":{"type":"object","properties":{"defined":{"const":true,"description":"Always true: the operation declares this error, with this `code` and `status`."},"code":{"const":"SANDBOX_EXPORT_LOCKED","description":"Machine-readable error code. Branch on it, never on `message`."},"status":{"const":409,"description":"The HTTP status of the response."},"message":{"type":"string","default":"Unlock the export through the lab API before simulating photographer changes.","description":"A readable explanation for people. Its wording can change."},"data":{"description":"Not declared for this error. When present it is a hint for people, such as the name of a refused field; its shape is not part of the contract, so do not branch on it."}},"required":["defined","code","status","message"]},"ConfirmExportRequest":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision your lab will produce. It must be the current downloadable revision."},"orderNumber":{"type":"string","minLength":1,"maxLength":120,"description":"Your order number: 1 to 120 characters after trimming, no control characters."},"externalOrderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}],"description":"Your system's order ID, 1 to 120 characters after trimming, or null."},"externalOrderLineId":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}],"description":"Your system's order line ID, 1 to 120 characters after trimming, or null."}},"required":["revision","orderNumber","externalOrderId","externalOrderLineId"],"additionalProperties":false,"examples":[{"revision":2,"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","externalOrderLineId":"wc_item_31877"}]},"CreateDownloadUrlsRequest":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The exact revision to download. It must be the current downloadable revision."},"fileIds":{"maxItems":500,"type":"array","items":{"type":"string"},"description":"Up to 500 file IDs from that revision. Omit for every production file and package."}},"required":["revision"],"additionalProperties":false,"examples":[{"revision":2,"fileIds":["cm3ka1d7e0040fl05m3p8s2qb"]}]},"RecordExportReceiptRequest":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"A published revision of this export, including one later withdrawn or expired."}},"required":["revision"],"additionalProperties":false,"examples":[{"revision":2}]},"CreateWebhookRequest":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":60,"description":"Your name for the endpoint, 1 to 60 characters after trimming."},"url":{"type":"string","maxLength":2048,"description":"A public https:// address on port 443, at most 2048 characters, without credentials or fragment."},"eventTypes":{"type":"array","items":{"type":"string","minLength":1},"description":"Event types to receive, each from an enabled module and readable by this key, or `[\"*\"]` for every current and future type, accepted only when this key holds every scope the current event types require. `[]` receives only test pings."}},"required":["label","url","eventTypes"],"additionalProperties":false,"examples":[{"label":"Order sync","url":"https://hooks.example.com/spreadu","eventTypes":["export.available","export.withdrawn"]}]},"UpdateWebhookRequest":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":60,"description":"Your name for the endpoint, 1 to 60 characters after trimming."},"url":{"type":"string","maxLength":2048,"description":"A public https:// address on port 443, at most 2048 characters, without credentials or fragment."},"eventTypes":{"type":"array","items":{"type":"string","minLength":1},"description":"Event types to receive, each from an enabled module and readable by this key, or `[\"*\"]` for every current and future type, accepted only when this key holds every scope the current event types require. `[]` receives only test pings."},"enabled":{"type":"boolean","description":"`false` disables the endpoint and cancels its pending deliveries; `true` enables it again."}},"additionalProperties":false,"examples":[{"enabled":false}]},"CreateSandboxExportRequest":{"type":"object","properties":{"scenario":{"default":"spreads-jpg","description":"The synthetic export to create.","type":"string","enum":["spreads-jpg","pages-pdf","cover-and-inner","with-order","print-size","correction","expiring-soon"]}},"additionalProperties":false,"examples":[{"scenario":"with-order"}]},"SetSandboxOrderRequest":{"type":"object","properties":{"orderNumber":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}],"description":"Order number as the photographer enters it: 1 to 120 characters after trimming, or null for none."},"externalOrderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}],"description":"Your system's order ID as the photographer enters it, 1 to 120 characters after trimming, or null."},"orderedCopies":{"anyOf":[{"type":"integer","minimum":1,"maximum":999},{"type":"null"}],"description":"Printed copies, 1 to 999, or null for none."}},"required":["orderNumber","externalOrderId","orderedCopies"],"additionalProperties":false,"examples":[{"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","orderedCopies":2}]},"ResetSandboxRequest":{"type":"object","properties":{},"additionalProperties":false,"examples":[{}]},"Me":{"type":"object","properties":{"mode":{"type":"string","enum":["live","test"],"description":"`test` when a test key made the request, `live` for a live key."},"lab":{"type":"object","properties":{"id":{"type":"string","description":"Lab ID."},"name":{"type":"string","description":"Lab name."},"slug":{"type":"string","description":"The lab's URL slug."}},"required":["id","name","slug"],"additionalProperties":false,"description":"The lab the key belongs to."},"key":{"type":"object","properties":{"id":{"type":"string","description":"Key ID."},"label":{"type":"string","description":"The name given to the key when it was created."},"scopes":{"type":"array","items":{"type":"string"},"description":"Permissions granted to the key."}},"required":["id","label","scopes"],"additionalProperties":false,"description":"The key that authenticated this request."},"modules":{"type":"array","items":{"type":"string"},"description":"Modules enabled for the lab. `core` is always included."},"rateLimit":{"type":"object","properties":{"perMinute":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Requests per minute shared by every key of the lab."}},"required":["perMinute"],"additionalProperties":false,"description":"The lab's request allowance."}},"required":["mode","lab","key","modules","rateLimit"],"additionalProperties":false,"examples":[{"mode":"live","lab":{"id":"cm3k9x2qa0000lb08f1d7h3sk","name":"Example Print Lab","slug":"example-print-lab"},"key":{"id":"cm3k9x7wd0002lb08a9c4e6tm","label":"Order sync","scopes":["exports:read","exports:download","exports:confirm","webhooks:manage"]},"modules":["core","exports"],"rateLimit":{"perMinute":600}}]},"EventList":{"type":"object","properties":{"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PrintLabEvent_export_requested"},{"$ref":"#/components/schemas/PrintLabEvent_export_available"},{"$ref":"#/components/schemas/PrintLabEvent_export_withdrawn"},{"$ref":"#/components/schemas/PrintLabEvent_export_expiring"},{"$ref":"#/components/schemas/PrintLabEvent_export_expired"},{"$ref":"#/components/schemas/PrintLabEvent_export_confirmed"},{"$ref":"#/components/schemas/PrintLabEvent_export_unlocked"},{"$ref":"#/components/schemas/PrintLabEvent_export_received"}],"discriminator":{"propertyName":"type","mapping":{"export.requested":"#/components/schemas/PrintLabEvent_export_requested","export.available":"#/components/schemas/PrintLabEvent_export_available","export.withdrawn":"#/components/schemas/PrintLabEvent_export_withdrawn","export.expiring":"#/components/schemas/PrintLabEvent_export_expiring","export.expired":"#/components/schemas/PrintLabEvent_export_expired","export.confirmed":"#/components/schemas/PrintLabEvent_export_confirmed","export.unlocked":"#/components/schemas/PrintLabEvent_export_unlocked","export.received":"#/components/schemas/PrintLabEvent_export_received"}}},"description":"Events in sequence order. Filtered views can skip sequence numbers."},"nextCursor":{"description":"Pass as `after` on the next request. A page shorter than `limit` moves it to the stream head, past events this key cannot see or `types` excludes.","type":"string"}},"required":["items","nextCursor"],"additionalProperties":false,"examples":[{"items":[{"id":"evt_cm3kd18420000ev06q4w8r2tz","occurredAt":"2026-11-02T08:41:27.000Z","sequence":"1842","type":"export.available","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-02T08:41:27.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"revision":{"revision":2,"status":"AVAILABLE","current":true,"downloadable":true,"availableAt":"2026-11-02T08:41:27.000Z","withdrawnAt":null,"downloadableUntil":"2026-12-02T08:41:27.000Z","product":{"id":"cm2r7d1xk0000pd01h4q8z6wc","name":"Layflat Album 30x30"},"spec":{"id":"cm2r7e5vn0002sp01b9k3t7xm","name":"30x30 cm, 12 spreads"},"spreadCount":12,"output":{"format":"JPG","unit":"SPREADS","colorSpace":"sRGB","dpi":300},"receivedAt":null,"order":{"orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"parts":[{"kind":"INNER","geometry":{"dpi":300,"widthPx":7157,"heightPx":3613,"pageWidthPx":null,"pageHeightPx":null,"trimWidthPx":7087,"trimHeightPx":3543,"innerBleedPx":null,"outerBleedPx":35,"spineWidthPx":null,"mm":{"width":606,"height":305.9,"pageWidth":null,"pageHeight":null,"trimWidth":600,"trimHeight":300,"innerBleed":null,"outerBleed":3,"spineWidth":null}},"files":[{"id":"cm3ka1d7e0020fl05m3p8s2qb","kind":"FILE","sequence":1,"filename":"H4TR-8KWN-r2-spread-01.jpg","mimeType":"image/jpeg","sizeBytes":"18734221","checksumSha256":"097f575c8ffae51d5246787732eed27728397e578f7267ca151f7def3b6d38fc","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0021fl05m3p8s2qb","kind":"FILE","sequence":2,"filename":"H4TR-8KWN-r2-spread-02.jpg","mimeType":"image/jpeg","sizeBytes":"18872132","checksumSha256":"d13dc5f91f401bb2350d448ecf95bb3fcc02f7348d077b1a4d6e142b3a802f00","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0022fl05m3p8s2qb","kind":"FILE","sequence":3,"filename":"H4TR-8KWN-r2-spread-03.jpg","mimeType":"image/jpeg","sizeBytes":"19010043","checksumSha256":"bf6dce0fd51932ab84e900580f199692aa8874e62e24f79c7272841c3c93c9a7","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0023fl05m3p8s2qb","kind":"FILE","sequence":4,"filename":"H4TR-8KWN-r2-spread-04.jpg","mimeType":"image/jpeg","sizeBytes":"19147954","checksumSha256":"75eaf06ad84051718ade8dd77ea54bb96feef4a6bc06df63a239ca4f3d8faa5d","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0024fl05m3p8s2qb","kind":"FILE","sequence":5,"filename":"H4TR-8KWN-r2-spread-05.jpg","mimeType":"image/jpeg","sizeBytes":"19285865","checksumSha256":"62dae1345145165c442c5992841fc7c301f87f06e73b888a18d1fb77f7108489","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0025fl05m3p8s2qb","kind":"FILE","sequence":6,"filename":"H4TR-8KWN-r2-spread-06.jpg","mimeType":"image/jpeg","sizeBytes":"19423776","checksumSha256":"affa5fab7331af23eee57f233ee58892260d930d906095fa3643b5cb982dd252","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0026fl05m3p8s2qb","kind":"FILE","sequence":7,"filename":"H4TR-8KWN-r2-spread-07.jpg","mimeType":"image/jpeg","sizeBytes":"19561687","checksumSha256":"07f058e33ce39b2f9644f7a7cae9d3b6a8cac61ad81d9aec50849137104d4f69","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0027fl05m3p8s2qb","kind":"FILE","sequence":8,"filename":"H4TR-8KWN-r2-spread-08.jpg","mimeType":"image/jpeg","sizeBytes":"19699598","checksumSha256":"1834a77e7e7fa1892cf4a0a09a18c319e34d5b8bbc9fe9fe55f5d4fc2ba76b41","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0028fl05m3p8s2qb","kind":"FILE","sequence":9,"filename":"H4TR-8KWN-r2-spread-09.jpg","mimeType":"image/jpeg","sizeBytes":"19837509","checksumSha256":"d1fd5b473556383c3e014cea08942337f005af79563b5f652e57cc1c8e54a61d","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0029fl05m3p8s2qb","kind":"FILE","sequence":10,"filename":"H4TR-8KWN-r2-spread-10.jpg","mimeType":"image/jpeg","sizeBytes":"19975420","checksumSha256":"f944939fa3293350ccde5cdd252ea790eaf7d45fb7b4e94d8927cdb6048c82b8","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0030fl05m3p8s2qb","kind":"FILE","sequence":11,"filename":"H4TR-8KWN-r2-spread-11.jpg","mimeType":"image/jpeg","sizeBytes":"20113331","checksumSha256":"e86c0cb687cceb9c08dff7b948fcb7a937c351d0073864504e95d990c0bc82fa","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0031fl05m3p8s2qb","kind":"FILE","sequence":12,"filename":"H4TR-8KWN-r2-spread-12.jpg","mimeType":"image/jpeg","sizeBytes":"20251242","checksumSha256":"b64906f4243f3d79d5ba90bd1f49d001f5dbe8df0e2b340d9e6f4085054c36e5","widthPx":7157,"heightPx":3613,"dpi":300}]}],"packages":[{"id":"cm3ka1d7e0040fl05m3p8s2qb","kind":"ARCHIVE","sequence":1,"filename":"H4TR-8KWN-r2.zip","mimeType":"application/zip","sizeBytes":"231560448","checksumSha256":"bed1e83c510923047c50f280b0b306cd761dc670f9423e05614e2333d41121a0","widthPx":null,"heightPx":null,"dpi":null}]}}}],"nextCursor":"1842"}]},"Export":{"type":"object","properties":{"reference":{"type":"string","description":"The export's reference, the code the photographer gives your lab, such as H4TR-8KWN. It never changes."},"albumId":{"type":"string","description":"ID of the album the export came from."},"albumTitle":{"type":"string","description":"Photographer-chosen title from the newest revision. It can include a client's name."},"correctionOpen":{"type":"boolean","description":"True while the photographer prepares a correction."},"downloadableRevision":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The revision you can download now. Null when none is downloadable."},"lockedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When your lab confirmed the order and locked the album. Null while unlocked."},"latestRevision":{"anyOf":[{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Revision number."},"status":{"$ref":"#/components/schemas/ExportRevisionStatus","description":"Status of that revision."}},"required":["revision","status"],"additionalProperties":false},{"type":"null"}],"description":"The newest visible revision. Null before the first."},"labOrder":{"anyOf":[{"$ref":"#/components/schemas/LabOrder"},{"type":"null"}],"description":"The current order context. Null when there is none."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the album was set up for your lab."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Latest change to the export, its order or its newest revision. `updatedSince` filters on it."},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the downloadable revision became available. Null when nothing is downloadable."},"downloadableUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last moment to download that revision. Null when nothing is downloadable."},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When you recorded receiving the downloadable revision. Null until then or when nothing is downloadable."},"photographer":{"anyOf":[{"$ref":"#/components/schemas/Photographer"},{"type":"null"}],"description":"The photographer. Null while no revision is visible."},"revisions":{"type":"array","items":{"$ref":"#/components/schemas/ExportRevision"},"description":"Every visible revision, newest first. Failed render attempts are left out."}},"required":["reference","albumId","albumTitle","correctionOpen","downloadableRevision","lockedAt","latestRevision","labOrder","createdAt","updatedAt","availableAt","downloadableUntil","receivedAt","photographer","revisions"],"additionalProperties":false,"examples":[{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-02T08:41:27.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"},"revisions":[{"revision":2,"status":"AVAILABLE","current":true,"downloadable":true,"availableAt":"2026-11-02T08:41:27.000Z","withdrawnAt":null,"downloadableUntil":"2026-12-02T08:41:27.000Z","product":{"id":"cm2r7d1xk0000pd01h4q8z6wc","name":"Layflat Album 30x30"},"spec":{"id":"cm2r7e5vn0002sp01b9k3t7xm","name":"30x30 cm, 12 spreads"},"spreadCount":12,"output":{"format":"JPG","unit":"SPREADS","colorSpace":"sRGB","dpi":300},"receivedAt":null,"order":{"orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"parts":[{"kind":"INNER","geometry":{"dpi":300,"widthPx":7157,"heightPx":3613,"pageWidthPx":null,"pageHeightPx":null,"trimWidthPx":7087,"trimHeightPx":3543,"innerBleedPx":null,"outerBleedPx":35,"spineWidthPx":null,"mm":{"width":606,"height":305.9,"pageWidth":null,"pageHeight":null,"trimWidth":600,"trimHeight":300,"innerBleed":null,"outerBleed":3,"spineWidth":null}},"files":[{"id":"cm3ka1d7e0020fl05m3p8s2qb","kind":"FILE","sequence":1,"filename":"H4TR-8KWN-r2-spread-01.jpg","mimeType":"image/jpeg","sizeBytes":"18734221","checksumSha256":"097f575c8ffae51d5246787732eed27728397e578f7267ca151f7def3b6d38fc","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0021fl05m3p8s2qb","kind":"FILE","sequence":2,"filename":"H4TR-8KWN-r2-spread-02.jpg","mimeType":"image/jpeg","sizeBytes":"18872132","checksumSha256":"d13dc5f91f401bb2350d448ecf95bb3fcc02f7348d077b1a4d6e142b3a802f00","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0022fl05m3p8s2qb","kind":"FILE","sequence":3,"filename":"H4TR-8KWN-r2-spread-03.jpg","mimeType":"image/jpeg","sizeBytes":"19010043","checksumSha256":"bf6dce0fd51932ab84e900580f199692aa8874e62e24f79c7272841c3c93c9a7","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0023fl05m3p8s2qb","kind":"FILE","sequence":4,"filename":"H4TR-8KWN-r2-spread-04.jpg","mimeType":"image/jpeg","sizeBytes":"19147954","checksumSha256":"75eaf06ad84051718ade8dd77ea54bb96feef4a6bc06df63a239ca4f3d8faa5d","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0024fl05m3p8s2qb","kind":"FILE","sequence":5,"filename":"H4TR-8KWN-r2-spread-05.jpg","mimeType":"image/jpeg","sizeBytes":"19285865","checksumSha256":"62dae1345145165c442c5992841fc7c301f87f06e73b888a18d1fb77f7108489","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0025fl05m3p8s2qb","kind":"FILE","sequence":6,"filename":"H4TR-8KWN-r2-spread-06.jpg","mimeType":"image/jpeg","sizeBytes":"19423776","checksumSha256":"affa5fab7331af23eee57f233ee58892260d930d906095fa3643b5cb982dd252","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0026fl05m3p8s2qb","kind":"FILE","sequence":7,"filename":"H4TR-8KWN-r2-spread-07.jpg","mimeType":"image/jpeg","sizeBytes":"19561687","checksumSha256":"07f058e33ce39b2f9644f7a7cae9d3b6a8cac61ad81d9aec50849137104d4f69","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0027fl05m3p8s2qb","kind":"FILE","sequence":8,"filename":"H4TR-8KWN-r2-spread-08.jpg","mimeType":"image/jpeg","sizeBytes":"19699598","checksumSha256":"1834a77e7e7fa1892cf4a0a09a18c319e34d5b8bbc9fe9fe55f5d4fc2ba76b41","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0028fl05m3p8s2qb","kind":"FILE","sequence":9,"filename":"H4TR-8KWN-r2-spread-09.jpg","mimeType":"image/jpeg","sizeBytes":"19837509","checksumSha256":"d1fd5b473556383c3e014cea08942337f005af79563b5f652e57cc1c8e54a61d","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0029fl05m3p8s2qb","kind":"FILE","sequence":10,"filename":"H4TR-8KWN-r2-spread-10.jpg","mimeType":"image/jpeg","sizeBytes":"19975420","checksumSha256":"f944939fa3293350ccde5cdd252ea790eaf7d45fb7b4e94d8927cdb6048c82b8","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0030fl05m3p8s2qb","kind":"FILE","sequence":11,"filename":"H4TR-8KWN-r2-spread-11.jpg","mimeType":"image/jpeg","sizeBytes":"20113331","checksumSha256":"e86c0cb687cceb9c08dff7b948fcb7a937c351d0073864504e95d990c0bc82fa","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0031fl05m3p8s2qb","kind":"FILE","sequence":12,"filename":"H4TR-8KWN-r2-spread-12.jpg","mimeType":"image/jpeg","sizeBytes":"20251242","checksumSha256":"b64906f4243f3d79d5ba90bd1f49d001f5dbe8df0e2b340d9e6f4085054c36e5","widthPx":7157,"heightPx":3613,"dpi":300}]}],"packages":[{"id":"cm3ka1d7e0040fl05m3p8s2qb","kind":"ARCHIVE","sequence":1,"filename":"H4TR-8KWN-r2.zip","mimeType":"application/zip","sizeBytes":"231560448","checksumSha256":"bed1e83c510923047c50f280b0b306cd761dc670f9423e05614e2333d41121a0","widthPx":null,"heightPx":null,"dpi":null}]},{"revision":1,"status":"WITHDRAWN","current":false,"downloadable":false,"availableAt":"2026-10-30T09:12:40.000Z","withdrawnAt":"2026-10-31T16:20:03.000Z","downloadableUntil":"2026-11-29T09:12:40.000Z","product":{"id":"cm2r7d1xk0000pd01h4q8z6wc","name":"Layflat Album 30x30"},"spec":{"id":"cm2r7e5vn0002sp01b9k3t7xm","name":"30x30 cm, 12 spreads"},"spreadCount":12,"output":{"format":"JPG","unit":"SPREADS","colorSpace":"sRGB","dpi":300},"receivedAt":null,"order":{"orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"parts":[{"kind":"INNER","geometry":{"dpi":300,"widthPx":7157,"heightPx":3613,"pageWidthPx":null,"pageHeightPx":null,"trimWidthPx":7087,"trimHeightPx":3543,"innerBleedPx":null,"outerBleedPx":35,"spineWidthPx":null,"mm":{"width":606,"height":305.9,"pageWidth":null,"pageHeight":null,"trimWidth":600,"trimHeight":300,"innerBleed":null,"outerBleed":3,"spineWidth":null}},"files":[]}],"packages":[]}]}]},"ExportList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ExportSummary"},"description":"Export summaries, most recently created first."},"nextCursor":{"description":"Pass as `cursor` to read the next page. Null on the last page.","type":["string","null"]}},"required":["items","nextCursor"],"additionalProperties":false,"examples":[{"items":[{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-02T08:41:27.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}}],"nextCursor":"eyJjcmVhdGVkQXQiOiIyMDI2LTEwLTI4VDE0OjAyOjExLjAwMFoiLCJpZCI6ImNtM2s4cTJ4dDAwMDZmdTAxZDRtN3A5emIifQ"}]},"ExportSummary":{"type":"object","properties":{"reference":{"type":"string","description":"The export's reference, the code the photographer gives your lab, such as H4TR-8KWN. It never changes."},"albumId":{"type":"string","description":"ID of the album the export came from."},"albumTitle":{"type":"string","description":"Photographer-chosen title from the newest revision. It can include a client's name."},"correctionOpen":{"type":"boolean","description":"True while the photographer prepares a correction."},"downloadableRevision":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The revision you can download now. Null when none is downloadable."},"lockedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When your lab confirmed the order and locked the album. Null while unlocked."},"latestRevision":{"anyOf":[{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Revision number."},"status":{"$ref":"#/components/schemas/ExportRevisionStatus","description":"Status of that revision."}},"required":["revision","status"],"additionalProperties":false},{"type":"null"}],"description":"The newest visible revision. Null before the first."},"labOrder":{"anyOf":[{"$ref":"#/components/schemas/LabOrder"},{"type":"null"}],"description":"The current order context. Null when there is none."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the album was set up for your lab."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Latest change to the export, its order or its newest revision. `updatedSince` filters on it."},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the downloadable revision became available. Null when nothing is downloadable."},"downloadableUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last moment to download that revision. Null when nothing is downloadable."},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When you recorded receiving the downloadable revision. Null until then or when nothing is downloadable."},"photographer":{"anyOf":[{"$ref":"#/components/schemas/Photographer"},{"type":"null"}],"description":"The photographer. Null while no revision is visible."}},"required":["reference","albumId","albumTitle","correctionOpen","downloadableRevision","lockedAt","latestRevision","labOrder","createdAt","updatedAt","availableAt","downloadableUntil","receivedAt","photographer"],"additionalProperties":false},"ExportRevision":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Revision number. Numbers increase and can skip failed render attempts."},"status":{"$ref":"#/components/schemas/ExportRevisionStatus","description":"PREPARING while files render, AVAILABLE once published, WITHDRAWN after a correction or lost files, EXPIRED after the download window."},"current":{"type":"boolean","description":"True for the export's current revision."},"downloadable":{"type":"boolean","description":"True while its files can be downloaded: current, AVAILABLE and inside the download window."},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When its files were published. Null if it never became available."},"withdrawnAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was withdrawn. Null if it was not."},"downloadableUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last moment to download its files: the earlier of the download expiry and the file deletion time. Null when no deadline is set."},"product":{"type":"object","properties":{"id":{"type":"string","description":"Catalog ID."},"name":{"type":"string","description":"Name as frozen with the revision."}},"required":["id","name"],"additionalProperties":false,"description":"The catalog product, frozen when the revision was submitted."},"spec":{"type":"object","properties":{"id":{"type":"string","description":"Catalog ID."},"name":{"type":"string","description":"Name as frozen with the revision."}},"required":["id","name"],"additionalProperties":false,"description":"The product specification, frozen when the revision was submitted."},"spreadCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of spreads that were rendered."},"output":{"type":"object","properties":{"format":{"type":"string","enum":["JPG","PDF","PNG","TIFF"],"description":"File format of the production files."},"unit":{"type":"string","enum":["PAGES","SPREADS"],"description":"Whether each file holds one page or one spread."},"colorSpace":{"type":"string","enum":["sRGB","AdobeRGB","ProPhotoRGB"],"description":"Color space of the production files."},"dpi":{"type":"number","exclusiveMinimum":0,"description":"Render resolution in dots per inch."}},"required":["format","unit","colorSpace","dpi"],"additionalProperties":false,"description":"How the production files were rendered."},"parts":{"type":"array","items":{"$ref":"#/components/schemas/ExportPart"},"description":"Rendered parts: always INNER, plus COVER when the album has a cover."},"packages":{"type":"array","items":{"$ref":"#/components/schemas/ExportFile"},"description":"The complete ZIP and, for PDF output, the combined PDF. Empty while the revision is not downloadable."},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When your lab recorded receiving this revision. Null until then."},"order":{"anyOf":[{"$ref":"#/components/schemas/ExportRevisionOrder"},{"type":"null"}],"description":"Order facts frozen when the revision was submitted. Null when the album had no order then."}},"required":["revision","status","current","downloadable","availableAt","withdrawnAt","downloadableUntil","product","spec","spreadCount","output","parts","packages","receivedAt","order"],"additionalProperties":false},"ExportRevisionStatus":{"type":"string","enum":["PREPARING","AVAILABLE","WITHDRAWN","EXPIRED"]},"ExportRevisionOrder":{"type":"object","properties":{"orderedLength":{"anyOf":[{"$ref":"#/components/schemas/OrderedLength"},{"type":"null"}],"description":"Album length when the revision was submitted. Null when no length was set."},"orderedCopies":{"anyOf":[{"type":"integer","minimum":1,"maximum":999},{"type":"null"}],"description":"Printed copies when the revision was submitted, 1 to 999. Null when none were entered."}},"required":["orderedLength","orderedCopies"],"additionalProperties":false},"ExportPart":{"type":"object","properties":{"kind":{"type":"string","enum":["INNER","COVER"],"description":"INNER for the album's pages or spreads, COVER for its cover."},"geometry":{"anyOf":[{"$ref":"#/components/schemas/ExportGeometry"},{"type":"null"}],"description":"Frozen dimensions of this part. Null when the revision has no valid stored specification for it."},"files":{"type":"array","items":{"$ref":"#/components/schemas/ExportFile"},"description":"Production files of this part. Empty while the revision is not downloadable."}},"required":["kind","geometry","files"],"additionalProperties":false},"ExportFile":{"type":"object","properties":{"id":{"type":"string","description":"File ID. Pass it in `fileIds` to request its URL."},"kind":{"type":"string","enum":["ARCHIVE","COMBINED_PDF","FILE"],"description":"FILE is one production image or page, ARCHIVE the complete ZIP package, COMBINED_PDF the single PDF of a PDF export."},"sequence":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Order of the file among files of its kind."},"filename":{"type":"string","description":"File name to save the download under."},"mimeType":{"type":"string","description":"Media type, for example image/jpeg or application/zip."},"sizeBytes":{"type":"string","pattern":"^\\d+$","description":"Size in bytes, as a decimal string so it never loses precision."},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase hex SHA-256 of the bytes. Check every download against it."},"widthPx":{"description":"Pixel width. Null for a file without pixel dimensions, such as an archive.","type":["number","null"]},"heightPx":{"description":"Pixel height. Null for a file without pixel dimensions, such as an archive.","type":["number","null"]},"dpi":{"description":"Resolution the file was rendered at. Null when it has none, such as an archive.","type":["number","null"]}},"required":["id","kind","sequence","filename","mimeType","sizeBytes","checksumSha256","widthPx","heightPx","dpi"],"additionalProperties":false},"ExportGeometry":{"type":"object","properties":{"dpi":{"type":"number","description":"Resolution that relates the stored pixels to physical size."},"widthPx":{"type":"number","description":"Layout width in pixels, as stored. Authoritative."},"heightPx":{"type":"number","description":"Layout height in pixels, as stored. Authoritative."},"pageWidthPx":{"description":"Width of one page in pixels. Null when it is not stored.","type":["number","null"]},"pageHeightPx":{"description":"Height of one page in pixels. Null when it is not stored.","type":["number","null"]},"trimWidthPx":{"description":"Trim width in pixels. Null when it is not stored.","type":["number","null"]},"trimHeightPx":{"description":"Trim height in pixels. Null when it is not stored.","type":["number","null"]},"innerBleedPx":{"description":"Bleed at the inner edge in pixels. Null when it is not stored.","type":["number","null"]},"outerBleedPx":{"description":"Bleed at the outer edge in pixels; for a cover, its bleed. Null when it is not stored.","type":["number","null"]},"spineWidthPx":{"description":"Spine width in pixels. Null when it is not stored.","type":["number","null"]},"mm":{"anyOf":[{"$ref":"#/components/schemas/ExportGeometryMillimetres"},{"type":"null"}],"description":"The same dimensions in millimetres. Null only when the stored DPI is not positive."}},"required":["dpi","widthPx","heightPx","pageWidthPx","pageHeightPx","trimWidthPx","trimHeightPx","innerBleedPx","outerBleedPx","spineWidthPx","mm"],"additionalProperties":false},"ExportGeometryMillimetres":{"type":"object","properties":{"width":{"type":"number","description":"`widthPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm."},"height":{"type":"number","description":"`heightPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm."},"pageWidth":{"description":"`pageWidthPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `pageWidthPx` is null.","type":["number","null"]},"pageHeight":{"description":"`pageHeightPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `pageHeightPx` is null.","type":["number","null"]},"trimWidth":{"description":"`trimWidthPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `trimWidthPx` is null.","type":["number","null"]},"trimHeight":{"description":"`trimHeightPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `trimHeightPx` is null.","type":["number","null"]},"innerBleed":{"description":"`innerBleedPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `innerBleedPx` is null.","type":["number","null"]},"outerBleed":{"description":"`outerBleedPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `outerBleedPx` is null.","type":["number","null"]},"spineWidth":{"description":"`spineWidthPx` in millimetres: px / dpi * 25.4, rounded to 0.1 mm. Null when `spineWidthPx` is null.","type":["number","null"]}},"required":["width","height","pageWidth","pageHeight","trimWidth","trimHeight","innerBleed","outerBleed","spineWidth"],"additionalProperties":false},"LabOrder":{"type":"object","properties":{"orderNumber":{"description":"Your lab's order number, from the photographer or your confirmation. Null when none.","type":["string","null"]},"externalOrderId":{"description":"Your system's order ID. Null when none.","type":["string","null"]},"externalOrderLineId":{"description":"Your system's order line ID. Null when none.","type":["string","null"]},"confirmedByLab":{"type":"boolean","description":"True when your lab's API confirmation set these identifiers. Use `lockedAt`, not this field, to tell whether editing is locked."},"orderedQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Album length in pages or spreads, not printed copies. Null when not set. Same value as `orderedLength.count`."},"orderedQuantityUnit":{"anyOf":[{"type":"string","enum":["PAGES","SPREADS"]},{"type":"null"}],"description":"Unit of `orderedQuantity`. Null when not set."},"orderedLength":{"anyOf":[{"$ref":"#/components/schemas/OrderedLength"},{"type":"null"}],"description":"Album length as one object. Null when the length or its unit is not set."},"orderedCopies":{"anyOf":[{"type":"integer","minimum":1,"maximum":999},{"type":"null"}],"description":"Printed copies the photographer entered, 1 to 999, or null. Informational: Spreadu never enforces it."}},"required":["orderNumber","externalOrderId","externalOrderLineId","confirmedByLab","orderedQuantity","orderedQuantityUnit","orderedLength","orderedCopies"],"additionalProperties":false},"OrderedLength":{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Number of pages or spreads in the album."},"unit":{"type":"string","enum":["PAGES","SPREADS"],"description":"Whether `count` counts PAGES or SPREADS."}},"required":["count","unit"],"additionalProperties":false},"Photographer":{"type":"object","properties":{"id":{"description":"Stable ID of the photographer within your lab. Null when they are no longer your lab's customer.","type":["string","null"]},"displayName":{"description":"Name frozen on the newest visible revision. Null when the photographer has no name.","type":["string","null"]}},"required":["id","displayName"],"additionalProperties":false},"DownloadUrls":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision the URLs belong to."},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the URLs stop working: 900 seconds after the request started."},"files":{"type":"array","items":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/ExportFile","description":"The file's metadata."},"url":{"type":"string","format":"uri","description":"Short-lived download URL. It supports Range requests."}},"required":["file","url"],"additionalProperties":false},"description":"One entry per requested file."}},"required":["revision","expiresAt","files"],"additionalProperties":false,"examples":[{"revision":2,"expiresAt":"2026-11-03T09:52:10.000Z","files":[{"file":{"id":"cm3ka1d7e0040fl05m3p8s2qb","kind":"ARCHIVE","sequence":1,"filename":"H4TR-8KWN-r2.zip","mimeType":"application/zip","sizeBytes":"231560448","checksumSha256":"bed1e83c510923047c50f280b0b306cd761dc670f9423e05614e2333d41121a0","widthPx":null,"heightPx":null,"dpi":null},"url":"https://downloads.example.com/exports/H4TR-8KWN/2/H4TR-8KWN-r2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20261103T093710Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=1a2fc26dc7ea5a2a4748b7cb2b1ef193d96ab2c99f93092f69e63075b28d1278"}]}]},"ExportConfirmation":{"type":"object","properties":{"reference":{"type":"string","description":"The confirmed export's reference."},"labOrder":{"$ref":"#/components/schemas/LabOrder","description":"The order as now stored."},"lockedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the album was locked."},"changed":{"type":"boolean","description":"False when the album was already locked with these identifiers; no event is sent then."}},"required":["reference","labOrder","lockedAt","changed"],"additionalProperties":false,"examples":[{"reference":"H4TR-8KWN","labOrder":{"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","externalOrderLineId":"wc_item_31877","confirmedByLab":true,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"lockedAt":"2026-11-03T10:05:12.000Z","changed":true}]},"ExportUnlock":{"type":"object","properties":{"reference":{"type":"string","description":"The unlocked export's reference."},"lockedAt":{"type":"null","description":"Always null after unlocking."},"changed":{"type":"boolean","description":"False when the album was already unlocked."}},"required":["reference","lockedAt","changed"],"additionalProperties":false,"examples":[{"reference":"H4TR-8KWN","lockedAt":null,"changed":true}]},"ExportReceipt":{"type":"object","properties":{"reference":{"type":"string","description":"The export's reference."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision whose receipt was recorded."},"receivedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the receipt was first recorded. A repeat keeps this time."},"changed":{"type":"boolean","description":"False on a repeat. Only the first call sends `export.received`."}},"required":["reference","revision","receivedAt","changed"],"additionalProperties":false,"examples":[{"reference":"H4TR-8KWN","revision":2,"receivedAt":"2026-11-03T09:58:44.000Z","changed":true}]},"Webhook":{"type":"object","properties":{"id":{"type":"string","description":"Endpoint ID, used in the paths of the other webhook operations."},"label":{"type":"string","description":"Your name for the endpoint."},"url":{"type":"string","description":"The HTTPS address deliveries are sent to, normalized."},"eventTypes":{"type":"array","items":{"type":"string"},"description":"Subscribed event types, or `[\"*\"]` for every current and future type. Either way, only events of the lab's enabled modules that this key can read are delivered. `[]` receives only test pings."},"enabled":{"type":"boolean","description":"False when disabled: the endpoint then receives nothing and cannot be tested."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the endpoint was created."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the endpoint was last changed."},"lastDelivery":{"anyOf":[{"type":"object","properties":{"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus","description":"PENDING, SUCCEEDED, DEAD after the last failed attempt, or CANCELLED when the endpoint was disabled."},"attemptCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Attempts made so far."},"lastStatusCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"HTTP status of the last attempt. Null when no response arrived."},"lastErrorCode":{"description":"Why the last attempt failed: TIMEOUT, DNS_REJECTED, CONNECT_FAILED, TLS_FAILED, REDIRECT or HTTP_STATUS. Null when it succeeded or nothing was attempted.","type":["string","null"]},"lastAttemptAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the last attempt was made. Null before the first."}},"required":["status","attemptCount","lastStatusCode","lastErrorCode","lastAttemptAt"],"additionalProperties":false},{"type":"null"}],"description":"The most recently created delivery, test pings included. Null before the first."},"deadDeliveries":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Retained event deliveries that failed all eight attempts. Test pings are not counted, and a resend removes a delivery from the count."},"latestAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest of them failed for the last time. Null when `count` is 0."}},"required":["count","latestAt"],"additionalProperties":false,"description":"Retained event deliveries that failed all eight attempts. A delivery record is kept at most 30 days after it finishes, and is removed earlier, together with its event, when that event leaves the feed's 30-day window."}},"required":["id","label","url","eventTypes","enabled","createdAt","updatedAt","lastDelivery","deadDeliveries"],"additionalProperties":false,"examples":[{"id":"cm3kb5h2c0007wh03v6y1z4pn","label":"Order sync","url":"https://hooks.example.com/spreadu","eventTypes":["export.available","export.withdrawn"],"enabled":false,"createdAt":"2026-11-01T12:00:00.000Z","updatedAt":"2026-11-05T07:45:00.000Z","lastDelivery":{"status":"SUCCEEDED","attemptCount":1,"lastStatusCode":204,"lastErrorCode":null,"lastAttemptAt":"2026-11-02T08:41:29.000Z"},"deadDeliveries":{"count":0,"latestAt":null}}]},"WebhookWithSecret":{"type":"object","properties":{"id":{"type":"string","description":"Endpoint ID, used in the paths of the other webhook operations."},"label":{"type":"string","description":"Your name for the endpoint."},"url":{"type":"string","description":"The HTTPS address deliveries are sent to, normalized."},"eventTypes":{"type":"array","items":{"type":"string"},"description":"Subscribed event types, or `[\"*\"]` for every current and future type. Either way, only events of the lab's enabled modules that this key can read are delivered. `[]` receives only test pings."},"enabled":{"type":"boolean","description":"False when disabled: the endpoint then receives nothing and cannot be tested."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the endpoint was created."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the endpoint was last changed."},"lastDelivery":{"anyOf":[{"type":"object","properties":{"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus","description":"PENDING, SUCCEEDED, DEAD after the last failed attempt, or CANCELLED when the endpoint was disabled."},"attemptCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Attempts made so far."},"lastStatusCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"HTTP status of the last attempt. Null when no response arrived."},"lastErrorCode":{"description":"Why the last attempt failed: TIMEOUT, DNS_REJECTED, CONNECT_FAILED, TLS_FAILED, REDIRECT or HTTP_STATUS. Null when it succeeded or nothing was attempted.","type":["string","null"]},"lastAttemptAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the last attempt was made. Null before the first."}},"required":["status","attemptCount","lastStatusCode","lastErrorCode","lastAttemptAt"],"additionalProperties":false},{"type":"null"}],"description":"The most recently created delivery, test pings included. Null before the first."},"deadDeliveries":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Retained event deliveries that failed all eight attempts. Test pings are not counted, and a resend removes a delivery from the count."},"latestAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest of them failed for the last time. Null when `count` is 0."}},"required":["count","latestAt"],"additionalProperties":false,"description":"Retained event deliveries that failed all eight attempts. A delivery record is kept at most 30 days after it finishes, and is removed earlier, together with its event, when that event leaves the feed's 30-day window."},"secret":{"type":"string","format":"starts_with","pattern":"^whsec_.*","description":"The signing secret. It is shown only in this response; store it now."}},"required":["id","label","url","eventTypes","enabled","createdAt","updatedAt","lastDelivery","deadDeliveries","secret"],"additionalProperties":false,"examples":[{"id":"cm3kb5h2c0007wh03v6y1z4pn","label":"Order sync","url":"https://hooks.example.com/spreadu","eventTypes":["export.available","export.withdrawn"],"enabled":true,"createdAt":"2026-11-01T12:00:00.000Z","updatedAt":"2026-11-01T12:00:00.000Z","lastDelivery":null,"deadDeliveries":{"count":0,"latestAt":null},"secret":"whsec_c2FuZGJveC1leGFtcGxlLXNlY3JldC0wMDAx"}]},"WebhookList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"},"description":"The endpoints this key created, newest first."}},"required":["items"],"additionalProperties":false,"examples":[{"items":[{"id":"cm3kb5h2c0007wh03v6y1z4pn","label":"Order sync","url":"https://hooks.example.com/spreadu","eventTypes":["export.available","export.withdrawn"],"enabled":true,"createdAt":"2026-11-01T12:00:00.000Z","updatedAt":"2026-11-01T12:00:00.000Z","lastDelivery":{"status":"SUCCEEDED","attemptCount":1,"lastStatusCode":204,"lastErrorCode":null,"lastAttemptAt":"2026-11-02T08:41:29.000Z"},"deadDeliveries":{"count":0,"latestAt":null}}]}]},"WebhookDeliveryStatus":{"type":"string","enum":["PENDING","SUCCEEDED","DEAD","CANCELLED"]},"WebhookDeletion":{"type":"object","properties":{"id":{"type":"string","description":"The deleted endpoint's ID."},"deleted":{"type":"boolean","const":true,"description":"Always true."}},"required":["id","deleted"],"additionalProperties":false,"examples":[{"id":"cm3kb5h2c0007wh03v6y1z4pn","deleted":true}]},"WebhookTest":{"type":"object","properties":{"eventId":{"type":"string","format":"starts_with","pattern":"^ping_.*","description":"The queued ping's ID, also its `webhook-id` header and body `id`."}},"required":["eventId"],"additionalProperties":false,"examples":[{"eventId":"ping_cm3kc2w8r0012dl04x5j7n3qt"}]},"EventExportSummary":{"type":"object","properties":{"reference":{"type":"string","description":"The export's reference, the code the photographer gives your lab, such as H4TR-8KWN. It never changes."},"albumId":{"type":"string","description":"ID of the album the export came from."},"albumTitle":{"type":"string","description":"Photographer-chosen title from the newest revision. It can include a client's name."},"correctionOpen":{"type":"boolean","description":"True while the photographer prepares a correction."},"downloadableRevision":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The revision you can download now. Null when none is downloadable."},"lockedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When your lab confirmed the order and locked the album. Null while unlocked."},"latestRevision":{"anyOf":[{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Revision number."},"status":{"$ref":"#/components/schemas/ExportRevisionStatus","description":"Status of that revision."}},"required":["revision","status"],"additionalProperties":false},{"type":"null"}],"description":"The newest visible revision. Null before the first."},"labOrder":{"anyOf":[{"type":"object","properties":{"orderNumber":{"description":"Your lab's order number, from the photographer or your confirmation. Null when none.","type":["string","null"]},"externalOrderId":{"description":"Your system's order ID. Null when none.","type":["string","null"]},"externalOrderLineId":{"description":"Your system's order line ID. Null when none.","type":["string","null"]},"confirmedByLab":{"type":"boolean","description":"True when your lab's API confirmation set these identifiers. Use `lockedAt`, not this field, to tell whether editing is locked."},"orderedQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Album length in pages or spreads, not printed copies. Null when not set. Same value as `orderedLength.count`."},"orderedQuantityUnit":{"anyOf":[{"type":"string","enum":["PAGES","SPREADS"]},{"type":"null"}],"description":"Unit of `orderedQuantity`. Null when not set."},"orderedLength":{"anyOf":[{"$ref":"#/components/schemas/OrderedLength"},{"type":"null"}],"description":"Album length as one object. Null when the length or its unit is not set."},"orderedCopies":{"anyOf":[{"type":"integer","minimum":1,"maximum":999},{"type":"null"}],"description":"Printed copies the photographer entered, 1 to 999, or null. Informational: Spreadu never enforces it."}},"required":["orderNumber","externalOrderId","externalOrderLineId","confirmedByLab","orderedQuantity","orderedQuantityUnit"],"additionalProperties":false},{"type":"null"}],"description":"The order context. Null when there was none. Events sequenced before v1.1 lack `orderedLength` and `orderedCopies`."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the album was set up for your lab."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Latest change to the export, its order or its newest revision. `updatedSince` filters on it."},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the downloadable revision became available. Null when nothing is downloadable."},"downloadableUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last moment to download that revision. Null when nothing is downloadable."},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When you recorded receiving the downloadable revision. Null until then or when nothing is downloadable."},"photographer":{"anyOf":[{"$ref":"#/components/schemas/Photographer"},{"type":"null"}],"description":"The photographer. Null while no revision is visible."}},"required":["reference","albumId","albumTitle","correctionOpen","downloadableRevision","lockedAt","latestRevision","labOrder"],"additionalProperties":false},"EventExportRevision":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Revision number. Numbers increase and can skip failed render attempts."},"status":{"$ref":"#/components/schemas/ExportRevisionStatus","description":"PREPARING while files render, AVAILABLE once published, WITHDRAWN after a correction or lost files, EXPIRED after the download window."},"current":{"type":"boolean","description":"True for the export's current revision."},"downloadable":{"type":"boolean","description":"True while its files can be downloaded: current, AVAILABLE and inside the download window."},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When its files were published. Null if it never became available."},"withdrawnAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was withdrawn. Null if it was not."},"downloadableUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last moment to download its files: the earlier of the download expiry and the file deletion time. Null when no deadline is set."},"product":{"type":"object","properties":{"id":{"type":"string","description":"Catalog ID."},"name":{"type":"string","description":"Name as frozen with the revision."}},"required":["id","name"],"additionalProperties":false,"description":"The catalog product, frozen when the revision was submitted."},"spec":{"type":"object","properties":{"id":{"type":"string","description":"Catalog ID."},"name":{"type":"string","description":"Name as frozen with the revision."}},"required":["id","name"],"additionalProperties":false,"description":"The product specification, frozen when the revision was submitted."},"spreadCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of spreads that were rendered."},"output":{"type":"object","properties":{"format":{"type":"string","enum":["JPG","PDF","PNG","TIFF"],"description":"File format of the production files."},"unit":{"type":"string","enum":["PAGES","SPREADS"],"description":"Whether each file holds one page or one spread."},"colorSpace":{"type":"string","enum":["sRGB","AdobeRGB","ProPhotoRGB"],"description":"Color space of the production files."},"dpi":{"type":"number","exclusiveMinimum":0,"description":"Render resolution in dots per inch."}},"required":["format","unit","colorSpace","dpi"],"additionalProperties":false,"description":"How the production files were rendered."},"parts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["INNER","COVER"],"description":"INNER for the album's pages or spreads, COVER for its cover."},"geometry":{"anyOf":[{"type":"object","properties":{"dpi":{"type":"number","description":"Resolution that relates the stored pixels to physical size."},"widthPx":{"type":"number","description":"Layout width in pixels, as stored. Authoritative."},"heightPx":{"type":"number","description":"Layout height in pixels, as stored. Authoritative."},"pageWidthPx":{"description":"Width of one page in pixels. Null when it is not stored.","type":["number","null"]},"pageHeightPx":{"description":"Height of one page in pixels. Null when it is not stored.","type":["number","null"]},"trimWidthPx":{"description":"Trim width in pixels. Null when it is not stored.","type":["number","null"]},"trimHeightPx":{"description":"Trim height in pixels. Null when it is not stored.","type":["number","null"]},"innerBleedPx":{"description":"Bleed at the inner edge in pixels. Null when it is not stored.","type":["number","null"]},"outerBleedPx":{"description":"Bleed at the outer edge in pixels; for a cover, its bleed. Null when it is not stored.","type":["number","null"]},"spineWidthPx":{"description":"Spine width in pixels. Null when it is not stored.","type":["number","null"]},"mm":{"anyOf":[{"$ref":"#/components/schemas/ExportGeometryMillimetres"},{"type":"null"}],"description":"The same dimensions in millimetres. Null only when the stored DPI is not positive."}},"required":["dpi","widthPx","heightPx","pageWidthPx","pageHeightPx","trimWidthPx","trimHeightPx","innerBleedPx","outerBleedPx","spineWidthPx"],"additionalProperties":false},{"type":"null"}],"description":"Frozen dimensions of this part. Null when the revision has no valid stored specification for it. Events sequenced before v1.1 lack `mm`."},"files":{"type":"array","items":{"$ref":"#/components/schemas/ExportFile"},"description":"Production files of this part. Empty while the revision is not downloadable."}},"required":["kind","geometry","files"],"additionalProperties":false},"description":"Rendered parts: always INNER, plus COVER when the album has a cover."},"packages":{"type":"array","items":{"$ref":"#/components/schemas/ExportFile"},"description":"The complete ZIP and, for PDF output, the combined PDF. Empty while the revision is not downloadable."},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When your lab recorded receiving this revision. Null until then."},"order":{"anyOf":[{"$ref":"#/components/schemas/ExportRevisionOrder"},{"type":"null"}],"description":"Order facts frozen when the revision was submitted. Null when the album had no order then."}},"required":["revision","status","current","downloadable","availableAt","withdrawnAt","downloadableUntil","product","spec","spreadCount","output","parts","packages"],"additionalProperties":false},"SandboxExportCommand":{"type":"object","properties":{"reference":{"type":"string","description":"The sandbox export's reference."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision the command created or acted on."}},"required":["reference","revision"],"additionalProperties":false,"examples":[{"reference":"H4TR-8KWN","revision":1}]},"SandboxReset":{"type":"object","properties":{"deletedExports":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of sandbox exports deleted."}},"required":["deletedExports"],"additionalProperties":false,"examples":[{"deletedExports":3}]},"PrintLabEvent_export_requested":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision submitted for preparation."}},"required":["export","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.requested","description":"A revision was submitted for preparation."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18400000ev06q4w8r2tz","occurredAt":"2026-11-02T08:30:02.000Z","sequence":"1840","type":"export.requested","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":null,"lockedAt":null,"latestRevision":{"revision":2,"status":"PREPARING"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-02T08:30:02.000Z","availableAt":null,"downloadableUntil":null,"receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"revision":2}}]},"PrintLabEvent_export_available":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."},"revision":{"$ref":"#/components/schemas/EventExportRevision","description":"The revision that became available, with its files, so you can request download URLs directly."}},"required":["export","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.available","description":"A revision became available."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18420000ev06q4w8r2tz","occurredAt":"2026-11-02T08:41:27.000Z","sequence":"1842","type":"export.available","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-02T08:41:27.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"revision":{"revision":2,"status":"AVAILABLE","current":true,"downloadable":true,"availableAt":"2026-11-02T08:41:27.000Z","withdrawnAt":null,"downloadableUntil":"2026-12-02T08:41:27.000Z","product":{"id":"cm2r7d1xk0000pd01h4q8z6wc","name":"Layflat Album 30x30"},"spec":{"id":"cm2r7e5vn0002sp01b9k3t7xm","name":"30x30 cm, 12 spreads"},"spreadCount":12,"output":{"format":"JPG","unit":"SPREADS","colorSpace":"sRGB","dpi":300},"receivedAt":null,"order":{"orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"parts":[{"kind":"INNER","geometry":{"dpi":300,"widthPx":7157,"heightPx":3613,"pageWidthPx":null,"pageHeightPx":null,"trimWidthPx":7087,"trimHeightPx":3543,"innerBleedPx":null,"outerBleedPx":35,"spineWidthPx":null,"mm":{"width":606,"height":305.9,"pageWidth":null,"pageHeight":null,"trimWidth":600,"trimHeight":300,"innerBleed":null,"outerBleed":3,"spineWidth":null}},"files":[{"id":"cm3ka1d7e0020fl05m3p8s2qb","kind":"FILE","sequence":1,"filename":"H4TR-8KWN-r2-spread-01.jpg","mimeType":"image/jpeg","sizeBytes":"18734221","checksumSha256":"097f575c8ffae51d5246787732eed27728397e578f7267ca151f7def3b6d38fc","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0021fl05m3p8s2qb","kind":"FILE","sequence":2,"filename":"H4TR-8KWN-r2-spread-02.jpg","mimeType":"image/jpeg","sizeBytes":"18872132","checksumSha256":"d13dc5f91f401bb2350d448ecf95bb3fcc02f7348d077b1a4d6e142b3a802f00","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0022fl05m3p8s2qb","kind":"FILE","sequence":3,"filename":"H4TR-8KWN-r2-spread-03.jpg","mimeType":"image/jpeg","sizeBytes":"19010043","checksumSha256":"bf6dce0fd51932ab84e900580f199692aa8874e62e24f79c7272841c3c93c9a7","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0023fl05m3p8s2qb","kind":"FILE","sequence":4,"filename":"H4TR-8KWN-r2-spread-04.jpg","mimeType":"image/jpeg","sizeBytes":"19147954","checksumSha256":"75eaf06ad84051718ade8dd77ea54bb96feef4a6bc06df63a239ca4f3d8faa5d","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0024fl05m3p8s2qb","kind":"FILE","sequence":5,"filename":"H4TR-8KWN-r2-spread-05.jpg","mimeType":"image/jpeg","sizeBytes":"19285865","checksumSha256":"62dae1345145165c442c5992841fc7c301f87f06e73b888a18d1fb77f7108489","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0025fl05m3p8s2qb","kind":"FILE","sequence":6,"filename":"H4TR-8KWN-r2-spread-06.jpg","mimeType":"image/jpeg","sizeBytes":"19423776","checksumSha256":"affa5fab7331af23eee57f233ee58892260d930d906095fa3643b5cb982dd252","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0026fl05m3p8s2qb","kind":"FILE","sequence":7,"filename":"H4TR-8KWN-r2-spread-07.jpg","mimeType":"image/jpeg","sizeBytes":"19561687","checksumSha256":"07f058e33ce39b2f9644f7a7cae9d3b6a8cac61ad81d9aec50849137104d4f69","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0027fl05m3p8s2qb","kind":"FILE","sequence":8,"filename":"H4TR-8KWN-r2-spread-08.jpg","mimeType":"image/jpeg","sizeBytes":"19699598","checksumSha256":"1834a77e7e7fa1892cf4a0a09a18c319e34d5b8bbc9fe9fe55f5d4fc2ba76b41","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0028fl05m3p8s2qb","kind":"FILE","sequence":9,"filename":"H4TR-8KWN-r2-spread-09.jpg","mimeType":"image/jpeg","sizeBytes":"19837509","checksumSha256":"d1fd5b473556383c3e014cea08942337f005af79563b5f652e57cc1c8e54a61d","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0029fl05m3p8s2qb","kind":"FILE","sequence":10,"filename":"H4TR-8KWN-r2-spread-10.jpg","mimeType":"image/jpeg","sizeBytes":"19975420","checksumSha256":"f944939fa3293350ccde5cdd252ea790eaf7d45fb7b4e94d8927cdb6048c82b8","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0030fl05m3p8s2qb","kind":"FILE","sequence":11,"filename":"H4TR-8KWN-r2-spread-11.jpg","mimeType":"image/jpeg","sizeBytes":"20113331","checksumSha256":"e86c0cb687cceb9c08dff7b948fcb7a937c351d0073864504e95d990c0bc82fa","widthPx":7157,"heightPx":3613,"dpi":300},{"id":"cm3ka1d7e0031fl05m3p8s2qb","kind":"FILE","sequence":12,"filename":"H4TR-8KWN-r2-spread-12.jpg","mimeType":"image/jpeg","sizeBytes":"20251242","checksumSha256":"b64906f4243f3d79d5ba90bd1f49d001f5dbe8df0e2b340d9e6f4085054c36e5","widthPx":7157,"heightPx":3613,"dpi":300}]}],"packages":[{"id":"cm3ka1d7e0040fl05m3p8s2qb","kind":"ARCHIVE","sequence":1,"filename":"H4TR-8KWN-r2.zip","mimeType":"application/zip","sizeBytes":"231560448","checksumSha256":"bed1e83c510923047c50f280b0b306cd761dc670f9423e05614e2333d41121a0","widthPx":null,"heightPx":null,"dpi":null}]}}}]},"PrintLabEvent_export_withdrawn":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."},"reason":{"type":"string","enum":["correction_opened","files_unavailable"],"description":"`correction_opened` when the photographer opened a correction, `files_unavailable` when the files can no longer be served."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The withdrawn revision."}},"required":["export","reason","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.withdrawn","description":"A correction opened or files became unavailable."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18380000ev06q4w8r2tz","occurredAt":"2026-10-31T16:20:03.000Z","sequence":"1838","type":"export.withdrawn","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":true,"downloadableRevision":null,"lockedAt":null,"latestRevision":{"revision":1,"status":"WITHDRAWN"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-10-31T16:20:03.000Z","availableAt":null,"downloadableUntil":null,"receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"reason":"correction_opened","revision":1}}]},"PrintLabEvent_export_expiring":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."},"downloadableUntil":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"The revision's download deadline."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision approaching its deadline."}},"required":["export","downloadableUntil","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.expiring","description":"A revision is approaching its download deadline."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18740000ev06q4w8r2tz","occurredAt":"2026-11-29T08:41:27.000Z","sequence":"1874","type":"export.expiring","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","externalOrderLineId":"wc_item_31877","confirmedByLab":true,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-04T15:30:00.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":"2026-11-03T09:58:44.000Z","photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"downloadableUntil":"2026-12-02T08:41:27.000Z","revision":2}}]},"PrintLabEvent_export_expired":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision whose download window ended."}},"required":["export","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.expired","description":"A download window ended."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18800000ev06q4w8r2tz","occurredAt":"2026-12-02T08:41:27.000Z","sequence":"1880","type":"export.expired","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":null,"lockedAt":null,"latestRevision":{"revision":2,"status":"EXPIRED"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","externalOrderLineId":"wc_item_31877","confirmedByLab":true,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-12-02T08:41:27.000Z","availableAt":null,"downloadableUntil":null,"receivedAt":null,"photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"revision":2}}]},"PrintLabEvent_export_confirmed":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision your lab confirmed."}},"required":["export","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.confirmed","description":"Your lab confirmed order identifiers or acquired the album lock."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18460000ev06q4w8r2tz","occurredAt":"2026-11-03T10:05:12.000Z","sequence":"1846","type":"export.confirmed","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":"2026-11-03T10:05:12.000Z","latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","externalOrderLineId":"wc_item_31877","confirmedByLab":true,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-03T10:05:12.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":"2026-11-03T09:58:44.000Z","photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"revision":2}}]},"PrintLabEvent_export_unlocked":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/EventExportSummary","description":"The export as it was when the event was sequenced. Events sequenced before v1.1 lack some fields; treat a missing field as unknown."}},"required":["export"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.unlocked","description":"The lab lock was released."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18510000ev06q4w8r2tz","occurredAt":"2026-11-04T15:30:00.000Z","sequence":"1851","type":"export.unlocked","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":"wc_order_10482","externalOrderLineId":"wc_item_31877","confirmedByLab":true,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-04T15:30:00.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":"2026-11-03T09:58:44.000Z","photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}}}}]},"PrintLabEvent_export_received":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^evt_.*","description":"Stable event ID, also sent as the `webhook-id` header. Deduplicate on it."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change happened."},"sequence":{"description":"Position in your lab's event stream, a decimal string. Order events by it.","type":"string"},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{"export":{"$ref":"#/components/schemas/ExportSummary","description":"The export as it was when the event was sequenced. Always complete."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision whose files your lab recorded receiving."}},"required":["export","revision"],"additionalProperties":false,"description":"What changed."},"type":{"type":"string","const":"export.received","description":"Your lab recorded receiving a revision's files."}},"required":["id","occurredAt","sequence","version","data","type"],"additionalProperties":false,"examples":[{"id":"evt_cm3kd18450000ev06q4w8r2tz","occurredAt":"2026-11-03T09:58:44.000Z","sequence":"1845","type":"export.received","version":1,"data":{"export":{"reference":"H4TR-8KWN","albumId":"cm3k8p4rz0011ab07q2w5n8vd","albumTitle":"Garden wedding, June 2026","correctionOpen":false,"downloadableRevision":2,"lockedAt":null,"latestRevision":{"revision":2,"status":"AVAILABLE"},"labOrder":{"orderNumber":"WC-10482","externalOrderId":null,"externalOrderLineId":null,"confirmedByLab":false,"orderedQuantity":12,"orderedQuantityUnit":"SPREADS","orderedLength":{"count":12,"unit":"SPREADS"},"orderedCopies":2},"createdAt":"2026-10-28T14:02:11.000Z","updatedAt":"2026-11-03T09:58:44.000Z","availableAt":"2026-11-02T08:41:27.000Z","downloadableUntil":"2026-12-02T08:41:27.000Z","receivedAt":"2026-11-03T09:58:44.000Z","photographer":{"id":"cm3k8n1fy0004cs02j7t6r9xe","displayName":"Robin Example"}},"revision":2}}]},"PrintLabEvent_ping":{"type":"object","properties":{"id":{"type":"string","format":"starts_with","pattern":"^ping_.*","description":"Ping ID, also sent as the `webhook-id` header."},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the test was requested."},"sequence":{"type":"string","const":"0","description":"Always \"0\": a ping is outside the event stream. Never move your cursor from it."},"type":{"type":"string","const":"ping","description":"A test delivery."},"version":{"type":"number","const":1,"description":"Envelope version, 1 for every v1 event."},"data":{"type":"object","properties":{},"additionalProperties":false,"description":"Always empty."}},"required":["id","occurredAt","sequence","type","version","data"],"additionalProperties":false,"examples":[{"id":"ping_cm3kc2w8r0012dl04x5j7n3qt","occurredAt":"2026-11-01T12:01:05.000Z","sequence":"0","type":"ping","version":1,"data":{}}]}}},"tags":[{"name":"core","description":"Lab identity, event feed and webhooks"},{"name":"sandbox","description":"Test-mode photographer simulator"},{"name":"exports","description":"Album exports"},{"name":"webhook-events","description":"Requests Spreadu sends to your webhook endpoints. Your receiver implements them; your client never calls them."}],"webhooks":{"export.requested":{"post":{"operationId":"receive_export_requested","summary":"Receive export.requested","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_requested"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.available":{"post":{"operationId":"receive_export_available","summary":"Receive export.available","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_available"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.withdrawn":{"post":{"operationId":"receive_export_withdrawn","summary":"Receive export.withdrawn","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_withdrawn"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.expiring":{"post":{"operationId":"receive_export_expiring","summary":"Receive export.expiring","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_expiring"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.expired":{"post":{"operationId":"receive_export_expired","summary":"Receive export.expired","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_expired"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.confirmed":{"post":{"operationId":"receive_export_confirmed","summary":"Receive export.confirmed","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_confirmed"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.unlocked":{"post":{"operationId":"receive_export_unlocked","summary":"Receive export.unlocked","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_unlocked"}}}},"responses":{"200":{"description":"Event accepted"}}}},"export.received":{"post":{"operationId":"receive_export_received","summary":"Receive export.received","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_export_received"}}}},"responses":{"200":{"description":"Event accepted"}}}},"ping":{"post":{"operationId":"receive_ping","summary":"Receive ping","tags":["webhook-events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintLabEvent_ping"}}}},"responses":{"200":{"description":"Event accepted"}}}}},"openapi":"3.1.1","paths":{"/me":{"get":{"operationId":"getMe","summary":"Read the lab, key and enabled modules","tags":["core"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/events":{"get":{"operationId":"listEvents","summary":"Read events after a cursor, optionally waiting for changes","tags":["core"],"parameters":[{"name":"after","in":"query","schema":{"type":"string","maxLength":19,"pattern":"^(0|[1-9][0-9]*)$"},"allowEmptyValue":true,"allowReserved":true,"description":"Return events after this cursor: the previous page's `nextCursor`. Omit to start at the oldest retained event."},{"name":"limit","in":"query","schema":{"default":100,"type":"integer","minimum":1,"maximum":200},"allowEmptyValue":true,"allowReserved":true,"description":"Maximum events per page, 1 to 200."},{"name":"types","in":"query","schema":{"type":"array","items":{"type":"string","enum":["export.requested","export.available","export.withdrawn","export.expiring","export.expired","export.confirmed","export.unlocked","export.received"]}},"style":"form","explode":true,"allowEmptyValue":true,"allowReserved":true,"description":"Only these event types. Repeat the parameter for several: `types=export.available&types=export.withdrawn`."},{"name":"wait","in":"query","schema":{"default":0,"type":"number","minimum":0,"maximum":30},"allowEmptyValue":true,"allowReserved":true,"description":"Seconds to wait for an event when none is ready, 0 to 30."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"410":{"description":"410","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CursorExpiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/exports/{reference}/confirmation":{"put":{"operationId":"confirmExport","summary":"Confirm the lab's order and lock its export","tags":["exports"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","examples":["H4TR-8KWN"]},"description":"The export reference. Any case, with or without the hyphen."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmExportRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportConfirmation"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/RevisionNotDownloadableError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/exports":{"get":{"operationId":"listExports","summary":"List the lab's exports","tags":["exports"],"parameters":[{"name":"downloadable","in":"query","schema":{"type":"boolean"},"allowEmptyValue":true,"allowReserved":true,"description":"`true`: the current revision can be downloaded now. `false` matches every other export."},{"name":"locked","in":"query","schema":{"type":"boolean"},"allowEmptyValue":true,"allowReserved":true,"description":"`true`: your lab holds the lock (`lockedAt` is set). `false` matches every other export."},{"name":"confirmed","in":"query","schema":{"type":"boolean"},"allowEmptyValue":true,"allowReserved":true,"description":"`true`: your lab confirmed the order (`labOrder.confirmedByLab`). `false` matches every other export."},{"name":"received","in":"query","schema":{"type":"boolean"},"allowEmptyValue":true,"allowReserved":true,"description":"`true`: you recorded a receipt for the downloadable revision. `false` matches every other export."},{"name":"updatedSince","in":"query","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"allowEmptyValue":true,"allowReserved":true,"description":"Only exports whose `updatedAt` is at or after this time. Accepts Z or an offset; encode `+` as %2B."},{"name":"orderNumber","in":"query","schema":{"type":"string","minLength":1,"maxLength":120},"allowEmptyValue":true,"allowReserved":true,"description":"Only exports whose `labOrder.orderNumber` equals this value exactly."},{"name":"externalOrderId","in":"query","schema":{"type":"string","minLength":1,"maxLength":120},"allowEmptyValue":true,"allowReserved":true,"description":"Only exports whose `labOrder.externalOrderId` equals this value exactly."},{"name":"limit","in":"query","schema":{"default":50,"type":"integer","minimum":1,"maximum":100},"allowEmptyValue":true,"allowReserved":true,"description":"Page size, 1 to 100."},{"name":"cursor","in":"query","schema":{"type":"string"},"allowEmptyValue":true,"allowReserved":true,"description":"`nextCursor` from the previous page. It encodes no filter, so filters can change between pages."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportList"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/exports/{reference}":{"get":{"operationId":"getExport","summary":"Read an export and its revisions","tags":["exports"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","examples":["H4TR-8KWN"]},"description":"The export reference. Any case, with or without the hyphen."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/exports/{reference}/download-urls":{"post":{"operationId":"createDownloadUrls","summary":"Issue download URLs for an exact export revision","tags":["exports"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","examples":["H4TR-8KWN"]},"description":"The export reference. Any case, with or without the hyphen."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDownloadUrlsRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadUrls"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/FileNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/RevisionNotDownloadableError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/exports/{reference}/receipt":{"put":{"operationId":"recordExportReceipt","summary":"Record that the lab received a revision's files","tags":["exports"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","examples":["H4TR-8KWN"]},"description":"The export reference. Any case, with or without the hyphen."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordExportReceiptRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportReceipt"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/RevisionNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/exports/{reference}/lock":{"delete":{"operationId":"unlockExport","summary":"Unlock the album for photographer changes","tags":["exports"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","examples":["H4TR-8KWN"]},"description":"The export reference. Any case, with or without the hyphen."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUnlock"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/webhooks":{"get":{"operationId":"listWebhooks","summary":"List the webhook endpoints this key created","tags":["core"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookList"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}},"post":{"operationId":"createWebhook","summary":"Add a webhook endpoint and receive its signing secret once","tags":["core"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookWithSecret"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookUrlExistsError"},{"$ref":"#/components/schemas/EndpointLimitReachedError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ServiceUnavailableError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/webhooks/{webhookId}":{"patch":{"operationId":"updateWebhook","summary":"Change a webhook endpoint's label, URL, events or enabled state","tags":["core"],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["cm3kb5h2c0007wh03v6y1z4pn"]},"description":"The endpoint ID from `GET /webhooks`."}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookUrlExistsError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ServiceUnavailableError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}},"delete":{"operationId":"deleteWebhook","summary":"Delete a webhook endpoint and its delivery log","tags":["core"],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["cm3kb5h2c0007wh03v6y1z4pn"]},"description":"The endpoint ID from `GET /webhooks`."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeletion"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/webhooks/{webhookId}/secret":{"post":{"operationId":"rotateWebhookSecret","summary":"Issue a new signing secret; the previous one works for 24 hours","tags":["core"],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["cm3kb5h2c0007wh03v6y1z4pn"]},"description":"The endpoint ID from `GET /webhooks`."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookWithSecret"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ServiceUnavailableError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/webhooks/{webhookId}/test":{"post":{"operationId":"testWebhook","summary":"Send a signed ping to an enabled webhook endpoint","tags":["core"],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["cm3kb5h2c0007wh03v6y1z4pn"]},"description":"The endpoint ID from `GET /webhooks`."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTest"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookDisabledError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/sandbox/exports":{"post":{"operationId":"createSandboxExport","summary":"Create a synthetic export","tags":["sandbox"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSandboxExportRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxExportCommand"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/SandboxExportLimitError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}]}},"/sandbox/exports/{reference}/revisions":{"post":{"operationId":"createSandboxRevision","summary":"Correct and re-export an available revision","tags":["sandbox"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["H4TR-8KWN"]},"description":"Reference of a sandbox export from `createSandboxExport`."},{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxExportCommand"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/SandboxExportLockedError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/sandbox/exports/{reference}/withdraw":{"post":{"operationId":"withdrawSandboxExport","summary":"Withdraw the current export","tags":["sandbox"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["H4TR-8KWN"]},"description":"Reference of a sandbox export from `createSandboxExport`."},{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxExportCommand"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/SandboxExportLockedError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/sandbox/exports/{reference}/order":{"put":{"operationId":"setSandboxOrder","summary":"Set photographer order details","tags":["sandbox"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["H4TR-8KWN"]},"description":"Reference of a sandbox export from `createSandboxExport`."},{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetSandboxOrderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxExportCommand"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/SandboxExportLockedError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/sandbox/exports/{reference}/expiring":{"post":{"operationId":"warnSandboxExpiry","summary":"Emit a retention warning","tags":["sandbox"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["H4TR-8KWN"]},"description":"Reference of a sandbox export from `createSandboxExport`."},{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxExportCommand"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/sandbox/exports/{reference}/expire":{"post":{"operationId":"expireSandboxExport","summary":"Expire the current revision now","tags":["sandbox"],"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","minLength":1,"examples":["H4TR-8KWN"]},"description":"Reference of a sandbox export from `createSandboxExport`."},{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxExportCommand"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExportNotFoundError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}}}},"/sandbox/reset":{"post":{"operationId":"resetSandbox","summary":"Reset exports and integration evidence, keeping keys and webhooks","tags":["sandbox"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetSandboxRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxReset"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidApiKeyError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiAccessDisabledError"},{"$ref":"#/components/schemas/ModuleNotEnabledError"},{"$ref":"#/components/schemas/InsufficientScopeError"},{"$ref":"#/components/schemas/TestModeRequiredError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SandboxBusyError"},{"$ref":"#/components/schemas/IdempotencyConflictError"},{"$ref":"#/components/schemas/SandboxStateConflictError"},{"$ref":"#/components/schemas/UndeclaredError"}]}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"413":{"description":"Request body exceeds 32 KB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeError"}}},"headers":{"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}},"429":{"description":"IP, lab or simulator request allowance exceeded","headers":{"Retry-After":{"description":"Seconds until the request allowance resets","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"Unexpected server fault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"X-RateLimit-Limit":{"description":"Allowance of the most constrained request bucket that admitted or refused this request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in that same bucket. Equal to the limit, with no reset, while the limiter cannot count.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when that same bucket resets.","schema":{"type":"string"}},"Spreadu-Mode":{"description":"The credential environment: test for a request authenticated with a test key, live for every other response.","schema":{"type":"string","enum":["live","test"]}}}}},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique command key. Repeating the same request returns its original response for 30 days. Reusing the key with another request returns 409.","schema":{"type":"string","minLength":1,"maxLength":128}}]}}}}