{
  "openapi": "3.1.0",
  "info": {
    "title": "CharpstAR API",
    "version": "1",
    "description": "Send your products to CharpstAR, follow them through production, and get the finished 3D models, AR links and product images back. Everything is keyed on your own article number. This document describes what is live.",
    "contact": {
      "name": "CharpstAR",
      "email": "contact@charpstar.com",
      "url": "https://charpstar.co/docs"
    }
  },
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
  "servers": [
    {
      "url": "https://platform.charpstar.co"
    }
  ],
  "security": [
    {
      "bearer": []
    }
  ],
  "tags": [
    {
      "name": "Keys",
      "description": "Check your key."
    },
    {
      "name": "Account",
      "description": "Your plan, areas, usage and allowances."
    },
    {
      "name": "Products",
      "description": "Send products in, read and change them, review models."
    },
    {
      "name": "Orders",
      "description": "The batches your products arrived in."
    },
    {
      "name": "Imports",
      "description": "Many products from one file."
    },
    {
      "name": "Assets",
      "description": "Get finished files, links and images out."
    },
    {
      "name": "Jobs",
      "description": "Packshots, scenes, edits, videos and exports on delivered products."
    },
    {
      "name": "Naming",
      "description": "How your files are named."
    },
    {
      "name": "Events",
      "description": "Subscribe to signed events and manage deliveries."
    }
  ],
  "paths": {
    "/api/v1/me": {
      "get": {
        "operationId": "getMe",
        "summary": "Check your key",
        "description": "Which company and scopes this key has, and when it expires. Works with any valid key: use it to check that your key works.",
        "tags": [
          "Keys"
        ],
        "x-required-scope": null,
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Me"
                },
                "examples": {
                  "example1": {
                    "summary": "The key works",
                    "value": {
                      "client": {
                        "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                        "name": "Your Company"
                      },
                      "keyPrefix": "cs_live_Ab3d",
                      "scopes": [
                        "products:read",
                        "products:write",
                        "reviews:write",
                        "assets:read",
                        "webhooks:manage",
                        "account:read"
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/me \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(\"https://platform.charpstar.co/api/v1/me\", {\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` },\n});\nconsole.log(res.status, await res.json());"
          }
        ]
      }
    },
    "/api/v1/account": {
      "get": {
        "operationId": "getAccount",
        "summary": "Your plan, areas and usage",
        "description": "The account summary an agent reads before it orders: the plan, the areas switched on, what was used in the period and what is left per kind, and this token's own limits.",
        "tags": [
          "Account"
        ],
        "x-required-scope": "account:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                },
                "examples": {
                  "example1": {
                    "summary": "A contract with a yearly allowance of new models",
                    "value": {
                      "client": {
                        "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                        "name": "Your Company"
                      },
                      "plan": {
                        "kind": "contract",
                        "name": "standard",
                        "activatedAt": "2026-01-15T00:00:00.000Z"
                      },
                      "areas": [
                        "models",
                        "renders",
                        "ai_studio"
                      ],
                      "period": {
                        "kind": "year",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "endsAt": "2027-01-01T00:00:00.000Z"
                      },
                      "currency": "SEK",
                      "usage": [
                        {
                          "kind": "model_ordered",
                          "used": 182,
                          "allowance": 200,
                          "remaining": 18,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-15T00:00:00.000Z",
                            "endsAt": "2027-01-15T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "model_delivered",
                          "used": 164,
                          "allowance": null,
                          "remaining": null,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "model_replaced",
                          "used": 7,
                          "allowance": 20,
                          "remaining": 13,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "packshot",
                          "used": 1240,
                          "allowance": null,
                          "remaining": null,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "scene",
                          "used": 96,
                          "allowance": null,
                          "remaining": null,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "edit",
                          "used": 31,
                          "allowance": null,
                          "remaining": null,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "video",
                          "used": 12,
                          "allowance": null,
                          "remaining": null,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        },
                        {
                          "kind": "export",
                          "used": 58,
                          "allowance": null,
                          "remaining": null,
                          "period": {
                            "kind": "year",
                            "startsAt": "2026-01-01T00:00:00.000Z",
                            "endsAt": "2027-01-01T00:00:00.000Z"
                          },
                          "unitPrice": null
                        }
                      ],
                      "limits": {
                        "requestsPerMinute": 120,
                        "requestsPerDay": 5000,
                        "writesPerDay": null
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/account \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/account`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { usage } = await res.json();\nconst models = usage.find((line) => line.kind === \"model_ordered\");\nif (models.remaining === 0) console.log(\"No new models until\", models.period.endsAt);"
          }
        ]
      }
    },
    "/api/v1/usage": {
      "get": {
        "operationId": "getUsage",
        "summary": "Usage by kind and day",
        "description": "Usage by kind and by day for a period. Everything is counted, whether it was ordered through the API, an agent or your CharpstAR account.",
        "tags": [
          "Account"
        ],
        "x-required-scope": "account:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, YYYY-MM-DD. Default: the start of the current period.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, YYYY-MM-DD. Default: today.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Usage"
                },
                "examples": {
                  "example1": {
                    "summary": "Two days in October",
                    "value": {
                      "from": "2026-10-01",
                      "to": "2026-10-02",
                      "totals": [
                        {
                          "kind": "model_ordered",
                          "count": 14
                        },
                        {
                          "kind": "model_delivered",
                          "count": 9
                        },
                        {
                          "kind": "model_replaced",
                          "count": 0
                        },
                        {
                          "kind": "packshot",
                          "count": 48
                        },
                        {
                          "kind": "scene",
                          "count": 3
                        },
                        {
                          "kind": "edit",
                          "count": 0
                        },
                        {
                          "kind": "video",
                          "count": 1
                        },
                        {
                          "kind": "export",
                          "count": 2
                        }
                      ],
                      "byDay": [
                        {
                          "date": "2026-10-01",
                          "kind": "model_ordered",
                          "count": 12
                        },
                        {
                          "date": "2026-10-01",
                          "kind": "packshot",
                          "count": 48
                        },
                        {
                          "date": "2026-10-01",
                          "kind": "scene",
                          "count": 3
                        },
                        {
                          "date": "2026-10-02",
                          "kind": "model_delivered",
                          "count": 9
                        },
                        {
                          "date": "2026-10-02",
                          "kind": "model_ordered",
                          "count": 2
                        },
                        {
                          "date": "2026-10-02",
                          "kind": "video",
                          "count": 1
                        },
                        {
                          "date": "2026-10-02",
                          "kind": "export",
                          "count": 2
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Not a day",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "from and to are days, YYYY-MM-DD, at most a year apart.",
                        "details": {
                          "issues": [
                            {
                              "path": "from",
                              "message": "a day, YYYY-MM-DD"
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS \"https://platform.charpstar.co/api/v1/usage?from=2026-10-01&to=2026-10-31\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/usage?from=2026-10-01&to=2026-10-31`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { totals, byDay } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/products": {
      "post": {
        "operationId": "upsertProducts",
        "summary": "Create or update products",
        "description": "Create or update products by article number: one product, or { products: [...] } with up to 50.\n\n- A new article lands in our production team's intake and in your open order.\n- A known article is updated by the ownership rules. Before modelling starts, every field you own is applied. After that, name, category, links, attributes and active still update, and a change to dimensionsCm or source3dUrl becomes a change request.\n- A field you leave out keeps its value.\n- Sending the same product again is safe: it answers unchanged and writes nothing.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/ProductInput"
                  },
                  {
                    "$ref": "#/components/schemas/ProductBatch"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/UpsertResult"
                    },
                    {
                      "$ref": "#/components/schemas/BatchResult"
                    }
                  ]
                },
                "examples": {
                  "example1": {
                    "summary": "Sent again, nothing changed",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "unchanged",
                      "status": "received"
                    }
                  },
                  "example2": {
                    "summary": "Updated; one variant became its own product",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "updated",
                      "status": "received",
                      "variantsCreated": [
                        "CH-1001-B"
                      ]
                    }
                  },
                  "example3": {
                    "summary": "Dimensions changed after modelling started",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "change_request",
                      "status": "in_production",
                      "pendingChanges": [
                        {
                          "field": "dimensionsCm",
                          "from": {
                            "w": 72,
                            "h": 81,
                            "d": 78
                          },
                          "to": {
                            "w": 75,
                            "h": 81,
                            "d": 78
                          },
                          "requestedAt": "2026-10-22T10:00:00.000Z"
                        }
                      ]
                    }
                  },
                  "example4": {
                    "summary": "A batch where every product succeeded",
                    "value": {
                      "results": [
                        {
                          "articleId": "CH-1001",
                          "result": "unchanged",
                          "status": "received",
                          "httpStatus": 200
                        },
                        {
                          "articleId": "CH-1002",
                          "result": "created",
                          "status": "received",
                          "httpStatus": 201
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "201": {
            "description": "Created",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpsertResult"
                },
                "examples": {
                  "example1": {
                    "summary": "A new product",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "created",
                      "status": "received"
                    }
                  }
                }
              }
            }
          },
          "207": {
            "description": "Some items succeeded and some did not",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchResult"
                },
                "examples": {
                  "example1": {
                    "summary": "A batch where one product failed",
                    "value": {
                      "results": [
                        {
                          "articleId": "CH-1001",
                          "result": "updated",
                          "status": "received",
                          "httpStatus": 200
                        },
                        {
                          "articleId": "CH 1002",
                          "result": "refused",
                          "error": {
                            "code": "validation_failed",
                            "message": "The product is not valid. See details.issues.",
                            "details": {
                              "issues": [
                                {
                                  "path": "articleId",
                                  "message": "1-64 characters: letters, digits, '.', '_' or '-', starting with a letter or digit (no spaces or slashes)"
                                }
                              ]
                            }
                          },
                          "httpStatus": 400
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/UpsertResult"
                    },
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ]
                },
                "examples": {
                  "example1": {
                    "summary": "A field is not valid",
                    "value": {
                      "articleId": null,
                      "result": "refused",
                      "error": {
                        "code": "validation_failed",
                        "message": "The product is not valid. See details.issues.",
                        "details": {
                          "issues": [
                            {
                              "path": "name",
                              "message": "Invalid input: expected string, received undefined"
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "402": {
            "description": "Allowance used up (allowance_reached)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpsertResult"
                },
                "examples": {
                  "example1": {
                    "summary": "The allowance of new models is used up",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "refused",
                      "error": {
                        "code": "allowance_reached",
                        "message": "The allowance of new models is used up for this period. Ask your CharpstAR contact to raise it, or wait for the period to start again (resetsAt).",
                        "details": {
                          "kind": "model_ordered",
                          "used": 200,
                          "allowance": 200,
                          "period": "year",
                          "resetsAt": "2027-01-15T00:00:00.000Z"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpsertResult"
                },
                "examples": {
                  "example1": {
                    "summary": "A parallel request is creating the same article",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "refused",
                      "error": {
                        "code": "in_progress",
                        "message": "This article is being created by a parallel request. Retry in a few seconds.",
                        "details": {
                          "retry": true
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "Body too large (too_large)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Body over 4 MB",
                    "value": {
                      "error": {
                        "code": "too_large",
                        "message": "Request body over 4 MB. Send images and 3D files as URLs, and split large batches.",
                        "details": {
                          "maxBytes": 4000000
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/products \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"articleId\": \"CH-1001\",\n    \"externalId\": \"8f2c1a7e-item-guid\",\n    \"name\": \"Oslo lounge chair\",\n    \"category\": \"Furniture\",\n    \"subcategory\": \"Chairs\",\n    \"dimensionsCm\": { \"w\": 72, \"h\": 81, \"d\": 78 },\n    \"variants\": [\n      { \"code\": \"OAK\", \"colour\": \"Oak\" },\n      { \"code\": \"BLACK\", \"colour\": \"Black\", \"articleId\": \"CH-1001-B\" }\n    ],\n    \"referenceImages\": [{ \"url\": \"https://example.com/images/oslo-front.jpg\" }],\n    \"productLink\": \"https://example.com/products/oslo-lounge-chair\",\n    \"active\": true\n  }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(\"https://platform.charpstar.co/api/v1/products\", {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({\n    articleId: \"CH-1001\",\n    name: \"Oslo lounge chair\",\n    category: \"Furniture/Chairs\",\n    dimensionsCm: { w: 72, h: 81, d: 78 },\n    referenceImages: [{ url: \"https://example.com/images/oslo-front.jpg\" }],\n    productLink: \"https://example.com/products/oslo-lounge-chair\",\n  }),\n});\nconsole.log(res.status, await res.json());"
          },
          {
            "lang": "curl",
            "label": "curl, batch",
            "source": "curl -sS https://platform.charpstar.co/api/v1/products \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"products\": [\n    { \"articleId\": \"CH-1001\", \"name\": \"Oslo lounge chair\" },\n    { \"articleId\": \"CH-1002\", \"name\": \"Oslo side table\" }\n  ] }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node, batch",
            "source": "const products = [\n  { articleId: \"CH-1001\", name: \"Oslo lounge chair\" },\n  { articleId: \"CH-1002\", name: \"Oslo side table\" },\n];\nconst res = await fetch(\"https://platform.charpstar.co/api/v1/products\", {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ products }),\n});\nconst { results } = await res.json();\nfor (const r of results) console.log(r.articleId, r.httpStatus, r.result, r.error?.code ?? \"\");"
          }
        ]
      },
      "get": {
        "operationId": "listProducts",
        "summary": "List your products",
        "description": "Your products as we hold them, newest first, with their status and order: the products you sent or ordered, and the models we delivered to you by other ways. Filter by status, by whether a model exists, or by changes since a time.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only products in this status.",
            "schema": {
              "type": "string",
              "enum": [
                "received",
                "in_production",
                "in_review",
                "approved",
                "delivered",
                "cancelled"
              ]
            }
          },
          {
            "name": "has3d",
            "in": "query",
            "required": false,
            "description": "true: only products with a delivered model; false: only products without one.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "Only products that changed after this time (ISO 8601, with a zone): any field, a cancel or a delivery. The list is then oldest change first, like GET /api/v1/assets?since=, and its cursor is that feed's.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Only products in this category.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor of the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductList"
                },
                "examples": {
                  "example1": {
                    "summary": "A page of products",
                    "value": {
                      "products": [
                        {
                          "articleId": "CH-1001",
                          "externalId": "100045",
                          "gtin": "09521234567806",
                          "name": "Oslo lounge chair",
                          "category": "Furniture",
                          "subcategory": "Chairs",
                          "dimensionsCm": {
                            "w": 72,
                            "h": 81,
                            "d": 78
                          },
                          "variants": [
                            {
                              "code": "BLUE",
                              "articleId": "CH-1001-BL",
                              "colour": "Blue",
                              "material": null,
                              "name": null
                            }
                          ],
                          "referenceImages": [
                            {
                              "url": "https://cdn.charpstar.net/YourCompany/Reference/CH-1001-3f9a2c1b.jpg"
                            }
                          ],
                          "source3dUrl": null,
                          "productLink": "https://example.com/products/oslo-lounge-chair",
                          "attributes": {
                            "collection": "Oslo",
                            "season": "AW26"
                          },
                          "releaseAt": null,
                          "active": true,
                          "status": "in_production",
                          "orderId": "4d3c2b1a-0000-4000-8000-000000000011",
                          "pendingChanges": null,
                          "deliveryDate": "2026-11-20",
                          "createdAt": "2026-10-20T09:31:00.000Z",
                          "updatedAt": "2026-10-21T14:02:00.000Z"
                        }
                      ],
                      "nextCursor": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "A bad filter",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "status must be one of received, in_production, in_review, approved, delivered, cancelled."
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS \"https://platform.charpstar.co/api/v1/products?status=received&limit=50\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/products?status=received&limit=50`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { products, nextCursor } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/products/{article}": {
      "get": {
        "operationId": "getProduct",
        "summary": "Read one product",
        "description": "The product as we hold it: your fields, its status, the order it belongs to, and any change waiting for our production team.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "article",
            "in": "path",
            "required": true,
            "description": "Your article number.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Product"
                },
                "examples": {
                  "example1": {
                    "summary": "The product",
                    "value": {
                      "articleId": "CH-1001",
                      "externalId": "100045",
                      "gtin": "09521234567806",
                      "name": "Oslo lounge chair",
                      "category": "Furniture",
                      "subcategory": "Chairs",
                      "dimensionsCm": {
                        "w": 72,
                        "h": 81,
                        "d": 78
                      },
                      "variants": [
                        {
                          "code": "BLUE",
                          "articleId": "CH-1001-BL",
                          "colour": "Blue",
                          "material": null,
                          "name": null
                        }
                      ],
                      "referenceImages": [
                        {
                          "url": "https://cdn.charpstar.net/YourCompany/Reference/CH-1001-3f9a2c1b.jpg"
                        }
                      ],
                      "source3dUrl": null,
                      "productLink": "https://example.com/products/oslo-lounge-chair",
                      "attributes": {
                        "collection": "Oslo",
                        "season": "AW26"
                      },
                      "releaseAt": null,
                      "active": true,
                      "status": "in_production",
                      "orderId": "4d3c2b1a-0000-4000-8000-000000000011",
                      "pendingChanges": null,
                      "deliveryDate": "2026-11-20",
                      "createdAt": "2026-10-20T09:31:00.000Z",
                      "updatedAt": "2026-10-21T14:02:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Not yours or unknown",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No product with this article number in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/products/CH-1001 \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/products/CH-1001`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst product = await res.json();"
          }
        ]
      },
      "patch": {
        "operationId": "patchProduct",
        "summary": "Change some fields of a product",
        "description": "Change only the fields you send. null clears a field you own. The same ownership rules apply as for POST /api/v1/products: a change to dimensionsCm or source3dUrl after modelling has started becomes a change request.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "article",
            "in": "path",
            "required": true,
            "description": "Your article number.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductPatch"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpsertResult"
                },
                "examples": {
                  "example1": {
                    "summary": "Changed",
                    "value": {
                      "articleId": "CH-1001",
                      "result": "updated",
                      "status": "in_production",
                      "orderId": "4d3c2b1a-0000-4000-8000-000000000011"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "A field is not valid",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "The patch is not valid. See details.issues.",
                        "details": {
                          "issues": [
                            {
                              "path": "gtin",
                              "message": "The check digit is wrong."
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown article",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No product with this article number in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X PATCH https://platform.charpstar.co/api/v1/products/CH-1001 \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"name\": \"Oslo lounge chair, oak\", \"productLink\": null }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "await fetch(`https://platform.charpstar.co/api/v1/products/CH-1001`, {\n  method: \"PATCH\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ name: \"Oslo lounge chair, oak\", productLink: null }), // null clears a field you own\n});"
          }
        ]
      }
    },
    "/api/v1/products/{article}/cancel": {
      "post": {
        "operationId": "cancelProduct",
        "summary": "Cancel a product before modelling starts",
        "description": "Stop a product before modelling starts. Its status becomes cancelled, it leaves our production queue, and status.changed is sent. A product that has started answers 409 not_cancellable; talk to your CharpstAR contact instead.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "article",
            "in": "path",
            "required": true,
            "description": "Your article number.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.",
            "schema": {
              "type": "string",
              "maxLength": 128
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CancelResult"
                },
                "examples": {
                  "example1": {
                    "summary": "Cancelled",
                    "value": {
                      "articleId": "CH-1001",
                      "status": "cancelled",
                      "cancelledAt": "2026-10-21T14:02:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown article",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No product with this article number in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Modelling has started",
                    "value": {
                      "error": {
                        "code": "not_cancellable",
                        "message": "Modelling has started; this product cannot be cancelled through the API. Talk to your CharpstAR contact.",
                        "details": {
                          "status": "in_production"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/products/CH-1001/cancel \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/products/CH-1001/cancel`, { method: \"POST\", headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconsole.log(res.status); // 200 cancelled, 409 when modelling has started"
          }
        ]
      }
    },
    "/api/v1/products/{article}/review": {
      "post": {
        "operationId": "reviewProduct",
        "summary": "Approve a model or request changes",
        "description": "Approve a model, or send it back to our 3D team with comments. A model that has passed our quality check waits for your approval (review.requested tells you); one that is not waiting for you answers 409 not_ready.\n\n- approve publishes it, exactly as approving in your CharpstAR account does. asset.approved follows once its files are live. A product with variants is approved with all of them.\n- request_changes sends it back with your comments. Each comment can carry an image, which we copy to your account.\n- From the third change request on the same model, extra revisions will likely be charged. That request is made in your CharpstAR account, where you confirm it; the API answers 409 not_ready.\n- A change to a model that is already delivered is requested the same way. It stays delivered and its links keep working while we make the change. Each one counts against your yearly change allowance (402 allowance_reached once it is used up).",
        "tags": [
          "Products"
        ],
        "x-required-scope": "reviews:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "article",
            "in": "path",
            "required": true,
            "description": "Your article number.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.",
            "schema": {
              "type": "string",
              "maxLength": 128
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReviewRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewResult"
                },
                "examples": {
                  "example1": {
                    "summary": "Approved",
                    "value": {
                      "articleId": "CH-1001",
                      "decision": "approve",
                      "status": "approved",
                      "reviewedAt": "2026-10-21T14:02:00.000Z"
                    }
                  },
                  "example2": {
                    "summary": "Changes to a delivered model",
                    "value": {
                      "articleId": "CH-1001",
                      "decision": "request_changes",
                      "status": "delivered",
                      "reviewedAt": "2026-10-21T14:02:00.000Z"
                    }
                  },
                  "example3": {
                    "summary": "Changes requested",
                    "value": {
                      "articleId": "CH-1001",
                      "decision": "request_changes",
                      "status": "in_production",
                      "reviewedAt": "2026-10-21T14:02:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No comments with request_changes",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "request_changes needs at least one comment.",
                        "details": {
                          "issues": [
                            {
                              "path": "comments",
                              "message": "at least one comment"
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "402": {
            "description": "Allowance used up (allowance_reached)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Changes for the year used up",
                    "value": {
                      "error": {
                        "code": "allowance_reached",
                        "message": "Your changes for this year are used up. Ask your CharpstAR contact to raise the allowance.",
                        "details": {
                          "kind": "model_replaced",
                          "used": 12,
                          "allowance": 12,
                          "period": "year",
                          "resetsAt": "2027-01-01T00:00:00.000Z"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown article",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No product with this article number in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Not waiting for review",
                    "value": {
                      "error": {
                        "code": "not_ready",
                        "message": "The model is not waiting for your approval.",
                        "details": {
                          "status": "in_production"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/products/CH-1001/review \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"decision\": \"request_changes\", \"comments\": [{ \"text\": \"The seat is too thick\", \"imageUrl\": \"https://example.com/seat.jpg\" }] }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/products/CH-1001/review`, {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ decision: \"approve\" }),\n});\nconsole.log(res.status); // 200 reviewed, 409 when the model is not waiting for you"
          }
        ]
      }
    },
    "/api/v1/coverage": {
      "get": {
        "operationId": "getCoverage",
        "summary": "How much of your range has 3D",
        "description": "How much of your range has a 3D model: counts in total and per category, and the article numbers without one. The question an agent asks before ordering.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Only this category.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Coverage"
                },
                "examples": {
                  "example1": {
                    "summary": "The range",
                    "value": {
                      "client": {
                        "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                        "name": "Your Company"
                      },
                      "total": 120,
                      "with3d": 80,
                      "inProduction": 15,
                      "without3d": 25,
                      "byCategory": [
                        {
                          "category": "Furniture",
                          "total": 90,
                          "with3d": 70,
                          "inProduction": 10,
                          "without3d": 10
                        },
                        {
                          "category": "Lighting",
                          "total": 30,
                          "with3d": 10,
                          "inProduction": 5,
                          "without3d": 15
                        }
                      ],
                      "missing": [
                        "CH-2001",
                        "LA-0100"
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/coverage \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/coverage`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { total, with3d, missing } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/integration/heartbeat": {
      "post": {
        "operationId": "reportHeartbeat",
        "summary": "Report a sync run",
        "description": "Tell us after each scheduled sync run. Your CharpstAR contact then sees when your system last synced and whether it went well. Optional.",
        "tags": [
          "Products"
        ],
        "x-required-scope": "products:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HeartbeatInput"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeartbeatResult"
                },
                "examples": {
                  "example1": {
                    "summary": "Recorded",
                    "value": {
                      "ok": true,
                      "system": "api",
                      "lastSyncAt": "2026-10-20T02:04:11.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/integration/heartbeat \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"displayName\": \"Nightly catalogue sync\", \"run\": { \"startedAt\": \"2026-10-20T02:00:00Z\", \"read\": 412, \"sent\": 12, \"writtenBack\": 3, \"errors\": [] } }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "await fetch(\"https://platform.charpstar.co/api/v1/integration/heartbeat\", {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({\n    displayName: \"Nightly catalogue sync\",\n    run: { startedAt: new Date().toISOString(), read: 412, sent: 12, writtenBack: 3, errors: [] },\n  }),\n});"
          }
        ]
      }
    },
    "/api/v1/orders": {
      "get": {
        "operationId": "listOrders",
        "summary": "List your orders",
        "description": "Your orders, newest first. An order is the batch of products that arrived together, through the API, an import, or your CharpstAR account.",
        "tags": [
          "Orders"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only orders in this status.",
            "schema": {
              "type": "string",
              "enum": [
                "received",
                "in_production",
                "in_review",
                "delivered",
                "cancelled"
              ]
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor of the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderList"
                },
                "examples": {
                  "example1": {
                    "summary": "Your orders",
                    "value": {
                      "orders": [
                        {
                          "id": "4d3c2b1a-0000-4000-8000-000000000011",
                          "status": "in_production",
                          "source": "api",
                          "createdAt": "2026-10-20T09:31:00.000Z",
                          "counts": {
                            "received": 0,
                            "in_production": 3,
                            "in_review": 1,
                            "approved": 0,
                            "delivered": 2,
                            "cancelled": 0
                          }
                        }
                      ],
                      "nextCursor": null
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS \"https://platform.charpstar.co/api/v1/orders?status=in_production\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/orders`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { orders } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/orders/{orderId}": {
      "get": {
        "operationId": "getOrder",
        "summary": "Read one order with its items",
        "description": "One order with every item: article, status, delivery date and pending changes.",
        "tags": [
          "Orders"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "required": true,
            "description": "The order id, from POST /api/v1/products or GET /api/v1/orders.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Order"
                },
                "examples": {
                  "example1": {
                    "summary": "An order with its items",
                    "value": {
                      "id": "4d3c2b1a-0000-4000-8000-000000000011",
                      "status": "in_production",
                      "source": "api",
                      "createdAt": "2026-10-20T09:31:00.000Z",
                      "counts": {
                        "received": 0,
                        "in_production": 3,
                        "in_review": 1,
                        "approved": 0,
                        "delivered": 2,
                        "cancelled": 0
                      },
                      "items": [
                        {
                          "articleId": "CH-1001",
                          "status": "in_production",
                          "deliveryDate": "2026-11-20",
                          "pendingChanges": null
                        },
                        {
                          "articleId": "CH-1002",
                          "status": "delivered",
                          "deliveryDate": "2026-11-01",
                          "pendingChanges": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown order",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such order in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/orders/$ORDER_ID \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/orders/${orderId}`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { status, items } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/imports": {
      "post": {
        "operationId": "createImport",
        "summary": "Load many products from a file",
        "description": "Load many products from one file, for a first catalogue load or a full refresh.\n\n- The file is NDJSON (one product per line in the POST /api/v1/products format) or CSV with the same field names in the header row, up to 100,000 products, fetched from an https link.\n- The import runs in the background and applies the same rules as POST /api/v1/products. import.completed is sent when it has finished.\n- With dryRun the whole file is checked and nothing is written.",
        "tags": [
          "Imports"
        ],
        "x-required-scope": "products:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.",
            "schema": {
              "type": "string",
              "maxLength": 128
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImportCreate"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Import"
                },
                "examples": {
                  "example1": {
                    "summary": "Queued",
                    "value": {
                      "id": "7a6b5c4d-0000-4000-8000-000000000022",
                      "status": "queued",
                      "dryRun": false,
                      "orderId": null,
                      "rows": null,
                      "processed": 0,
                      "counts": {
                        "created": 0,
                        "updated": 0,
                        "unchanged": 0,
                        "change_request": 0,
                        "exists_delivered": 0,
                        "refused": 0
                      },
                      "error": null,
                      "createdAt": "2026-10-20T09:31:00.000Z",
                      "finishedAt": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Not a public https link",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "fileUrl must point to a public host.",
                        "details": {
                          "reason": "host resolves to a private address"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/imports \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"fileUrl\": \"https://example.com/exports/catalogue.ndjson\", \"format\": \"ndjson\", \"dryRun\": true }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/imports`, {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ fileUrl: \"https://example.com/exports/catalogue.ndjson\", format: \"ndjson\" }),\n});\nconst { id } = await res.json(); // 202: it runs in the background"
          }
        ]
      }
    },
    "/api/v1/imports/{importId}": {
      "get": {
        "operationId": "getImport",
        "summary": "How an import is going",
        "description": "Its status, how many rows it has processed and a count for each result.",
        "tags": [
          "Imports"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "importId",
            "in": "path",
            "required": true,
            "description": "The import id.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Import"
                },
                "examples": {
                  "example1": {
                    "summary": "Running",
                    "value": {
                      "id": "7a6b5c4d-0000-4000-8000-000000000022",
                      "status": "running",
                      "dryRun": false,
                      "orderId": "4d3c2b1a-0000-4000-8000-000000000011",
                      "rows": 1200,
                      "processed": 350,
                      "counts": {
                        "created": 300,
                        "updated": 40,
                        "unchanged": 8,
                        "change_request": 0,
                        "exists_delivered": 0,
                        "refused": 2
                      },
                      "error": null,
                      "createdAt": "2026-10-20T09:31:00.000Z",
                      "finishedAt": null
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown import",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such import in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/imports/$IMPORT_ID \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/imports/${importId}`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { status, processed, rows, counts } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/imports/{importId}/results": {
      "get": {
        "operationId": "getImportResults",
        "summary": "The result of every row",
        "description": "One line per product, NDJSON, with the same fields as a POST /api/v1/products result plus the row number. Available once the import has finished.",
        "tags": [
          "Imports"
        ],
        "x-required-scope": "products:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "importId",
            "in": "path",
            "required": true,
            "description": "The import id.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "application/x-ndjson, one ImportResultLine per line",
            "content": {
              "application/x-ndjson": {
                "schema": {
                  "$ref": "#/components/schemas/ImportResultLine"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown import",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such import in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Still running",
                    "value": {
                      "error": {
                        "code": "not_ready",
                        "message": "The import has not finished yet. Read GET /imports/{importId} for its progress.",
                        "details": {
                          "status": "running"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/imports/$IMPORT_ID/results \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/imports/${importId}/results`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nfor (const line of (await res.text()).split(\"\\n\").filter(Boolean)) console.log(JSON.parse(line)); // one result per row"
          }
        ]
      }
    },
    "/api/v1/assets/{article}": {
      "get": {
        "operationId": "getAsset",
        "summary": "Read one article",
        "description": "Everything we deliver for one article: its status, the 3D files, the viewer and AR links, the embed snippet, images and variants. Links are null until the product is delivered. glbUrl and usdzUrl never change for an article; when a model is updated the file behind them changes, and the CDN serves ETag and Last-Modified so you can tell.",
        "tags": [
          "Assets"
        ],
        "x-required-scope": "assets:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "article",
            "in": "path",
            "required": true,
            "description": "Your article number.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                },
                "examples": {
                  "example1": {
                    "summary": "Delivered",
                    "value": {
                      "articleId": "CH-1001",
                      "name": "Oslo lounge chair",
                      "status": "delivered",
                      "deliveryDate": "2026-10-20",
                      "updatedAt": "2026-10-20T09:30:00.000Z",
                      "glbUrl": "https://cdn.charpstar.net/YourCompany/Android/CH-1001.glb",
                      "usdzUrl": "https://cdn.charpstar.net/YourCompany/iOS/CH-1001.usdz",
                      "usdzReady": true,
                      "thumbnailUrl": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",
                      "viewerUrl": "https://platform.charpstar.co/agent-viewer?glb=https%3A%2F%2Fcdn.charpstar.net%2FYourCompany%2FAndroid%2FCH-1001.glb&name=Oslo%20lounge%20chair&viewer=default",
                      "arUrl": "https://platform.charpstar.co/ar/0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",
                      "embed": {
                        "dataClient": "YourCompany",
                        "dataArticleId": "CH-1001",
                        "snippet": "<script src=\"https://js.charpstar.net/V2/charpstAR-Base.js\" data-client=\"YourCompany\" data-language=\"en-gb\" defer></script>\n<charpstar-viewer data-articleid=\"CH-1001\"></charpstar-viewer>"
                      },
                      "images": [
                        {
                          "id": "8d2f4c1a-packshot",
                          "type": "packshot",
                          "variant": "Oak",
                          "url": "https://cdn.charpstar.net/YourCompany/Packshots/CH-1001-front.png",
                          "fileName": "CH-1001_packshot_front_1.png",
                          "width": 2048,
                          "height": 2048,
                          "bytes": 412331,
                          "createdAt": "2026-10-20T09:00:00.000Z",
                          "approved": true,
                          "primary": true,
                          "jobId": null
                        },
                        {
                          "id": "thumbnail:0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",
                          "type": "thumbnail",
                          "variant": null,
                          "url": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",
                          "fileName": "CH-1001_thumbnail_1.png",
                          "width": null,
                          "height": null,
                          "bytes": 88120,
                          "createdAt": "2026-10-20T08:55:00.000Z",
                          "approved": true,
                          "primary": false,
                          "jobId": null
                        }
                      ],
                      "variations": [
                        {
                          "articleId": "CH-1001-B",
                          "status": "in_production",
                          "thumbnailUrl": null,
                          "glbUrl": null
                        }
                      ]
                    }
                  },
                  "example2": {
                    "summary": "Still in production",
                    "value": {
                      "articleId": "CH-1002",
                      "name": "Oslo side table",
                      "status": "in_production",
                      "deliveryDate": "2026-11-03",
                      "updatedAt": "2026-10-21T13:05:00.000Z",
                      "glbUrl": null,
                      "usdzUrl": null,
                      "usdzReady": false,
                      "thumbnailUrl": null,
                      "viewerUrl": null,
                      "arUrl": null,
                      "embed": null,
                      "images": [],
                      "variations": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Not in your account",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No article CH-1003 in this account.",
                        "details": {
                          "articleId": "CH-1003"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/assets/CH-1001 \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const article = \"CH-1001\";\nconst res = await fetch(`https://platform.charpstar.co/api/v1/assets/${encodeURIComponent(article)}`, {\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` },\n});\nif (res.status === 404) console.log(\"We do not have this article yet\");\nelse console.log(await res.json());"
          }
        ]
      }
    },
    "/api/v1/assets": {
      "get": {
        "operationId": "listAssets",
        "summary": "Read many articles, or what changed",
        "description": "Pass articles (up to 100, comma separated) to read several at once, or since to get every article that changed after that time, oldest change first, 100 a page. With since, keep calling with cursor set to nextCursor until it is null. A product can appear in two runs in a row; write its current state, keyed on articleId.",
        "tags": [
          "Assets"
        ],
        "x-required-scope": "assets:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "articles",
            "in": "query",
            "required": false,
            "description": "Up to 100 article numbers, comma separated.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "An ISO 8601 time with a zone. Every article that changed after it.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "With since: the nextCursor of the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetList"
                },
                "examples": {
                  "example1": {
                    "summary": "Two articles asked for, one known",
                    "value": {
                      "client": {
                        "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                        "name": "Your Company"
                      },
                      "assets": [
                        {
                          "articleId": "CH-1001",
                          "name": "Oslo lounge chair",
                          "status": "delivered",
                          "deliveryDate": "2026-10-20",
                          "updatedAt": "2026-10-20T09:30:00.000Z",
                          "glbUrl": "https://cdn.charpstar.net/YourCompany/Android/CH-1001.glb",
                          "usdzUrl": "https://cdn.charpstar.net/YourCompany/iOS/CH-1001.usdz",
                          "usdzReady": true,
                          "thumbnailUrl": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",
                          "viewerUrl": "https://platform.charpstar.co/agent-viewer?glb=https%3A%2F%2Fcdn.charpstar.net%2FYourCompany%2FAndroid%2FCH-1001.glb&name=Oslo%20lounge%20chair&viewer=default",
                          "arUrl": "https://platform.charpstar.co/ar/0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",
                          "embed": {
                            "dataClient": "YourCompany",
                            "dataArticleId": "CH-1001",
                            "snippet": "<script src=\"https://js.charpstar.net/V2/charpstAR-Base.js\" data-client=\"YourCompany\" data-language=\"en-gb\" defer></script>\n<charpstar-viewer data-articleid=\"CH-1001\"></charpstar-viewer>"
                          },
                          "images": [
                            {
                              "id": "8d2f4c1a-packshot",
                              "type": "packshot",
                              "variant": "Oak",
                              "url": "https://cdn.charpstar.net/YourCompany/Packshots/CH-1001-front.png",
                              "fileName": "CH-1001_packshot_front_1.png",
                              "width": 2048,
                              "height": 2048,
                              "bytes": 412331,
                              "createdAt": "2026-10-20T09:00:00.000Z",
                              "approved": true,
                              "primary": true,
                              "jobId": null
                            },
                            {
                              "id": "thumbnail:0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",
                              "type": "thumbnail",
                              "variant": null,
                              "url": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",
                              "fileName": "CH-1001_thumbnail_1.png",
                              "width": null,
                              "height": null,
                              "bytes": 88120,
                              "createdAt": "2026-10-20T08:55:00.000Z",
                              "approved": true,
                              "primary": false,
                              "jobId": null
                            }
                          ],
                          "variations": [
                            {
                              "articleId": "CH-1001-B",
                              "status": "in_production",
                              "thumbnailUrl": null,
                              "glbUrl": null
                            }
                          ]
                        }
                      ],
                      "unknown": [
                        "CH-1003"
                      ],
                      "nextCursor": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Too many articles",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "At most 100 articles per request.",
                        "details": {
                          "reason": "too_many_articles"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS \"https://platform.charpstar.co/api/v1/assets?articles=CH-1001,CH-1002\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\"\n\ncurl -sS \"https://platform.charpstar.co/api/v1/assets?since=2026-10-20T00:00:00Z\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const base = \"https://platform.charpstar.co/api/v1/assets\";\nconst headers = { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` };\n\n// Several articles at once\nconst list = [\"CH-1001\", \"CH-1002\"].map(encodeURIComponent).join(\",\");\nconst { assets, unknown } = await (await fetch(`${base}?articles=${list}`, { headers })).json();\n\n// Everything that changed since your last run, page by page\nconst since = \"2026-10-20T00:00:00Z\";\nlet cursor = null;\ndo {\n  const query = `since=${encodeURIComponent(since)}${cursor ? `&cursor=${cursor}` : \"\"}`;\n  const page = await (await fetch(`${base}?${query}`, { headers })).json();\n  for (const asset of page.assets) console.log(asset.articleId, asset.status);\n  cursor = page.nextCursor;\n} while (cursor);"
          }
        ]
      }
    },
    "/api/v1/jobs": {
      "post": {
        "operationId": "createJobs",
        "summary": "Start one job or a batch",
        "description": "Start one job, or up to 50 as { jobs: [...] }. Jobs run our production services on a delivered product: packshot renders, AI scenes, image edits, videos and 3D exports. Every job type runs.\n\n- Jobs queue, and the results are added to the product: new images appear in images[] with the job's id, asset.images.updated is sent, and job.succeeded carries the job with its outputs.\n- Pictures are made in the order asked, and each is saved under its fileName from the start.\n- A batch answers a results array like POST /api/v1/products.\n- A product without a delivered model answers 409 not_ready (edit jobs work on an image and need no model).\n- AI jobs (scenes, edits, scene videos) run for an account with an allowance of their kind; without one they answer 403 forbidden.\n- An export to a format not switched on for your account answers 403 forbidden.",
        "tags": [
          "Jobs"
        ],
        "x-required-scope": "jobs:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.",
            "schema": {
              "type": "string",
              "maxLength": 128
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/JobCreate"
                  },
                  {
                    "$ref": "#/components/schemas/JobBatch"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/Job"
                    },
                    {
                      "$ref": "#/components/schemas/JobBatchResult"
                    }
                  ]
                },
                "examples": {
                  "example1": {
                    "summary": "One job, queued",
                    "value": {
                      "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                      "type": "packshot",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "queued",
                      "options": {
                        "views": [
                          "front",
                          "left",
                          "back"
                        ],
                        "background": "transparent",
                        "size": 4096,
                        "aspectRatio": "1:1",
                        "format": "png",
                        "shadows": true,
                        "lighting": "studio",
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": {
                        "preset": "gs1"
                      },
                      "metadata": {
                        "purchaseOrder": "PO-88213"
                      },
                      "createdAt": "2026-11-02T08:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": null,
                      "outputs": [],
                      "error": null
                    }
                  },
                  "example2": {
                    "summary": "An export, queued",
                    "value": {
                      "id": "8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d",
                      "type": "export",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "queued",
                      "options": {
                        "formats": [
                          "fbx",
                          "obj",
                          "glb"
                        ]
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T09:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": null,
                      "outputs": [],
                      "error": null
                    }
                  },
                  "example3": {
                    "summary": "A turntable, queued",
                    "value": {
                      "id": "9e3d5c7b-2f4a-4b6c-8d0e-1f2a3b4c5d6e",
                      "type": "video",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "queued",
                      "options": {
                        "kind": "turntable",
                        "resolution": "1080p",
                        "seconds": 3,
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T10:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": null,
                      "outputs": [],
                      "error": null
                    }
                  },
                  "example4": {
                    "summary": "Two scenes, queued",
                    "value": {
                      "id": "6f4e2d1c-3b5a-4c7d-8e9f-0a1b2c3d4e5f",
                      "type": "scene",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "queued",
                      "options": {
                        "prompt": "Bright Scandinavian living room, morning light",
                        "style": "Nordic calm",
                        "inspirationImageUrl": null,
                        "aspectRatio": "4:3",
                        "quality": "standard",
                        "count": 2
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T11:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": null,
                      "outputs": [],
                      "error": null
                    }
                  },
                  "example5": {
                    "summary": "An edit, queued",
                    "value": {
                      "id": "7a5c3e1f-2b4d-4e6f-8a0b-1c2d3e4f5a6b",
                      "type": "edit",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "queued",
                      "options": {
                        "imageId": "b7c8d9e0-0000-4000-8000-000000000001",
                        "instruction": "Put a small green plant on the side table",
                        "region": {
                          "x": 0.62,
                          "y": 0.4,
                          "w": 0.3,
                          "h": 0.35
                        }
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T12:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": null,
                      "outputs": [],
                      "error": null
                    }
                  },
                  "example6": {
                    "summary": "A scene video, queued",
                    "value": {
                      "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
                      "type": "video",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "queued",
                      "options": {
                        "kind": "scene",
                        "sourceImageId": "b7c8d9e0-0000-4000-8000-000000000001",
                        "resolution": "1080p",
                        "seconds": 8
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T13:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": null,
                      "outputs": [],
                      "error": null
                    }
                  },
                  "example7": {
                    "summary": "A batch, every job started",
                    "value": {
                      "results": [
                        {
                          "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                          "type": "packshot",
                          "articleId": "CH-1001",
                          "status": "queued",
                          "httpStatus": 202
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "207": {
            "description": "Some items succeeded and some did not",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobBatchResult"
                },
                "examples": {
                  "example1": {
                    "summary": "A batch, one refused",
                    "value": {
                      "results": [
                        {
                          "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                          "type": "packshot",
                          "articleId": "CH-1001",
                          "status": "queued",
                          "httpStatus": 202
                        },
                        {
                          "articleId": "CH-1002",
                          "type": "packshot",
                          "error": {
                            "code": "not_ready",
                            "message": "CH-1002 has no delivered model yet; packshots are made from it."
                          },
                          "httpStatus": 409
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "GS1 names without a GTIN",
                    "value": {
                      "articleId": "CH-1001",
                      "type": "packshot",
                      "error": {
                        "code": "validation_failed",
                        "message": "The job is not valid. See details.issues.",
                        "details": {
                          "issues": [
                            {
                              "path": "naming",
                              "message": "GS1 names start with the product's GTIN; send gtin with the product first (POST /products) or choose another naming"
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "402": {
            "description": "Allowance used up (allowance_reached)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "The allowance of pictures is used up",
                    "value": {
                      "articleId": "CH-1001",
                      "type": "packshot",
                      "error": {
                        "code": "allowance_reached",
                        "message": "The allowance of 500 pictures is used up (500 made or on the way). It starts again on 1 Jan 2027. Ask your CharpstAR contact to raise it.",
                        "details": {
                          "kind": "packshot",
                          "used": 500,
                          "allowance": 500,
                          "requested": 3,
                          "period": "year",
                          "resetsAt": "2027-01-01T00:00:00.000Z"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "AI scenes not switched on",
                    "value": {
                      "articleId": "CH-1001",
                      "type": "scene",
                      "error": {
                        "code": "forbidden",
                        "message": "AI scenes through the API are not switched on for your account. Ask your CharpstAR contact to switch them on.",
                        "details": {
                          "kind": "scene"
                        }
                      }
                    }
                  },
                  "example2": {
                    "summary": "An export format not switched on",
                    "value": {
                      "articleId": "CH-1001",
                      "type": "export",
                      "error": {
                        "code": "forbidden",
                        "message": "Exports to 3ds are not switched on for your account. Ask your CharpstAR contact to switch them on.",
                        "details": {
                          "formats": [
                            "3ds"
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown article",
                    "value": {
                      "articleId": "CH-9999",
                      "type": "packshot",
                      "error": {
                        "code": "not_found",
                        "message": "No product CH-9999 in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No delivered model yet",
                    "value": {
                      "articleId": "CH-1002",
                      "type": "packshot",
                      "error": {
                        "code": "not_ready",
                        "message": "CH-1002 has no delivered model yet; packshots are made from it."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Idempotency-Key: po-88213-ch-1001\" \\\n  -d '{ \"type\": \"packshot\", \"articleId\": \"CH-1001\", \"options\": { \"views\": [\"front\", \"left\", \"back\"], \"background\": \"transparent\", \"size\": 4096 }, \"naming\": { \"preset\": \"gs1\" }, \"metadata\": { \"purchaseOrder\": \"PO-88213\" } }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/jobs`, {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\", \"Idempotency-Key\": \"po-88213\" },\n  body: JSON.stringify({ jobs: articles.map((articleId) => ({ type: \"packshot\", articleId, options: { views: [\"front\", \"back\"] } })) }),\n});\nconst { results } = await res.json(); // each with httpStatus: 202 started, or its refusal"
          },
          {
            "lang": "curl",
            "label": "curl (scene)",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"type\": \"scene\", \"articleId\": \"CH-1001\", \"options\": { \"prompt\": \"Bright Scandinavian living room, morning light\", \"style\": \"Nordic calm\", \"aspectRatio\": \"4:3\", \"count\": 2 } }'"
          },
          {
            "lang": "curl",
            "label": "curl (edit)",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"type\": \"edit\", \"articleId\": \"CH-1001\", \"options\": { \"imageId\": \"b7c8d9e0-0000-4000-8000-000000000001\", \"instruction\": \"Put a small green plant on the side table\", \"region\": { \"x\": 0.62, \"y\": 0.4, \"w\": 0.3, \"h\": 0.35 } } }'"
          },
          {
            "lang": "curl",
            "label": "curl (scene video)",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"type\": \"video\", \"articleId\": \"CH-1001\", \"options\": { \"kind\": \"scene\", \"sourceImageId\": \"b7c8d9e0-0000-4000-8000-000000000001\" } }'"
          },
          {
            "lang": "curl",
            "label": "curl (turntable)",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"type\": \"video\", \"articleId\": \"CH-1001\", \"options\": { \"kind\": \"turntable\", \"resolution\": \"1080p\" } }'"
          },
          {
            "lang": "curl",
            "label": "curl (export)",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"type\": \"export\", \"articleId\": \"CH-1001\", \"options\": { \"formats\": [\"fbx\", \"obj\", \"glb\"] } }'"
          }
        ]
      },
      "get": {
        "operationId": "listJobs",
        "summary": "List jobs",
        "description": "Your jobs, newest first, with their status and outputs. Filter by article, type, status, or changes since a time.",
        "tags": [
          "Jobs"
        ],
        "x-required-scope": "jobs:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "articles",
            "in": "query",
            "required": false,
            "description": "Only jobs for these article numbers, comma separated.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Only this job type.",
            "schema": {
              "type": "string",
              "enum": [
                "packshot",
                "scene",
                "edit",
                "video",
                "export"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only this status.",
            "schema": {
              "type": "string",
              "enum": [
                "queued",
                "running",
                "succeeded",
                "failed",
                "cancelled"
              ]
            }
          },
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "Only jobs changed after this time.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor of the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobList"
                },
                "examples": {
                  "example1": {
                    "summary": "One page",
                    "value": {
                      "jobs": [
                        {
                          "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                          "type": "packshot",
                          "articleId": "CH-1001",
                          "variant": null,
                          "status": "succeeded",
                          "options": {
                            "views": [
                              "front",
                              "left",
                              "back"
                            ],
                            "background": "transparent",
                            "size": 4096,
                            "aspectRatio": "1:1",
                            "format": "png",
                            "shadows": true,
                            "lighting": "studio",
                            "preset": "Marketplace (GS1)"
                          },
                          "naming": {
                            "preset": "gs1"
                          },
                          "metadata": {
                            "purchaseOrder": "PO-88213"
                          },
                          "createdAt": "2026-11-02T08:00:00.000Z",
                          "startedAt": "2026-11-02T08:01:10.000Z",
                          "finishedAt": "2026-11-02T08:09:52.000Z",
                          "outputs": [
                            {
                              "id": "c41f9a07-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
                              "type": "packshot",
                              "view": "front",
                              "format": "png",
                              "fileName": "09521234567806_C1C0.png",
                              "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C1C0.png",
                              "width": 4096,
                              "height": 4096,
                              "bytes": 3210442
                            },
                            {
                              "id": "5e83d1b2-3c4d-4e5f-9a6b-8c9d0e1f2a3b",
                              "type": "packshot",
                              "view": "left",
                              "format": "png",
                              "fileName": "09521234567806_C2C0.png",
                              "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C2C0.png",
                              "width": 4096,
                              "height": 4096,
                              "bytes": 3210442
                            },
                            {
                              "id": "f0a7c6e9-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
                              "type": "packshot",
                              "view": "back",
                              "format": "png",
                              "fileName": "09521234567806_C7C0.png",
                              "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C7C0.png",
                              "width": 4096,
                              "height": 4096,
                              "bytes": 3210442
                            }
                          ],
                          "error": null
                        }
                      ],
                      "nextCursor": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS \"https://platform.charpstar.co/api/v1/jobs?status=succeeded&since=2026-11-01T00:00:00Z\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "let cursor = null;\ndo {\n  const res = await fetch(`https://platform.charpstar.co/api/v1/jobs?since=${since}${cursor ? `&cursor=${cursor}` : \"\"}`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\n  const page = await res.json();\n  for (const job of page.jobs) await store(job);\n  cursor = page.nextCursor;\n} while (cursor);"
          }
        ]
      }
    },
    "/api/v1/jobs/{jobId}": {
      "get": {
        "operationId": "getJob",
        "summary": "Read one job",
        "description": "One job: its status, options as applied, outputs once it succeeded, and the error when it failed.",
        "tags": [
          "Jobs"
        ],
        "x-required-scope": "jobs:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "jobId",
            "in": "path",
            "required": true,
            "description": "The job id.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                },
                "examples": {
                  "example1": {
                    "summary": "Finished",
                    "value": {
                      "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                      "type": "packshot",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "views": [
                          "front",
                          "left",
                          "back"
                        ],
                        "background": "transparent",
                        "size": 4096,
                        "aspectRatio": "1:1",
                        "format": "png",
                        "shadows": true,
                        "lighting": "studio",
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": {
                        "preset": "gs1"
                      },
                      "metadata": {
                        "purchaseOrder": "PO-88213"
                      },
                      "createdAt": "2026-11-02T08:00:00.000Z",
                      "startedAt": "2026-11-02T08:01:10.000Z",
                      "finishedAt": "2026-11-02T08:09:52.000Z",
                      "outputs": [
                        {
                          "id": "c41f9a07-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
                          "type": "packshot",
                          "view": "front",
                          "format": "png",
                          "fileName": "09521234567806_C1C0.png",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C1C0.png",
                          "width": 4096,
                          "height": 4096,
                          "bytes": 3210442
                        },
                        {
                          "id": "5e83d1b2-3c4d-4e5f-9a6b-8c9d0e1f2a3b",
                          "type": "packshot",
                          "view": "left",
                          "format": "png",
                          "fileName": "09521234567806_C2C0.png",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C2C0.png",
                          "width": 4096,
                          "height": 4096,
                          "bytes": 3210442
                        },
                        {
                          "id": "f0a7c6e9-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
                          "type": "packshot",
                          "view": "back",
                          "format": "png",
                          "fileName": "09521234567806_C7C0.png",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C7C0.png",
                          "width": 4096,
                          "height": 4096,
                          "bytes": 3210442
                        }
                      ],
                      "error": null
                    }
                  },
                  "example2": {
                    "summary": "An export, finished",
                    "value": {
                      "id": "8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d",
                      "type": "export",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "formats": [
                          "fbx",
                          "obj",
                          "glb"
                        ]
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T09:00:00.000Z",
                      "startedAt": "2026-11-02T09:00:07.000Z",
                      "finishedAt": "2026-11-02T09:00:41.000Z",
                      "outputs": [
                        {
                          "id": "8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d:fbx",
                          "type": "export",
                          "view": null,
                          "format": "fbx",
                          "fileName": "CH-1001.fbx",
                          "url": "https://cdn.charpstar.net/exports/YourCompany/CH-1001/api-8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d/CH-1001.fbx",
                          "width": null,
                          "height": null,
                          "bytes": null
                        },
                        {
                          "id": "8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d:obj",
                          "type": "export",
                          "view": null,
                          "format": "obj",
                          "fileName": "CH-1001_obj.zip",
                          "url": "https://cdn.charpstar.net/exports/YourCompany/CH-1001/api-8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d/CH-1001_obj.zip",
                          "width": null,
                          "height": null,
                          "bytes": null
                        },
                        {
                          "id": "8d2c4b6a-1e3f-4a5b-9c7d-0e1f2a3b4c5d:glb",
                          "type": "export",
                          "view": null,
                          "format": "glb",
                          "fileName": "CH-1001.glb",
                          "url": "https://cdn.charpstar.net/YourCompany/Android/CH-1001.glb",
                          "width": null,
                          "height": null,
                          "bytes": null
                        }
                      ],
                      "error": null
                    }
                  },
                  "example3": {
                    "summary": "A turntable, finished",
                    "value": {
                      "id": "9e3d5c7b-2f4a-4b6c-8d0e-1f2a3b4c5d6e",
                      "type": "video",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "kind": "turntable",
                        "resolution": "1080p",
                        "seconds": 3,
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T10:00:00.000Z",
                      "startedAt": "2026-11-02T10:00:12.000Z",
                      "finishedAt": "2026-11-02T10:03:40.000Z",
                      "outputs": [
                        {
                          "id": "a51c2e4d-6f7a-4b8c-9d0e-2f3a4b5c6d7e",
                          "type": "video",
                          "view": null,
                          "format": "mp4",
                          "fileName": "CH-1001_video_360_1.mp4",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000002/CH-1001_video_360_1.mp4",
                          "width": 1080,
                          "height": 1080,
                          "bytes": 1048576
                        }
                      ],
                      "error": null
                    }
                  },
                  "example4": {
                    "summary": "Scenes, finished",
                    "value": {
                      "id": "6f4e2d1c-3b5a-4c7d-8e9f-0a1b2c3d4e5f",
                      "type": "scene",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "prompt": "Bright Scandinavian living room, morning light",
                        "style": "Nordic calm",
                        "inspirationImageUrl": null,
                        "aspectRatio": "4:3",
                        "quality": "standard",
                        "count": 2
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T11:00:00.000Z",
                      "startedAt": "2026-11-02T11:00:04.000Z",
                      "finishedAt": "2026-11-02T11:01:32.000Z",
                      "outputs": [
                        {
                          "id": "b7c8d9e0-0000-4000-8000-000000000001",
                          "type": "scene",
                          "view": null,
                          "format": "png",
                          "fileName": "CH-1001_scene_1.png",
                          "url": "https://renders.charpstar.net/YourCompany/api-6f4e2d1c-3b5a-4c7d-8e9f-0a1b2c3d4e5f/CH-1001_scene_1.png",
                          "width": 1440,
                          "height": 1080,
                          "bytes": 2310000
                        },
                        {
                          "id": "b7c8d9e0-0000-4000-8000-000000000002",
                          "type": "scene",
                          "view": null,
                          "format": "png",
                          "fileName": "CH-1001_scene_2.png",
                          "url": "https://renders.charpstar.net/YourCompany/api-6f4e2d1c-3b5a-4c7d-8e9f-0a1b2c3d4e5f/CH-1001_scene_2.png",
                          "width": 1440,
                          "height": 1080,
                          "bytes": 2310000
                        }
                      ],
                      "error": null
                    }
                  },
                  "example5": {
                    "summary": "An edit, finished",
                    "value": {
                      "id": "7a5c3e1f-2b4d-4e6f-8a0b-1c2d3e4f5a6b",
                      "type": "edit",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "imageId": "b7c8d9e0-0000-4000-8000-000000000001",
                        "instruction": "Put a small green plant on the side table",
                        "region": {
                          "x": 0.62,
                          "y": 0.4,
                          "w": 0.3,
                          "h": 0.35
                        }
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T12:00:00.000Z",
                      "startedAt": "2026-11-02T12:00:03.000Z",
                      "finishedAt": "2026-11-02T12:00:41.000Z",
                      "outputs": [
                        {
                          "id": "d4e5f6a7-0000-4000-8000-000000000011",
                          "type": "edit",
                          "view": null,
                          "format": "png",
                          "fileName": "CH-1001_edit_1.png",
                          "url": "https://renders.charpstar.net/YourCompany/api-7a5c3e1f-2b4d-4e6f-8a0b-1c2d3e4f5a6b/CH-1001_edit_1.png",
                          "width": 1440,
                          "height": 1080,
                          "bytes": 2410000
                        }
                      ],
                      "error": null
                    }
                  },
                  "example6": {
                    "summary": "A scene video, finished",
                    "value": {
                      "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
                      "type": "video",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "kind": "scene",
                        "sourceImageId": "b7c8d9e0-0000-4000-8000-000000000001",
                        "resolution": "1080p",
                        "seconds": 8
                      },
                      "naming": null,
                      "metadata": {},
                      "createdAt": "2026-11-02T13:00:00.000Z",
                      "startedAt": "2026-11-02T13:00:02.000Z",
                      "finishedAt": "2026-11-02T13:02:40.000Z",
                      "outputs": [
                        {
                          "id": "e5f6a7b8-0000-4000-8000-000000000021",
                          "type": "video",
                          "view": null,
                          "format": "mp4",
                          "fileName": "CH-1001_video_1.mp4",
                          "url": "https://renders.charpstar.net/YourCompany/api-5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e/CH-1001_video_1.mp4",
                          "width": 1920,
                          "height": 1080,
                          "bytes": 6100000
                        }
                      ],
                      "error": null
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Unknown job",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such job in your account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/jobs/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045 \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const job = await (await fetch(`https://platform.charpstar.co/api/v1/jobs/${jobId}`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } })).json();\nif (job.status === \"succeeded\") for (const o of job.outputs) console.log(o.fileName, o.url);"
          }
        ]
      }
    },
    "/api/v1/jobs/{jobId}/cancel": {
      "post": {
        "operationId": "cancelJob",
        "summary": "Cancel a queued job",
        "description": "Cancel a job while it is queued. A job that has started answers 409 not_cancellable. job.cancelled is sent. Cancelling a cancelled job answers it again.",
        "tags": [
          "Jobs"
        ],
        "x-required-scope": "jobs:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.",
            "schema": {
              "type": "string",
              "maxLength": 128
            }
          },
          {
            "name": "jobId",
            "in": "path",
            "required": true,
            "description": "The job id.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                },
                "examples": {
                  "example1": {
                    "summary": "Cancelled while queued",
                    "value": {
                      "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                      "type": "packshot",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "cancelled",
                      "options": {
                        "views": [
                          "front",
                          "left",
                          "back"
                        ],
                        "background": "transparent",
                        "size": 4096,
                        "aspectRatio": "1:1",
                        "format": "png",
                        "shadows": true,
                        "lighting": "studio",
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": {
                        "preset": "gs1"
                      },
                      "metadata": {
                        "purchaseOrder": "PO-88213"
                      },
                      "createdAt": "2026-11-02T08:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": "2026-11-02T08:00:20.000Z",
                      "outputs": [],
                      "error": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Already rendering",
                    "value": {
                      "error": {
                        "code": "not_cancellable",
                        "message": "The job is running; only a queued job can be cancelled.",
                        "details": {
                          "status": "running"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/jobs/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/cancel \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/jobs/${jobId}/cancel`, { method: \"POST\", headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconsole.log(res.status); // 200 cancelled, 409 when it has started"
          }
        ]
      }
    },
    "/api/v1/presets": {
      "get": {
        "operationId": "listPresets",
        "summary": "Your render presets",
        "description": "The render presets of your account: camera, lighting, background, size and format sets our team saved for you. Name one in a packshot job's options.preset.",
        "tags": [
          "Jobs"
        ],
        "x-required-scope": "jobs:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Only presets of this type.",
            "schema": {
              "type": "string",
              "enum": [
                "packshot",
                "scene"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PresetList"
                },
                "examples": {
                  "example1": {
                    "summary": "A look of yours and the house look",
                    "value": {
                      "presets": [
                        {
                          "id": "3b2a1c0d-0000-4000-8000-000000000031",
                          "name": "Armchairs and lounge chairs",
                          "type": "packshot",
                          "description": null,
                          "defaults": {
                            "views": [
                              "FrontRight",
                              "FrontLeft",
                              "Front",
                              "Back",
                              "Side"
                            ],
                            "background": "#FFFFFF",
                            "size": 2000,
                            "aspectRatio": "1:1",
                            "format": "jpg",
                            "shadows": false,
                            "lighting": "studio"
                          },
                          "exampleUrl": null
                        },
                        {
                          "id": "3b2a1c0d-0000-4000-8000-000000000032",
                          "name": "Marketplace (GS1)",
                          "type": "packshot",
                          "description": null,
                          "defaults": {
                            "views": [
                              "1C",
                              "1L",
                              "1R",
                              "7C"
                            ],
                            "background": "#FFFFFF",
                            "size": 2000,
                            "aspectRatio": "1:1",
                            "format": "jpg",
                            "shadows": true,
                            "lighting": "studio"
                          },
                          "exampleUrl": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS \"https://platform.charpstar.co/api/v1/presets?type=packshot\" \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const { presets } = await (await fetch(`https://platform.charpstar.co/api/v1/presets`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } })).json();\nconst preset = presets.find((p) => p.name === \"Marketplace (GS1)\");"
          }
        ]
      }
    },
    "/api/v1/styles": {
      "get": {
        "operationId": "listStyles",
        "summary": "Your saved scene styles",
        "description": "The saved scene styles of your account, so a whole range shares one look: our team makes them with you. Name one in a scene job's options.style.",
        "tags": [
          "Jobs"
        ],
        "x-required-scope": "jobs:read",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StyleList"
                },
                "examples": {
                  "example1": {
                    "summary": "Two styles",
                    "value": {
                      "styles": [
                        {
                          "id": "c1d2e3f4-0000-4000-8000-000000000041",
                          "name": "Nordic calm",
                          "description": "Light wood, linen, soft morning light",
                          "exampleUrl": null
                        },
                        {
                          "id": "c1d2e3f4-0000-4000-8000-000000000042",
                          "name": "Evening lounge",
                          "description": null,
                          "exampleUrl": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/styles \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const { styles } = await (await fetch(`https://platform.charpstar.co/api/v1/styles`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } })).json();\nconst style = styles.find((s) => s.name === \"Nordic calm\");"
          }
        ]
      }
    },
    "/api/v1/naming": {
      "get": {
        "operationId": "getNaming",
        "summary": "Your naming template",
        "description": "How files are named for your account, with an example.",
        "tags": [
          "Naming"
        ],
        "x-required-scope": "settings:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NamingView"
                },
                "examples": {
                  "example1": {
                    "summary": "The default",
                    "value": {
                      "preset": "standard",
                      "example": "CH-1001_packshot_front_1.png"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/naming \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const { preset, example } = await (await fetch(`https://platform.charpstar.co/api/v1/naming`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } })).json();"
          }
        ]
      },
      "put": {
        "operationId": "setNaming",
        "summary": "Set your naming template",
        "description": "Set the naming template for every file we produce for you: the standard pattern, the GS1 Product Image Standard, Amazon's MAIN and PT01 scheme, or your own pattern from the tokens.\n\n- Override it per job with the job's naming.\n- File names use letters A to Z, digits, '-', '_' and '.', up to 200 characters; accented letters are converted.\n- The same output always gets the same name, so an updated image replaces the earlier file.",
        "tags": [
          "Naming"
        ],
        "x-required-scope": "settings:write",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Naming"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NamingView"
                },
                "examples": {
                  "example1": {
                    "summary": "Your own pattern",
                    "value": {
                      "preset": "custom",
                      "pattern": "{articleId}-{variant}-{n:2}.{ext}",
                      "example": "CH-1001-BLUE-01.png"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "A token that does not exist",
                    "value": {
                      "error": {
                        "code": "validation_failed",
                        "message": "The naming is not valid. See details.issues.",
                        "details": {
                          "issues": [
                            {
                              "path": "pattern",
                              "message": "{sku} is not a token; use {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} or {ext}"
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X PUT https://platform.charpstar.co/api/v1/naming \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"preset\": \"custom\", \"pattern\": \"{articleId}-{variant}-{n:2}.{ext}\" }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/naming`, {\n  method: \"PUT\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ preset: \"gs1\" }),\n});\nconst { example } = await res.json(); // 09521234567806_A1C0.png"
          }
        ]
      }
    },
    "/api/v1/webhooks": {
      "post": {
        "operationId": "createWebhook",
        "summary": "Subscribe to events",
        "description": "Subscribe your https URL to signed events. Up to 3 active subscriptions. The answer carries the signing secret once: store it next to your API key. Leave events out to receive every type, including ones added later.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.",
            "schema": {
              "type": "string",
              "maxLength": 128
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookCreate"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookCreated"
                },
                "examples": {
                  "example1": {
                    "summary": "Subscribed",
                    "value": {
                      "id": "a1b2c3d4-0000-4000-8000-000000000001",
                      "url": "https://example.com/charpstar/events",
                      "events": [
                        "asset.approved",
                        "asset.images.updated"
                      ],
                      "active": true,
                      "secretPrefix": "whsec_Q2x9Ab",
                      "createdAt": "2026-10-20T08:00:00.000Z",
                      "secret": "whsec_Q2x9AbF0dKe7LmN3pR5sT8uV1wX4yZ6aB9cD2eF5gH8"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "Already 3 subscriptions",
                    "value": {
                      "error": {
                        "code": "limit_reached",
                        "message": "At most 3 active webhooks per account.",
                        "details": {
                          "max": 3
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/webhooks \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"url\": \"https://example.com/charpstar/events\", \"events\": [\"asset.approved\", \"asset.images.updated\"] }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(\"https://platform.charpstar.co/api/v1/webhooks\", {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ url: \"https://example.com/charpstar/events\", events: [\"asset.approved\", \"asset.images.updated\"] }),\n});\nconst { id, secret } = await res.json(); // store the secret now: it is not shown again"
          }
        ]
      },
      "get": {
        "operationId": "listWebhooks",
        "summary": "List your subscriptions",
        "description": "Your subscriptions, newest first, stopped ones included. Secrets are not included.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookList"
                },
                "examples": {
                  "example1": {
                    "summary": "Your subscriptions",
                    "value": {
                      "webhooks": [
                        {
                          "id": "a1b2c3d4-0000-4000-8000-000000000001",
                          "url": "https://example.com/charpstar/events",
                          "events": [
                            "asset.approved",
                            "asset.images.updated"
                          ],
                          "active": true,
                          "secretPrefix": "whsec_Q2x9Ab",
                          "createdAt": "2026-10-20T08:00:00.000Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/webhooks \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(\"https://platform.charpstar.co/api/v1/webhooks\", {\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` },\n});\nconst { webhooks } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/webhooks/{webhook_id}": {
      "patch": {
        "operationId": "patchWebhook",
        "summary": "Change a subscription",
        "description": "Change the URL or the event types of a subscription.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "webhook_id",
            "in": "path",
            "required": true,
            "description": "The id from POST /api/v1/webhooks.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookPatch"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                },
                "examples": {
                  "example1": {
                    "summary": "Changed",
                    "value": {
                      "id": "a1b2c3d4-0000-4000-8000-000000000001",
                      "url": "https://example.com/charpstar/events",
                      "events": [
                        "asset.approved",
                        "status.changed"
                      ],
                      "active": true,
                      "secretPrefix": "whsec_Q2x9Ab",
                      "createdAt": "2026-10-20T08:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No such active subscription",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such active webhook in this account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X PATCH https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"events\": [\"asset.approved\", \"status.changed\"] }'"
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "await fetch(`https://platform.charpstar.co/api/v1/webhooks/${process.env.WEBHOOK_ID}`, {\n  method: \"PATCH\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, \"Content-Type\": \"application/json\" },\n  body: JSON.stringify({ events: [\"asset.approved\", \"status.changed\"] }),\n});"
          }
        ]
      },
      "delete": {
        "operationId": "deleteWebhook",
        "summary": "Stop a subscription",
        "description": "Stop a subscription. Nothing more is sent to it. Safe to repeat.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "webhook_id",
            "in": "path",
            "required": true,
            "description": "The id from POST /api/v1/webhooks.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeleted"
                },
                "examples": {
                  "example1": {
                    "summary": "Stopped",
                    "value": {
                      "id": "a1b2c3d4-0000-4000-8000-000000000001",
                      "active": false
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No such subscription",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such webhook in this account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X DELETE https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "await fetch(`https://platform.charpstar.co/api/v1/webhooks/${process.env.WEBHOOK_ID}`, {\n  method: \"DELETE\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` },\n});"
          }
        ]
      }
    },
    "/api/v1/webhooks/{webhook_id}/test": {
      "post": {
        "operationId": "testWebhook",
        "summary": "Send a test event",
        "description": "Queue a signed ping event to this subscription. It is sent within about a minute, signed like any other event.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "webhook_id",
            "in": "path",
            "required": true,
            "description": "The id from POST /api/v1/webhooks.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTestQueued"
                },
                "examples": {
                  "example1": {
                    "summary": "Ping queued",
                    "value": {
                      "queued": true,
                      "deliveryId": "6f1c2b9e-1d2c-4f7a-9a3b-5c6d7e8f9a0b"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No such active subscription",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such active webhook in this account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID/test \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/webhooks/${process.env.WEBHOOK_ID}/test`, {\n  method: \"POST\",\n  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` },\n});\nconsole.log(res.status, await res.json()); // 202: the ping is on its way"
          }
        ]
      }
    },
    "/api/v1/webhooks/{webhook_id}/deliveries": {
      "get": {
        "operationId": "listDeliveries",
        "summary": "The last 30 days of deliveries",
        "description": "Every delivery of the last 30 days, newest first, with attempts and your receiver's answers.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "webhook_id",
            "in": "path",
            "required": true,
            "description": "The id from POST /api/v1/webhooks.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only deliveries in this state.",
            "schema": {
              "type": "string",
              "enum": [
                "pending",
                "delivered",
                "failed",
                "dead"
              ]
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor of the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeliveryList"
                },
                "examples": {
                  "example1": {
                    "summary": "The last deliveries",
                    "value": {
                      "deliveries": [
                        {
                          "id": "6f1c2b9e-1d2c-4f7a-9a3b-5c6d7e8f9a0b",
                          "event": "asset.approved",
                          "article": "CH-1001",
                          "status": "delivered",
                          "attempts": 1,
                          "lastStatus": 200,
                          "lastError": null,
                          "occurredAt": "2026-10-20T09:31:00.000Z",
                          "deliveredAt": "2026-10-20T09:31:04.000Z",
                          "nextAttemptAt": null
                        },
                        {
                          "id": "0b9a8f7e-6d5c-4b3a-9f8e-7d6c5b4a3f2e",
                          "event": "status.changed",
                          "article": "CH-1002",
                          "status": "failed",
                          "attempts": 2,
                          "lastStatus": 503,
                          "lastError": "HTTP 503",
                          "occurredAt": "2026-10-20T09:20:00.000Z",
                          "deliveredAt": null,
                          "nextAttemptAt": "2026-10-20T09:56:00.000Z"
                        }
                      ],
                      "nextCursor": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Not valid (validation_failed)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No such subscription",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such webhook in this account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID/deliveries \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/webhooks/${process.env.WEBHOOK_ID}/deliveries`, { headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { deliveries, nextCursor } = await res.json();"
          }
        ]
      }
    },
    "/api/v1/webhooks/{webhook_id}/deliveries/{deliveryId}/redeliver": {
      "post": {
        "operationId": "redeliver",
        "summary": "Send a delivery again",
        "description": "Send a delivery again, with the same body and the same CharpstAR-Delivery id.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "webhook_id",
            "in": "path",
            "required": true,
            "description": "The id from POST /api/v1/webhooks.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "deliveryId",
            "in": "path",
            "required": true,
            "description": "The delivery id.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RedeliverResult"
                },
                "examples": {
                  "example1": {
                    "summary": "Queued again",
                    "value": {
                      "queued": true,
                      "deliveryId": "0b9a8f7e-6d5c-4b3a-9f8e-7d6c5b4a3f2e"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No such delivery",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such delivery for this webhook in this account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID/deliveries/$DELIVERY_ID/redeliver \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "await fetch(`https://platform.charpstar.co/api/v1/webhooks/${process.env.WEBHOOK_ID}/deliveries/${deliveryId}/redeliver`, { method: \"POST\", headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });"
          }
        ]
      }
    },
    "/api/v1/webhooks/{webhook_id}/rotate-secret": {
      "post": {
        "operationId": "rotateSecret",
        "summary": "Issue a new signing secret",
        "description": "Issue a new signing secret. The old one stays valid for 24 hours, and every delivery in that time carries a signature for each secret, so you can switch without missing an event.",
        "tags": [
          "Events"
        ],
        "x-required-scope": "webhooks:manage",
        "x-status": "live",
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "name": "webhook_id",
            "in": "path",
            "required": true,
            "description": "The id from POST /api/v1/webhooks.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/X-Request-Id"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RotateSecretResult"
                },
                "examples": {
                  "example1": {
                    "summary": "Rotated",
                    "value": {
                      "id": "a1b2c3d4-0000-4000-8000-000000000001",
                      "secret": "whsec_Zq7xL2mN9pR4sT6uV8wX0yA1bC3dE5fG7hJ9kL2mN4p",
                      "secretPrefix": "whsec_Zq7xL2",
                      "previousSecretValidUntil": "2026-10-21T09:31:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No valid key (unauthorized)",
            "headers": {
              "WWW-Authenticate": {
                "schema": {
                  "type": "string"
                },
                "description": "Bearer realm=\"charpstar\""
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Not allowed (forbidden)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found (not_found)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "example1": {
                    "summary": "No such active subscription",
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "No such active webhook in this account."
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests (rate_limited)",
            "headers": {
              "Retry-After": {
                "$ref": "#/components/headers/Retry-After"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Our side failed (internal_error)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "curl",
            "source": "curl -sS -X POST https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID/rotate-secret \\\n  -H \"Authorization: Bearer $CHARPSTAR_API_KEY\""
          },
          {
            "lang": "JavaScript",
            "label": "Node",
            "source": "const res = await fetch(`https://platform.charpstar.co/api/v1/webhooks/${process.env.WEBHOOK_ID}/rotate-secret`, { method: \"POST\", headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}` } });\nconst { secret, previousSecretValidUntil } = await res.json(); // store the new secret now; both sign until previousSecretValidUntil"
          }
        ]
      }
    }
  },
  "webhooks": {
    "product.received": {
      "post": {
        "summary": "product.received",
        "description": "A new product is in our intake, whether you sent it or your CharpstAR team added it. data: What we stored: articleId, name, category, subcategory, dimensionsCm, productLink, status and receivedAt.",
        "x-event-when": "A new product is in our intake, whether you sent it or your CharpstAR team added it.",
        "x-event-data": "What we stored: articleId, name, category, subcategory, dimensionsCm, productLink, status and receivedAt.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "product.received"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReceivedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "product.received",
                  "value": {
                    "id": "3c9e1f20-7b6a-4d5c-8e9f-0a1b2c3d4e5f",
                    "type": "product.received",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "articleId": "CH-1001",
                      "name": "Oslo lounge chair",
                      "category": "Furniture",
                      "subcategory": "Chairs",
                      "dimensionsCm": {
                        "w": 72,
                        "h": 81,
                        "d": 78
                      },
                      "productLink": "https://example.com/products/oslo-lounge-chair",
                      "status": "received",
                      "receivedAt": "2026-10-20T09:30:58.000Z"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "status.changed": {
      "post": {
        "summary": "status.changed",
        "description": "A product's status changes, for example from in_production to in_review, or from approved to delivered. Internal steps that keep the same status send nothing. data: from and to, both status values.",
        "x-event-when": "A product's status changes, for example from in_production to in_review, or from approved to delivered. Internal steps that keep the same status send nothing.",
        "x-event-data": "from and to, both status values.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "status.changed"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StatusChangedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "status.changed",
                  "value": {
                    "id": "7d2e4f61-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
                    "type": "status.changed",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "from": "in_production",
                      "to": "in_review"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "review.requested": {
      "post": {
        "summary": "review.requested",
        "description": "A model has passed our quality check and waits for your approval. data: articleId and a reviewUrl that opens the model in your account.",
        "x-event-when": "A model has passed our quality check and waits for your approval.",
        "x-event-data": "articleId and a reviewUrl that opens the model in your account.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "review.requested"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReviewRequestedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "review.requested",
                  "value": {
                    "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
                    "type": "review.requested",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "articleId": "CH-1001",
                      "reviewUrl": "https://platform.charpstar.co/client-review/3f2a1b0c-4d5e-4f6a-8b7c-9d0e1f2a3b4c"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "asset.approved": {
      "post": {
        "summary": "asset.approved",
        "description": "A model is approved. We hold the event until the files are live (up to 30 minutes), so it usually arrives with status delivered and every link filled in. This is the one to act on. data: The full asset, as in GET /api/v1/assets/{article}. If the files were not live in time, only articleId and status approved; status.changed follows once it is delivered.",
        "x-event-when": "A model is approved. We hold the event until the files are live (up to 30 minutes), so it usually arrives with status delivered and every link filled in. This is the one to act on.",
        "x-event-data": "The full asset, as in GET /api/v1/assets/{article}. If the files were not live in time, only articleId and status approved; status.changed follows once it is delivered.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "asset.approved"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetApprovedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "asset.approved",
                  "value": {
                    "id": "6f1c2b9e-1d2c-4f7a-9a3b-5c6d7e8f9a0b",
                    "type": "asset.approved",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "articleId": "CH-1001",
                      "name": "Oslo lounge chair",
                      "status": "delivered",
                      "deliveryDate": "2026-10-20",
                      "updatedAt": "2026-10-20T09:30:00.000Z",
                      "glbUrl": "https://cdn.charpstar.net/YourCompany/Android/CH-1001.glb",
                      "usdzUrl": "https://cdn.charpstar.net/YourCompany/iOS/CH-1001.usdz",
                      "usdzReady": true,
                      "thumbnailUrl": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",
                      "viewerUrl": "https://platform.charpstar.co/agent-viewer?glb=https%3A%2F%2Fcdn.charpstar.net%2FYourCompany%2FAndroid%2FCH-1001.glb&name=Oslo%20lounge%20chair&viewer=default",
                      "arUrl": "https://platform.charpstar.co/ar/0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",
                      "embed": {
                        "dataClient": "YourCompany",
                        "dataArticleId": "CH-1001",
                        "snippet": "<script src=\"https://js.charpstar.net/V2/charpstAR-Base.js\" data-client=\"YourCompany\" data-language=\"en-gb\" defer></script>\n<charpstar-viewer data-articleid=\"CH-1001\"></charpstar-viewer>"
                      },
                      "images": [
                        {
                          "id": "8d2f4c1a-packshot",
                          "type": "packshot",
                          "variant": "Oak",
                          "url": "https://cdn.charpstar.net/YourCompany/Packshots/CH-1001-front.png",
                          "fileName": "CH-1001_packshot_front_1.png",
                          "width": 2048,
                          "height": 2048,
                          "bytes": 412331,
                          "createdAt": "2026-10-20T09:00:00.000Z",
                          "approved": true,
                          "primary": true,
                          "jobId": null
                        },
                        {
                          "id": "thumbnail:0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",
                          "type": "thumbnail",
                          "variant": null,
                          "url": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",
                          "fileName": "CH-1001_thumbnail_1.png",
                          "width": null,
                          "height": null,
                          "bytes": 88120,
                          "createdAt": "2026-10-20T08:55:00.000Z",
                          "approved": true,
                          "primary": false,
                          "jobId": null
                        }
                      ],
                      "variations": [
                        {
                          "articleId": "CH-1001-B",
                          "status": "in_production",
                          "thumbnailUrl": null,
                          "glbUrl": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "asset.images.updated": {
      "post": {
        "summary": "asset.images.updated",
        "description": "Images were added, replaced or removed for a product. Changes made close together arrive as one event, about a minute later. data: added and removed: image ids. Read the asset again for the images themselves.",
        "x-event-when": "Images were added, replaced or removed for a product. Changes made close together arrive as one event, about a minute later.",
        "x-event-data": "added and removed: image ids. Read the asset again for the images themselves.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "asset.images.updated"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetImagesUpdatedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "asset.images.updated",
                  "value": {
                    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
                    "type": "asset.images.updated",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "added": [
                        "8d2f4c1a-packshot"
                      ],
                      "removed": []
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "job.succeeded": {
      "post": {
        "summary": "job.succeeded",
        "description": "A job finished and its outputs are on the product. data: The job as it finished, as in GET /api/v1/jobs/{jobId}, outputs included.",
        "x-event-when": "A job finished and its outputs are on the product.",
        "x-event-data": "The job as it finished, as in GET /api/v1/jobs/{jobId}, outputs included.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "job.succeeded"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobSucceededEvent"
              },
              "examples": {
                "example1": {
                  "summary": "job.succeeded",
                  "value": {
                    "id": "2f3e4d5c-6b7a-4c8d-9e0f-1a2b3c4d5e6f",
                    "type": "job.succeeded",
                    "occurredAt": "2026-11-02T08:09:52.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                      "type": "packshot",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "succeeded",
                      "options": {
                        "views": [
                          "front",
                          "left",
                          "back"
                        ],
                        "background": "transparent",
                        "size": 4096,
                        "aspectRatio": "1:1",
                        "format": "png",
                        "shadows": true,
                        "lighting": "studio",
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": {
                        "preset": "gs1"
                      },
                      "metadata": {
                        "purchaseOrder": "PO-88213"
                      },
                      "createdAt": "2026-11-02T08:00:00.000Z",
                      "startedAt": "2026-11-02T08:01:10.000Z",
                      "finishedAt": "2026-11-02T08:09:52.000Z",
                      "outputs": [
                        {
                          "id": "c41f9a07-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
                          "type": "packshot",
                          "view": "front",
                          "format": "png",
                          "fileName": "09521234567806_C1C0.png",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C1C0.png",
                          "width": 4096,
                          "height": 4096,
                          "bytes": 3210442
                        },
                        {
                          "id": "5e83d1b2-3c4d-4e5f-9a6b-8c9d0e1f2a3b",
                          "type": "packshot",
                          "view": "left",
                          "format": "png",
                          "fileName": "09521234567806_C2C0.png",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C2C0.png",
                          "width": 4096,
                          "height": 4096,
                          "bytes": 3210442
                        },
                        {
                          "id": "f0a7c6e9-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
                          "type": "packshot",
                          "view": "back",
                          "format": "png",
                          "fileName": "09521234567806_C7C0.png",
                          "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C7C0.png",
                          "width": 4096,
                          "height": 4096,
                          "bytes": 3210442
                        }
                      ],
                      "error": null
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "job.failed": {
      "post": {
        "summary": "job.failed",
        "description": "A job could not finish. data: The job as it finished, with error filled in.",
        "x-event-when": "A job could not finish.",
        "x-event-data": "The job as it finished, with error filled in.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "job.failed"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobFailedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "job.failed",
                  "value": {
                    "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
                    "type": "job.failed",
                    "occurredAt": "2026-11-02T08:09:52.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                      "type": "packshot",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "failed",
                      "options": {
                        "views": [
                          "front",
                          "left",
                          "back"
                        ],
                        "background": "transparent",
                        "size": 4096,
                        "aspectRatio": "1:1",
                        "format": "png",
                        "shadows": true,
                        "lighting": "studio",
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": {
                        "preset": "gs1"
                      },
                      "metadata": {
                        "purchaseOrder": "PO-88213"
                      },
                      "createdAt": "2026-11-02T08:00:00.000Z",
                      "startedAt": "2026-11-02T08:01:10.000Z",
                      "finishedAt": "2026-11-02T08:09:52.000Z",
                      "outputs": [],
                      "error": {
                        "code": "internal_error",
                        "message": "The pictures could not be made. Our team has been told; you can start the job again."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "job.cancelled": {
      "post": {
        "summary": "job.cancelled",
        "description": "A job was cancelled: by you while it was queued, or stopped by our team. data: The job, as it was when it was cancelled.",
        "x-event-when": "A job was cancelled: by you while it was queued, or stopped by our team.",
        "x-event-data": "The job, as it was when it was cancelled.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "job.cancelled"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobCancelledEvent"
              },
              "examples": {
                "example1": {
                  "summary": "job.cancelled",
                  "value": {
                    "id": "4b5c6d7e-8f9a-4b0c-9d1e-2f3a4b5c6d7e",
                    "type": "job.cancelled",
                    "occurredAt": "2026-11-02T08:09:52.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": "CH-1001",
                    "data": {
                      "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
                      "type": "packshot",
                      "articleId": "CH-1001",
                      "variant": null,
                      "status": "cancelled",
                      "options": {
                        "views": [
                          "front",
                          "left",
                          "back"
                        ],
                        "background": "transparent",
                        "size": 4096,
                        "aspectRatio": "1:1",
                        "format": "png",
                        "shadows": true,
                        "lighting": "studio",
                        "preset": "Marketplace (GS1)"
                      },
                      "naming": {
                        "preset": "gs1"
                      },
                      "metadata": {
                        "purchaseOrder": "PO-88213"
                      },
                      "createdAt": "2026-11-02T08:00:00.000Z",
                      "startedAt": null,
                      "finishedAt": "2026-11-02T08:00:20.000Z",
                      "outputs": [],
                      "error": null
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "import.completed": {
      "post": {
        "summary": "import.completed",
        "description": "An import has processed every row. data: The import, as in GET /api/v1/imports/{importId}.",
        "x-event-when": "An import has processed every row.",
        "x-event-data": "The import, as in GET /api/v1/imports/{importId}.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "import.completed"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImportCompletedEvent"
              },
              "examples": {
                "example1": {
                  "summary": "import.completed",
                  "value": {
                    "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
                    "type": "import.completed",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": null,
                    "data": {
                      "id": "7a6b5c4d-0000-4000-8000-000000000022",
                      "status": "completed",
                      "dryRun": false,
                      "orderId": "4d3c2b1a-0000-4000-8000-000000000011",
                      "rows": 1200,
                      "processed": 1200,
                      "counts": {
                        "created": 1100,
                        "updated": 80,
                        "unchanged": 18,
                        "change_request": 0,
                        "exists_delivered": 0,
                        "refused": 2
                      },
                      "error": null,
                      "createdAt": "2026-10-20T09:31:00.000Z",
                      "finishedAt": "2026-10-20T09:42:00.000Z"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    },
    "ping": {
      "post": {
        "summary": "ping",
        "description": "You asked for a test with POST /api/v1/webhooks/{webhook_id}/test. Every subscription gets it; you cannot subscribe to it. data: message.",
        "x-event-when": "You asked for a test with POST /api/v1/webhooks/{webhook_id}/test. Every subscription gets it; you cannot subscribe to it.",
        "x-event-data": "message.",
        "x-status": "live",
        "parameters": [
          {
            "name": "CharpstAR-Event",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "ping"
            }
          },
          {
            "name": "CharpstAR-Delivery",
            "in": "header",
            "required": true,
            "description": "The delivery id; the same on every retry.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "CharpstAR-Signature",
            "in": "header",
            "required": true,
            "description": "t=<unix seconds>,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "const": "CharpstAR-Webhooks/1"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PingEvent"
              },
              "examples": {
                "example1": {
                  "summary": "ping",
                  "value": {
                    "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
                    "type": "ping",
                    "occurredAt": "2026-10-20T09:31:00.000Z",
                    "client": {
                      "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
                      "name": "Your Company"
                    },
                    "article": null,
                    "data": {
                      "message": "Test notification from CharpstAR."
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx within 10 seconds means handled. Anything else is retried."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer",
        "description": "Authorization: Bearer cs_live_... (cs_live_ followed by 43 characters). One key acts for one company."
      }
    },
    "headers": {
      "X-Request-Id": {
        "description": "Identifies the call. Quote it when you contact us.",
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      },
      "X-RateLimit-Limit": {
        "description": "Requests a minute allowed for this key (120).",
        "schema": {
          "type": "integer"
        }
      },
      "X-RateLimit-Remaining": {
        "description": "Requests left this minute.",
        "schema": {
          "type": "integer"
        }
      },
      "Retry-After": {
        "description": "Seconds to wait before trying again.",
        "schema": {
          "type": "integer"
        }
      }
    },
    "schemas": {
      "ProductInput": {
        "type": "object",
        "properties": {
          "articleId": {
            "type": "string",
            "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$",
            "description": "Your article number: the same one you use in your shop and on your product page. 1 to 64 characters: letters, digits, '.', '_' and '-', starting with a letter or digit. No spaces or slashes: it becomes the file name of your model and the data-articleid on your page. Unique within your account."
          },
          "externalId": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 100
              },
              {
                "type": "null"
              }
            ],
            "description": "Your system's own id for the item. Stored next to the article number, never instead of it. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "source": {
            "default": "api",
            "type": "string",
            "enum": [
              "dynamics365",
              "akeneo",
              "api"
            ],
            "description": "Where the product comes from. Leave it out (it is api), unless your CharpstAR contact gives you another value."
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300,
            "description": "The product name."
          },
          "category": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 200
              },
              {
                "type": "null"
              }
            ],
            "description": "Category. Furniture/Chairs is read as category Furniture, subcategory Chairs when you send no subcategory. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "subcategory": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 200
              },
              {
                "type": "null"
              }
            ],
            "description": "Subcategory. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "dimensionsCm": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "w": {
                    "type": "number",
                    "exclusiveMinimum": 0,
                    "exclusiveMaximum": 10000,
                    "description": "Width in cm."
                  },
                  "h": {
                    "type": "number",
                    "exclusiveMinimum": 0,
                    "exclusiveMaximum": 10000,
                    "description": "Height in cm."
                  },
                  "d": {
                    "type": "number",
                    "exclusiveMinimum": 0,
                    "exclusiveMaximum": 10000,
                    "description": "Depth in cm."
                  }
                },
                "required": [
                  "w",
                  "h",
                  "d"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "Width, height and depth in centimetres. Decimals are allowed. For a round product, send the diameter as both w and d. Left out keeps the value we hold; null clears it. Once modelling has started, a change waits for our team (change_request)."
          },
          "variants": {
            "anyOf": [
              {
                "maxItems": 50,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 64,
                      "description": "Your code for the variant, for example OAK."
                    },
                    "articleId": {
                      "anyOf": [
                        {
                          "type": "string",
                          "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Give a variant its own article number and it becomes its own product with us, with its own model and status. Without one it stays a colour or material option of this product."
                    },
                    "colour": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 100
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Colour name."
                    },
                    "material": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 100
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Material name."
                    },
                    "name": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 200
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Variant name."
                    }
                  },
                  "required": [
                    "code"
                  ]
                }
              },
              {
                "type": "null"
              }
            ],
            "description": "Variants of the product. Only ever added, never removed."
          },
          "referenceImages": {
            "anyOf": [
              {
                "maxItems": 10,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string",
                      "maxLength": 2000,
                      "pattern": "^https:\\/\\/[^\\s]+$",
                      "description": "An https link to a JPEG, PNG or WebP image, up to 10 MB, that we can fetch without a login."
                    }
                  },
                  "required": [
                    "url"
                  ]
                }
              },
              {
                "type": "null"
              }
            ],
            "description": "Photos our 3D team models from. Only ever added; a link we fetched before is not fetched again, and a picture we already hold under another link is not stored twice."
          },
          "source3dUrl": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2000,
                "pattern": "^(https:\\/\\/[^\\s]+)?$"
              },
              {
                "type": "null"
              }
            ],
            "description": "An https link to a 3D or CAD file of the product, if you have one. Our 3D team uses it as a starting point. Left out keeps the value we hold; null clears it; an empty string counts as left out. Once modelling has started, a change waits for our team (change_request)."
          },
          "productLink": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2000,
                "pattern": "^(https?:\\/\\/[^\\s]+)?$"
              },
              {
                "type": "null"
              }
            ],
            "description": "The product's page in your shop. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "active": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "false marks the product as discontinued in your system. We record it; nothing already made is removed. true brings it back. Leave it out to keep the value we hold."
          },
          "gtin": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^(\\d{8}|\\d{12}|\\d{13}|\\d{14})$"
              },
              {
                "type": "null"
              }
            ],
            "description": "GTIN-8, 12, 13 or 14. The check digit is validated. Used for GS1 file names."
          },
          "attributes": {
            "anyOf": [
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "maxLength": 60
                },
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 500
                }
              },
              {
                "type": "null"
              }
            ],
            "description": "Up to 50 key and value pairs of your own, such as a collection or a season. Available as tokens in file names."
          },
          "releaseAt": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,6})?)?(Z|[+-]\\d{2}:\\d{2})$"
              },
              {
                "type": "null"
              }
            ],
            "description": "Keeps the product's files private until this time. Until then its links are signed and expire hourly; from then on they are permanent."
          }
        },
        "required": [
          "articleId",
          "name"
        ],
        "description": "One product."
      },
      "ProductBatch": {
        "type": "object",
        "description": "Up to 50 products in one call.",
        "properties": {
          "products": {
            "type": "array",
            "minItems": 1,
            "maxItems": 50,
            "items": {
              "$ref": "#/components/schemas/ProductInput"
            }
          }
        },
        "required": [
          "products"
        ]
      },
      "ProductPatch": {
        "description": "Any subset of the product fields. A field left out keeps its value; null clears it.",
        "type": "object",
        "properties": {
          "externalId": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 100
              },
              {
                "type": "null"
              }
            ],
            "description": "Your system's own id for the item. Stored next to the article number, never instead of it. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "gtin": {
            "anyOf": [
              {
                "description": "GTIN-8, 12, 13 or 14. The check digit is validated. Used for GS1 file names.",
                "type": "string",
                "pattern": "^(\\d{8}|\\d{12}|\\d{13}|\\d{14})$"
              },
              {
                "type": "null"
              }
            ],
            "description": "GTIN-8, 12, 13 or 14. The check digit is validated. Used for GS1 file names."
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300,
            "description": "The product name."
          },
          "category": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 200
              },
              {
                "type": "null"
              }
            ],
            "description": "Category. Furniture/Chairs is read as category Furniture, subcategory Chairs when you send no subcategory. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "subcategory": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 200
              },
              {
                "type": "null"
              }
            ],
            "description": "Subcategory. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "dimensionsCm": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "w": {
                    "type": "number",
                    "exclusiveMinimum": 0,
                    "exclusiveMaximum": 10000,
                    "description": "Width in cm."
                  },
                  "h": {
                    "type": "number",
                    "exclusiveMinimum": 0,
                    "exclusiveMaximum": 10000,
                    "description": "Height in cm."
                  },
                  "d": {
                    "type": "number",
                    "exclusiveMinimum": 0,
                    "exclusiveMaximum": 10000,
                    "description": "Depth in cm."
                  }
                },
                "required": [
                  "w",
                  "h",
                  "d"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "Width, height and depth in centimetres. Decimals are allowed. For a round product, send the diameter as both w and d. Left out keeps the value we hold; null clears it. Once modelling has started, a change waits for our team (change_request)."
          },
          "variants": {
            "description": "Variants of the product. Only ever added, never removed.",
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64,
                  "description": "Your code for the variant, for example OAK."
                },
                "articleId": {
                  "anyOf": [
                    {
                      "type": "string",
                      "pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{0,63}$"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Give a variant its own article number and it becomes its own product with us, with its own model and status. Without one it stays a colour or material option of this product."
                },
                "colour": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 100
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Colour name."
                },
                "material": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 100
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Material name."
                },
                "name": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 200
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Variant name."
                }
              },
              "required": [
                "code"
              ]
            }
          },
          "referenceImages": {
            "maxItems": 10,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string",
                  "maxLength": 2000,
                  "pattern": "^https:\\/\\/\\S+$",
                  "description": "An https link to a JPEG, PNG or WebP image, up to 10 MB, that we can fetch without a login."
                }
              },
              "required": [
                "url"
              ]
            },
            "description": "Photos our 3D team models from. Only ever added; a link we fetched before is not fetched again, and a picture we already hold under another link is not stored twice."
          },
          "source3dUrl": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2000,
                "pattern": "^https:\\/\\/\\S+$"
              },
              {
                "type": "null"
              }
            ],
            "description": "An https link to a 3D or CAD file of the product, if you have one. Our 3D team uses it as a starting point. Left out keeps the value we hold; null clears it; an empty string counts as left out. Once modelling has started, a change waits for our team (change_request)."
          },
          "productLink": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2000,
                "pattern": "^https?:\\/\\/\\S+$"
              },
              {
                "type": "null"
              }
            ],
            "description": "The product's page in your shop. Left out keeps the value we hold; null clears it; an empty string counts as left out."
          },
          "attributes": {
            "anyOf": [
              {
                "description": "Up to 50 key and value pairs of your own, such as a collection or a season. Available as tokens in file names.",
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "maxLength": 60
                },
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 500
                }
              },
              {
                "type": "null"
              }
            ],
            "description": "Up to 50 key and value pairs of your own, such as a collection or a season. Available as tokens in file names."
          },
          "releaseAt": {
            "anyOf": [
              {
                "format": "date-time",
                "description": "Keeps the product's files private until this time; the links are then signed and expire hourly. From the time on, the links are permanent.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Keeps the product's files private until this time. Until then its links are signed and expire hourly; from then on they are permanent."
          },
          "active": {
            "type": "boolean",
            "description": "false marks the product as discontinued in your system. We record it; nothing already made is removed. true brings it back. Leave it out to keep the value we hold."
          }
        }
      },
      "HeartbeatInput": {
        "type": "object",
        "properties": {
          "system": {
            "default": "api",
            "type": "string",
            "enum": [
              "dynamics365",
              "akeneo",
              "api"
            ],
            "description": "Leave it out (it is api), unless your CharpstAR contact gives you another value."
          },
          "displayName": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 120
              },
              {
                "type": "null"
              }
            ],
            "description": "A name for your sync, shown to your CharpstAR contact."
          },
          "run": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "startedAt": {
                    "anyOf": [
                      {
                        "type": "string",
                        "format": "date-time"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "When the run started (ISO 8601 with an offset)."
                  },
                  "read": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 1000000
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Products read from your system."
                  },
                  "sent": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 1000000
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Products sent to us."
                  },
                  "writtenBack": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 1000000
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Products whose links or images you wrote back."
                  },
                  "errors": {
                    "anyOf": [
                      {
                        "maxItems": 20,
                        "type": "array",
                        "items": {
                          "type": "string",
                          "maxLength": 500
                        }
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Up to 20 short error messages."
                  }
                }
              },
              {
                "type": "null"
              }
            ],
            "description": "What the run did."
          }
        }
      },
      "WebhookCreate": {
        "type": "object",
        "properties": {
          "url": {
            "description": "Your receiver. https, on a public host. We do not follow redirects.",
            "type": "string",
            "maxLength": 2000,
            "pattern": "^https:\\/\\/\\S+$"
          },
          "events": {
            "description": "Which events to send. Leave it out to get every event type, including ones added later.",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "product.received",
                "status.changed",
                "review.requested",
                "change.accepted",
                "change.rejected",
                "asset.approved",
                "asset.images.updated",
                "job.succeeded",
                "job.failed",
                "job.cancelled",
                "import.completed",
                "storage.transfer.succeeded",
                "storage.transfer.failed",
                "configurator.published",
                "account.activated"
              ]
            }
          }
        },
        "required": [
          "url"
        ]
      },
      "WebhookPatch": {
        "type": "object",
        "properties": {
          "url": {
            "description": "A new receiver address.",
            "type": "string",
            "maxLength": 2000,
            "pattern": "^https:\\/\\/\\S+$"
          },
          "events": {
            "description": "The event types to receive from now on. The same names as when you create a subscription.",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "product.received",
                "status.changed",
                "review.requested",
                "change.accepted",
                "change.rejected",
                "asset.approved",
                "asset.images.updated",
                "job.succeeded",
                "job.failed",
                "job.cancelled",
                "import.completed",
                "storage.transfer.succeeded",
                "storage.transfer.failed",
                "configurator.published",
                "account.activated"
              ]
            }
          }
        }
      },
      "ReviewRequest": {
        "type": "object",
        "properties": {
          "decision": {
            "description": "approve publishes the model; request_changes sends it back to our 3D team with your comments.",
            "type": "string",
            "enum": [
              "approve",
              "request_changes"
            ]
          },
          "comments": {
            "description": "Required with request_changes.",
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "text": {
                  "description": "What should change.",
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 2000
                },
                "imageUrl": {
                  "description": "An https link to a photo or drawing that shows it.",
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 2000,
                      "pattern": "^https:\\/\\/\\S+$"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "text"
              ]
            }
          }
        },
        "required": [
          "decision"
        ]
      },
      "ImportCreate": {
        "type": "object",
        "properties": {
          "fileUrl": {
            "description": "An https link we can fetch, to an NDJSON or CSV file of products in the POST /products format.",
            "type": "string",
            "maxLength": 2000,
            "pattern": "^https:\\/\\/\\S+$"
          },
          "format": {
            "description": "NDJSON: one product per line. CSV: the field names in the header row; dimensionsCm as dimensionsCm.w, dimensionsCm.h, dimensionsCm.d.",
            "type": "string",
            "enum": [
              "ndjson",
              "csv"
            ]
          },
          "dryRun": {
            "description": "true checks the whole file and reports the outcome without writing anything.",
            "type": "boolean"
          }
        },
        "required": [
          "fileUrl",
          "format"
        ]
      },
      "JobCreate": {
        "type": "object",
        "properties": {
          "type": {
            "description": "packshot: studio images from the model. scene: AI lifestyle images with the product. edit: a change to an image. video: a turntable or a scene video. export: the model in other file formats.",
            "type": "string",
            "enum": [
              "packshot",
              "scene",
              "edit",
              "video",
              "export"
            ]
          },
          "articleId": {
            "description": "The product to work on. It must be delivered, except for edit jobs, which work on an image.",
            "type": "string"
          },
          "variant": {
            "description": "Your variant code, for models with several material variants.",
            "type": "string",
            "maxLength": 64
          },
          "options": {
            "description": "The options of the job type. Anything left out takes the default.",
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "views": {
                    "description": "One image per view: front, back, left, right and top from 15 degrees up, three_quarter_left and three_quarter_right turned 35 degrees, table straight on at table height (no plunge angle), or a custom angle. Default: the preset's views, else front.",
                    "minItems": 1,
                    "maxItems": 12,
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "front",
                            "back",
                            "left",
                            "right",
                            "top",
                            "three_quarter_left",
                            "three_quarter_right",
                            "table"
                          ]
                        },
                        {
                          "description": "A custom camera angle in degrees.",
                          "type": "object",
                          "properties": {
                            "yaw": {
                              "description": "Turn around the product, in degrees; 0 is the front.",
                              "type": "number",
                              "minimum": -180,
                              "maximum": 180
                            },
                            "pitch": {
                              "description": "Camera height, in degrees; 0 is level, 90 is straight down.",
                              "type": "number",
                              "minimum": -90,
                              "maximum": 90
                            }
                          },
                          "required": [
                            "yaw",
                            "pitch"
                          ]
                        }
                      ]
                    }
                  },
                  "background": {
                    "description": "transparent or a hex colour. Default #FFFFFF.",
                    "type": "string",
                    "pattern": "^(transparent|#[0-9A-Fa-f]{6})$"
                  },
                  "size": {
                    "description": "Long edge in pixels. Default 2048.",
                    "anyOf": [
                      {
                        "type": "number",
                        "const": 1024
                      },
                      {
                        "type": "number",
                        "const": 2048
                      },
                      {
                        "type": "number",
                        "const": 4096
                      }
                    ]
                  },
                  "aspectRatio": {
                    "description": "Default 1:1.",
                    "type": "string",
                    "enum": [
                      "1:1",
                      "16:9"
                    ]
                  },
                  "format": {
                    "description": "Default png.",
                    "type": "string",
                    "enum": [
                      "png",
                      "jpg",
                      "webp"
                    ]
                  },
                  "shadows": {
                    "description": "Contact shadows. Default true.",
                    "type": "boolean"
                  },
                  "lighting": {
                    "description": "studio: the preset's light, by default the light of your website's 3D viewer. neutral: an even, colour-neutral studio light. Default studio.",
                    "type": "string",
                    "enum": [
                      "studio",
                      "neutral"
                    ]
                  },
                  "preset": {
                    "description": "A render preset from GET /presets. Options sent next to it win.",
                    "type": "string",
                    "maxLength": 80
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "prompt": {
                    "description": "The setting, for example: Bright living room, morning light. The scene is made from the product's main picture (of the variant, when you name one).",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1000
                  },
                  "style": {
                    "description": "A saved style from GET /styles, by name or id, so a whole range shares one look. Your prompt comes after the style's.",
                    "type": "string",
                    "maxLength": 80
                  },
                  "inspirationImageUrl": {
                    "description": "An https image (JPEG, PNG or WebP, up to 10 MB) whose mood the scene should follow. Default: the style's, if it has one.",
                    "type": "string",
                    "maxLength": 2000,
                    "pattern": "^https:\\/\\/\\S+$"
                  },
                  "withArticles": {
                    "description": "Up to 4 more of your article numbers to place in the same room. Coming in a later release: a job that names any answers 400 for now.",
                    "maxItems": 4,
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "aspectRatio": {
                    "description": "Default 1:1 (1080 x 1080).",
                    "type": "string",
                    "enum": [
                      "1:1",
                      "4:3",
                      "3:4",
                      "16:9",
                      "9:16"
                    ]
                  },
                  "quality": {
                    "description": "high: 2048 px on the long side. Default standard.",
                    "type": "string",
                    "enum": [
                      "standard",
                      "high"
                    ]
                  },
                  "count": {
                    "description": "How many images, 1 to 4, each a scene of its own and each counted. Default 1.",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 4
                  }
                },
                "required": [
                  "prompt"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "imageId": {
                    "description": "The picture to edit: an id from the product's images[] (a job's outputs are there too), up to 25 megapixels. A video cannot be edited. The edited picture has the same size; a picture with a transparent background keeps it, so only what is in the picture changes.",
                    "type": "string"
                  },
                  "instruction": {
                    "description": "What to change, in words, for example: Make the light warmer.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1000
                  },
                  "region": {
                    "description": "The part of the image to change, as fractions of width and height from the top left; x + w and y + h at most 1. Only that part changes, its edge blended in. Draw it around free space: an object that reaches across its edge can come out cut, because only the region is put back. Leave it out for the whole image.",
                    "type": "object",
                    "properties": {
                      "x": {
                        "description": "Left edge, as a fraction of the width.",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 1
                      },
                      "y": {
                        "description": "Top edge, as a fraction of the height.",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 1
                      },
                      "w": {
                        "description": "Width, as a fraction of the width.",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 1
                      },
                      "h": {
                        "description": "Height, as a fraction of the height.",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 1
                      }
                    },
                    "required": [
                      "x",
                      "y",
                      "w",
                      "h"
                    ]
                  }
                },
                "required": [
                  "imageId",
                  "instruction"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "description": "turntable: one 360 degree turn of the model from the preset's first view (the front for the house preset), as a looping MP4 with a still of its first frame. scene: an 8-second 16:9 video of the product in the setting of one of its scenes (sourceImageId), no sound, added to the product as a video with the scene as its still. A scene video takes no variant, seconds or preset.",
                    "type": "string",
                    "enum": [
                      "turntable",
                      "scene"
                    ]
                  },
                  "resolution": {
                    "description": "The short side of the video: 1080 or 720 px. A turntable has the preset's proportions up to 16:9 (a square preset makes 1080 x 1080, a 16:9 one 1920 x 1080); a scene video is 1920 x 1080 or 1280 x 720. Default 1080p.",
                    "type": "string",
                    "enum": [
                      "720p",
                      "1080p"
                    ]
                  },
                  "seconds": {
                    "description": "For kind turntable: how long one turn takes. Default: the preset's own, else 3.",
                    "anyOf": [
                      {
                        "type": "number",
                        "const": 3
                      },
                      {
                        "type": "number",
                        "const": 5
                      },
                      {
                        "type": "number",
                        "const": 8
                      }
                    ]
                  },
                  "preset": {
                    "description": "For kind turntable: a render preset from GET /presets, for its light, background and shadow. Default: the house preset.",
                    "type": "string",
                    "maxLength": 80
                  },
                  "sourceImageId": {
                    "description": "For kind scene: the scene to make the video from, an id from the product's images[] of type scene or edit, up to 25 megapixels.",
                    "type": "string"
                  }
                },
                "required": [
                  "kind"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "formats": {
                    "description": "The file formats to make, each one file: fbx with its textures inside, obj and 3ds as a zip with their textures ({name}_obj.zip, {name}_3ds.zip), blend, and glb and usdz, which are your live model files and are ready at once. fbx, obj, 3ds and blend are made for the formats switched on for your account; ask your CharpstAR contact for others.",
                    "minItems": 1,
                    "maxItems": 6,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "fbx",
                        "obj",
                        "3ds",
                        "blend",
                        "glb",
                        "usdz"
                      ]
                    }
                  }
                },
                "required": [
                  "formats"
                ]
              }
            ]
          },
          "naming": {
            "description": "A naming template for this job only.",
            "type": "object",
            "properties": {
              "preset": {
                "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                "type": "string",
                "enum": [
                  "standard",
                  "gs1",
                  "amazon",
                  "custom"
                ]
              },
              "pattern": {
                "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                "type": "string",
                "maxLength": 200
              }
            },
            "required": [
              "preset"
            ]
          },
          "metadata": {
            "description": "Up to 20 key and value pairs of your own, such as an order number. Returned on the job and in its events.",
            "type": "object",
            "propertyNames": {
              "type": "string",
              "maxLength": 40
            },
            "additionalProperties": {
              "type": "string",
              "maxLength": 200
            }
          }
        },
        "required": [
          "type",
          "articleId"
        ]
      },
      "JobBatch": {
        "type": "object",
        "properties": {
          "jobs": {
            "description": "Up to 50 jobs, each answered on its own.",
            "minItems": 1,
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "description": "packshot: studio images from the model. scene: AI lifestyle images with the product. edit: a change to an image. video: a turntable or a scene video. export: the model in other file formats.",
                  "type": "string",
                  "enum": [
                    "packshot",
                    "scene",
                    "edit",
                    "video",
                    "export"
                  ]
                },
                "articleId": {
                  "description": "The product to work on. It must be delivered, except for edit jobs, which work on an image.",
                  "type": "string"
                },
                "variant": {
                  "description": "Your variant code, for models with several material variants.",
                  "type": "string",
                  "maxLength": 64
                },
                "options": {
                  "description": "The options of the job type. Anything left out takes the default.",
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "views": {
                          "description": "One image per view: front, back, left, right and top from 15 degrees up, three_quarter_left and three_quarter_right turned 35 degrees, table straight on at table height (no plunge angle), or a custom angle. Default: the preset's views, else front.",
                          "minItems": 1,
                          "maxItems": 12,
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "front",
                                  "back",
                                  "left",
                                  "right",
                                  "top",
                                  "three_quarter_left",
                                  "three_quarter_right",
                                  "table"
                                ]
                              },
                              {
                                "description": "A custom camera angle in degrees.",
                                "type": "object",
                                "properties": {
                                  "yaw": {
                                    "description": "Turn around the product, in degrees; 0 is the front.",
                                    "type": "number",
                                    "minimum": -180,
                                    "maximum": 180
                                  },
                                  "pitch": {
                                    "description": "Camera height, in degrees; 0 is level, 90 is straight down.",
                                    "type": "number",
                                    "minimum": -90,
                                    "maximum": 90
                                  }
                                },
                                "required": [
                                  "yaw",
                                  "pitch"
                                ]
                              }
                            ]
                          }
                        },
                        "background": {
                          "description": "transparent or a hex colour. Default #FFFFFF.",
                          "type": "string",
                          "pattern": "^(transparent|#[0-9A-Fa-f]{6})$"
                        },
                        "size": {
                          "description": "Long edge in pixels. Default 2048.",
                          "anyOf": [
                            {
                              "type": "number",
                              "const": 1024
                            },
                            {
                              "type": "number",
                              "const": 2048
                            },
                            {
                              "type": "number",
                              "const": 4096
                            }
                          ]
                        },
                        "aspectRatio": {
                          "description": "Default 1:1.",
                          "type": "string",
                          "enum": [
                            "1:1",
                            "16:9"
                          ]
                        },
                        "format": {
                          "description": "Default png.",
                          "type": "string",
                          "enum": [
                            "png",
                            "jpg",
                            "webp"
                          ]
                        },
                        "shadows": {
                          "description": "Contact shadows. Default true.",
                          "type": "boolean"
                        },
                        "lighting": {
                          "description": "studio: the preset's light, by default the light of your website's 3D viewer. neutral: an even, colour-neutral studio light. Default studio.",
                          "type": "string",
                          "enum": [
                            "studio",
                            "neutral"
                          ]
                        },
                        "preset": {
                          "description": "A render preset from GET /presets. Options sent next to it win.",
                          "type": "string",
                          "maxLength": 80
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "prompt": {
                          "description": "The setting, for example: Bright living room, morning light. The scene is made from the product's main picture (of the variant, when you name one).",
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 1000
                        },
                        "style": {
                          "description": "A saved style from GET /styles, by name or id, so a whole range shares one look. Your prompt comes after the style's.",
                          "type": "string",
                          "maxLength": 80
                        },
                        "inspirationImageUrl": {
                          "description": "An https image (JPEG, PNG or WebP, up to 10 MB) whose mood the scene should follow. Default: the style's, if it has one.",
                          "type": "string",
                          "maxLength": 2000,
                          "pattern": "^https:\\/\\/\\S+$"
                        },
                        "withArticles": {
                          "description": "Up to 4 more of your article numbers to place in the same room. Coming in a later release: a job that names any answers 400 for now.",
                          "maxItems": 4,
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "aspectRatio": {
                          "description": "Default 1:1 (1080 x 1080).",
                          "type": "string",
                          "enum": [
                            "1:1",
                            "4:3",
                            "3:4",
                            "16:9",
                            "9:16"
                          ]
                        },
                        "quality": {
                          "description": "high: 2048 px on the long side. Default standard.",
                          "type": "string",
                          "enum": [
                            "standard",
                            "high"
                          ]
                        },
                        "count": {
                          "description": "How many images, 1 to 4, each a scene of its own and each counted. Default 1.",
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 4
                        }
                      },
                      "required": [
                        "prompt"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "imageId": {
                          "description": "The picture to edit: an id from the product's images[] (a job's outputs are there too), up to 25 megapixels. A video cannot be edited. The edited picture has the same size; a picture with a transparent background keeps it, so only what is in the picture changes.",
                          "type": "string"
                        },
                        "instruction": {
                          "description": "What to change, in words, for example: Make the light warmer.",
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 1000
                        },
                        "region": {
                          "description": "The part of the image to change, as fractions of width and height from the top left; x + w and y + h at most 1. Only that part changes, its edge blended in. Draw it around free space: an object that reaches across its edge can come out cut, because only the region is put back. Leave it out for the whole image.",
                          "type": "object",
                          "properties": {
                            "x": {
                              "description": "Left edge, as a fraction of the width.",
                              "type": "number",
                              "minimum": 0,
                              "maximum": 1
                            },
                            "y": {
                              "description": "Top edge, as a fraction of the height.",
                              "type": "number",
                              "minimum": 0,
                              "maximum": 1
                            },
                            "w": {
                              "description": "Width, as a fraction of the width.",
                              "type": "number",
                              "minimum": 0,
                              "maximum": 1
                            },
                            "h": {
                              "description": "Height, as a fraction of the height.",
                              "type": "number",
                              "minimum": 0,
                              "maximum": 1
                            }
                          },
                          "required": [
                            "x",
                            "y",
                            "w",
                            "h"
                          ]
                        }
                      },
                      "required": [
                        "imageId",
                        "instruction"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "kind": {
                          "description": "turntable: one 360 degree turn of the model from the preset's first view (the front for the house preset), as a looping MP4 with a still of its first frame. scene: an 8-second 16:9 video of the product in the setting of one of its scenes (sourceImageId), no sound, added to the product as a video with the scene as its still. A scene video takes no variant, seconds or preset.",
                          "type": "string",
                          "enum": [
                            "turntable",
                            "scene"
                          ]
                        },
                        "resolution": {
                          "description": "The short side of the video: 1080 or 720 px. A turntable has the preset's proportions up to 16:9 (a square preset makes 1080 x 1080, a 16:9 one 1920 x 1080); a scene video is 1920 x 1080 or 1280 x 720. Default 1080p.",
                          "type": "string",
                          "enum": [
                            "720p",
                            "1080p"
                          ]
                        },
                        "seconds": {
                          "description": "For kind turntable: how long one turn takes. Default: the preset's own, else 3.",
                          "anyOf": [
                            {
                              "type": "number",
                              "const": 3
                            },
                            {
                              "type": "number",
                              "const": 5
                            },
                            {
                              "type": "number",
                              "const": 8
                            }
                          ]
                        },
                        "preset": {
                          "description": "For kind turntable: a render preset from GET /presets, for its light, background and shadow. Default: the house preset.",
                          "type": "string",
                          "maxLength": 80
                        },
                        "sourceImageId": {
                          "description": "For kind scene: the scene to make the video from, an id from the product's images[] of type scene or edit, up to 25 megapixels.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "kind"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "formats": {
                          "description": "The file formats to make, each one file: fbx with its textures inside, obj and 3ds as a zip with their textures ({name}_obj.zip, {name}_3ds.zip), blend, and glb and usdz, which are your live model files and are ready at once. fbx, obj, 3ds and blend are made for the formats switched on for your account; ask your CharpstAR contact for others.",
                          "minItems": 1,
                          "maxItems": 6,
                          "type": "array",
                          "items": {
                            "type": "string",
                            "enum": [
                              "fbx",
                              "obj",
                              "3ds",
                              "blend",
                              "glb",
                              "usdz"
                            ]
                          }
                        }
                      },
                      "required": [
                        "formats"
                      ]
                    }
                  ]
                },
                "naming": {
                  "description": "A naming template for this job only.",
                  "type": "object",
                  "properties": {
                    "preset": {
                      "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                      "type": "string",
                      "enum": [
                        "standard",
                        "gs1",
                        "amazon",
                        "custom"
                      ]
                    },
                    "pattern": {
                      "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                      "type": "string",
                      "maxLength": 200
                    }
                  },
                  "required": [
                    "preset"
                  ]
                },
                "metadata": {
                  "description": "Up to 20 key and value pairs of your own, such as an order number. Returned on the job and in its events.",
                  "type": "object",
                  "propertyNames": {
                    "type": "string",
                    "maxLength": 40
                  },
                  "additionalProperties": {
                    "type": "string",
                    "maxLength": 200
                  }
                }
              },
              "required": [
                "type",
                "articleId"
              ]
            }
          }
        },
        "required": [
          "jobs"
        ]
      },
      "Naming": {
        "description": "How files are named.",
        "type": "object",
        "properties": {
          "preset": {
            "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
            "type": "string",
            "enum": [
              "standard",
              "gs1",
              "amazon",
              "custom"
            ]
          },
          "pattern": {
            "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
            "type": "string",
            "maxLength": 200
          }
        },
        "required": [
          "preset"
        ]
      },
      "Error": {
        "description": "Every error answers this shape.",
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "validation_failed",
                  "unauthorized",
                  "forbidden",
                  "allowance_reached",
                  "not_found",
                  "in_progress",
                  "not_ready",
                  "not_cancellable",
                  "idempotency_conflict",
                  "limit_reached",
                  "too_large",
                  "rate_limited",
                  "internal_error"
                ]
              },
              "message": {
                "description": "A sentence for people. Build your logic on code, not on the message.",
                "type": "string"
              },
              "details": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              }
            },
            "required": [
              "code",
              "message"
            ]
          }
        },
        "required": [
          "error"
        ],
        "x-error-codes": [
          {
            "code": "validation_failed",
            "http": 400,
            "meaning": "The body is not JSON, a field is missing or not valid (details.issues lists each one with its path), a batch is empty or over the limit, or a query value is not valid.",
            "action": "Fix the request. Sending it again unchanged fails the same way.",
            "retry": false
          },
          {
            "code": "unauthorized",
            "http": 401,
            "meaning": "The key is missing, malformed, unknown, revoked or expired.",
            "action": "Check the Authorization header, or create a new key in your account.",
            "retry": false
          },
          {
            "code": "forbidden",
            "http": 403,
            "meaning": "The key is valid but may not make this call. details.reason is client_not_enabled (the API is not switched on for your company yet) or missing_scope (details.scope names the scope the key lacks).",
            "action": "Ask your CharpstAR contact to switch the API on, or use a key with that scope.",
            "retry": false
          },
          {
            "code": "allowance_reached",
            "http": 402,
            "meaning": "Your allowance for this kind of work is used up for the period. details gives kind (a usage kind such as model_ordered or model_replaced, or models_in_contract when the contract's number of models would be passed), used, allowance, period and resetsAt. GET /api/v1/account shows the same numbers.",
            "action": "Wait for the period to reset, or ask your CharpstAR contact to raise the allowance.",
            "retry": false
          },
          {
            "code": "not_found",
            "http": 404,
            "meaning": "There is no such article, order, job, import, configurator or subscription in your account, or the API is switched off.",
            "action": "Check the id or article number. Send the product first if it is new.",
            "retry": false
          },
          {
            "code": "in_progress",
            "http": 409,
            "meaning": "Another call is creating the same article right now. details.retry is true.",
            "action": "Send it again after a few seconds.",
            "retry": true
          },
          {
            "code": "not_ready",
            "http": 409,
            "meaning": "The thing is not in a state for this call yet: a model not waiting for your review, a delivered model (changes are requested in your account for now), a product with variations (reviewed in your account), an import that has not finished, or a job's product without a delivered model. details.status says where it is.",
            "action": "Read the product, import or job again and retry when details.status allows it.",
            "retry": false
          },
          {
            "code": "not_cancellable",
            "http": 409,
            "meaning": "The product cannot be cancelled: modelling has started for it or one of its variations. details.status is its status and details.articleId the article that has started.",
            "action": "Talk to your CharpstAR contact.",
            "retry": false
          },
          {
            "code": "idempotency_conflict",
            "http": 409,
            "meaning": "The Idempotency-Key was already used with a different body within the last 24 hours.",
            "action": "Use a new key for a new request.",
            "retry": false
          },
          {
            "code": "limit_reached",
            "http": 409,
            "meaning": "You already have the maximum number of active event subscriptions. details.max is the limit.",
            "action": "Stop one you no longer use, then subscribe again.",
            "retry": false
          },
          {
            "code": "too_large",
            "http": 413,
            "meaning": "The request body is over 4 MB. details.maxBytes is the limit.",
            "action": "Send images and 3D files as links, and split large batches.",
            "retry": false
          },
          {
            "code": "rate_limited",
            "http": 429,
            "meaning": "Too many calls this minute (details.retryAfter, in seconds), or the key's daily limit is used up (details.reason is daily_quota, details.quota is the limit).",
            "action": "Wait for the Retry-After header, then try again.",
            "retry": true
          },
          {
            "code": "internal_error",
            "http": 500,
            "meaning": "Something went wrong on our side. details.requestId identifies the call.",
            "action": "Retry with backoff. If it keeps happening, send us the requestId.",
            "retry": true
          }
        ]
      },
      "Me": {
        "type": "object",
        "properties": {
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "keyPrefix": {
            "description": "The first 12 characters of the key, safe to log.",
            "type": "string"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "products:read",
                "products:write",
                "reviews:write",
                "assets:read",
                "webhooks:manage",
                "account:read",
                "jobs:read",
                "jobs:write",
                "settings:write"
              ]
            }
          },
          "expiresAt": {
            "description": "When the key stops working, or null. From slice S2.",
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "client",
          "keyPrefix",
          "scopes"
        ]
      },
      "UpsertResult": {
        "type": "object",
        "properties": {
          "articleId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "result": {
            "type": "string",
            "enum": [
              "created",
              "updated",
              "unchanged",
              "change_request",
              "exists_delivered",
              "refused"
            ]
          },
          "status": {
            "description": "Where the product is. Build your logic on this value.",
            "type": "string",
            "enum": [
              "received",
              "in_production",
              "in_review",
              "approved",
              "delivered",
              "cancelled"
            ]
          },
          "statusDetail": {
            "type": "string",
            "const": "waiting_for_information"
          },
          "orderId": {
            "description": "The order (intake batch) the product landed in. From slice S4.",
            "format": "uuid",
            "type": "string"
          },
          "pendingChanges": {
            "description": "Changes held for our production team (result change_request).",
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "dimensionsCm",
                        "source3dUrl"
                      ]
                    },
                    "from": {
                      "description": "What we work from now."
                    },
                    "to": {
                      "description": "What you sent."
                    },
                    "requestedAt": {
                      "anyOf": [
                        {
                          "format": "date-time",
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "from",
                    "to",
                    "requestedAt"
                  ]
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "variantsCreated": {
            "description": "Variant article numbers that became their own products.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "warnings": {
            "description": "For example a reference image we could not fetch. The product itself was saved.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "error": {
            "description": "Only when result is refused.",
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "validation_failed",
                  "unauthorized",
                  "forbidden",
                  "allowance_reached",
                  "not_found",
                  "in_progress",
                  "not_ready",
                  "not_cancellable",
                  "idempotency_conflict",
                  "limit_reached",
                  "too_large",
                  "rate_limited",
                  "internal_error"
                ]
              },
              "message": {
                "description": "A sentence for people. Build your logic on code, not on the message.",
                "type": "string"
              },
              "details": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              }
            },
            "required": [
              "code",
              "message"
            ]
          }
        },
        "required": [
          "articleId",
          "result"
        ]
      },
      "BatchResult": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "result": {
                  "type": "string",
                  "enum": [
                    "created",
                    "updated",
                    "unchanged",
                    "change_request",
                    "exists_delivered",
                    "refused"
                  ]
                },
                "status": {
                  "description": "Where the product is. Build your logic on this value.",
                  "type": "string",
                  "enum": [
                    "received",
                    "in_production",
                    "in_review",
                    "approved",
                    "delivered",
                    "cancelled"
                  ]
                },
                "statusDetail": {
                  "type": "string",
                  "const": "waiting_for_information"
                },
                "orderId": {
                  "description": "The order (intake batch) the product landed in. From slice S4.",
                  "format": "uuid",
                  "type": "string"
                },
                "pendingChanges": {
                  "description": "Changes held for our production team (result change_request).",
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "enum": [
                              "dimensionsCm",
                              "source3dUrl"
                            ]
                          },
                          "from": {
                            "description": "What we work from now."
                          },
                          "to": {
                            "description": "What you sent."
                          },
                          "requestedAt": {
                            "anyOf": [
                              {
                                "format": "date-time",
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "field",
                          "from",
                          "to",
                          "requestedAt"
                        ]
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "variantsCreated": {
                  "description": "Variant article numbers that became their own products.",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "warnings": {
                  "description": "For example a reference image we could not fetch. The product itself was saved.",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "error": {
                  "description": "Only when result is refused.",
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "enum": [
                        "validation_failed",
                        "unauthorized",
                        "forbidden",
                        "allowance_reached",
                        "not_found",
                        "in_progress",
                        "not_ready",
                        "not_cancellable",
                        "idempotency_conflict",
                        "limit_reached",
                        "too_large",
                        "rate_limited",
                        "internal_error"
                      ]
                    },
                    "message": {
                      "description": "A sentence for people. Build your logic on code, not on the message.",
                      "type": "string"
                    },
                    "details": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "code",
                    "message"
                  ]
                },
                "httpStatus": {
                  "type": "integer"
                }
              },
              "required": [
                "articleId",
                "result",
                "httpStatus"
              ]
            }
          }
        },
        "required": [
          "results"
        ]
      },
      "HeartbeatResult": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean",
            "const": true
          },
          "system": {
            "type": "string"
          },
          "lastSyncAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "ok",
          "system",
          "lastSyncAt"
        ]
      },
      "Product": {
        "type": "object",
        "properties": {
          "articleId": {
            "type": "string"
          },
          "externalId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "gtin": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "name": {
            "type": "string"
          },
          "category": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "subcategory": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "dimensionsCm": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "w": {
                    "type": "number"
                  },
                  "h": {
                    "type": "number"
                  },
                  "d": {
                    "type": "number"
                  }
                },
                "required": [
                  "w",
                  "h",
                  "d"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "variants": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string"
                },
                "articleId": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "colour": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "material": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "name": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "code",
                "articleId",
                "colour",
                "material",
                "name"
              ]
            }
          },
          "referenceImages": {
            "description": "The references we hold, as our copies.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "format": "uri",
                  "type": "string"
                }
              },
              "required": [
                "url"
              ]
            }
          },
          "source3dUrl": {
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "productLink": {
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "attributes": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "releaseAt": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "active": {
            "type": "boolean"
          },
          "status": {
            "description": "Where the product is. Build your logic on this value.",
            "type": "string",
            "enum": [
              "received",
              "in_production",
              "in_review",
              "approved",
              "delivered",
              "cancelled"
            ]
          },
          "statusDetail": {
            "type": "string",
            "const": "waiting_for_information"
          },
          "orderId": {
            "anyOf": [
              {
                "format": "uuid",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "pendingChanges": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "dimensionsCm",
                        "source3dUrl"
                      ]
                    },
                    "from": {
                      "description": "What we work from now."
                    },
                    "to": {
                      "description": "What you sent."
                    },
                    "requestedAt": {
                      "anyOf": [
                        {
                          "format": "date-time",
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "from",
                    "to",
                    "requestedAt"
                  ]
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "deliveryDate": {
            "anyOf": [
              {
                "format": "date",
                "description": "A date, YYYY-MM-DD.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "articleId",
          "externalId",
          "gtin",
          "name",
          "category",
          "subcategory",
          "dimensionsCm",
          "variants",
          "referenceImages",
          "source3dUrl",
          "productLink",
          "attributes",
          "releaseAt",
          "active",
          "status",
          "orderId",
          "pendingChanges",
          "deliveryDate",
          "createdAt",
          "updatedAt"
        ]
      },
      "ProductList": {
        "type": "object",
        "properties": {
          "products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "type": "string"
                },
                "externalId": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "gtin": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "name": {
                  "type": "string"
                },
                "category": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "subcategory": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "dimensionsCm": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "w": {
                          "type": "number"
                        },
                        "h": {
                          "type": "number"
                        },
                        "d": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "w",
                        "h",
                        "d"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "variants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "articleId": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "colour": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "material": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "name": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      }
                    },
                    "required": [
                      "code",
                      "articleId",
                      "colour",
                      "material",
                      "name"
                    ]
                  }
                },
                "referenceImages": {
                  "description": "The references we hold, as our copies.",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "format": "uri",
                        "type": "string"
                      }
                    },
                    "required": [
                      "url"
                    ]
                  }
                },
                "source3dUrl": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "productLink": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "attributes": {
                  "type": "object",
                  "propertyNames": {
                    "type": "string"
                  },
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "releaseAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "active": {
                  "type": "boolean"
                },
                "status": {
                  "description": "Where the product is. Build your logic on this value.",
                  "type": "string",
                  "enum": [
                    "received",
                    "in_production",
                    "in_review",
                    "approved",
                    "delivered",
                    "cancelled"
                  ]
                },
                "statusDetail": {
                  "type": "string",
                  "const": "waiting_for_information"
                },
                "orderId": {
                  "anyOf": [
                    {
                      "format": "uuid",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "pendingChanges": {
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "enum": [
                              "dimensionsCm",
                              "source3dUrl"
                            ]
                          },
                          "from": {
                            "description": "What we work from now."
                          },
                          "to": {
                            "description": "What you sent."
                          },
                          "requestedAt": {
                            "anyOf": [
                              {
                                "format": "date-time",
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "field",
                          "from",
                          "to",
                          "requestedAt"
                        ]
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "deliveryDate": {
                  "anyOf": [
                    {
                      "format": "date",
                      "description": "A date, YYYY-MM-DD.",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "createdAt": {
                  "format": "date-time",
                  "type": "string"
                },
                "updatedAt": {
                  "format": "date-time",
                  "type": "string"
                }
              },
              "required": [
                "articleId",
                "externalId",
                "gtin",
                "name",
                "category",
                "subcategory",
                "dimensionsCm",
                "variants",
                "referenceImages",
                "source3dUrl",
                "productLink",
                "attributes",
                "releaseAt",
                "active",
                "status",
                "orderId",
                "pendingChanges",
                "deliveryDate",
                "createdAt",
                "updatedAt"
              ]
            }
          },
          "nextCursor": {
            "description": "Pass it as cursor for the next page. null when there is no more.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "products",
          "nextCursor"
        ]
      },
      "CancelResult": {
        "type": "object",
        "properties": {
          "articleId": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "const": "cancelled"
          },
          "cancelledAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "articleId",
          "status",
          "cancelledAt"
        ]
      },
      "ReviewResult": {
        "type": "object",
        "properties": {
          "articleId": {
            "type": "string"
          },
          "decision": {
            "type": "string",
            "enum": [
              "approve",
              "request_changes"
            ]
          },
          "status": {
            "description": "Where the product is. Build your logic on this value.",
            "type": "string",
            "enum": [
              "received",
              "in_production",
              "in_review",
              "approved",
              "delivered",
              "cancelled"
            ]
          },
          "reviewedAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "articleId",
          "decision",
          "status",
          "reviewedAt"
        ]
      },
      "Order": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "status": {
            "description": "Worked out from the items: delivered when every item is delivered or cancelled; in_review when any item waits for you; in_production when any item is being made; else received.",
            "type": "string",
            "enum": [
              "received",
              "in_production",
              "in_review",
              "delivered",
              "cancelled"
            ]
          },
          "source": {
            "description": "Where the order was placed: through the API, in the CharpstAR account, or by an import.",
            "type": "string",
            "enum": [
              "api",
              "platform",
              "import"
            ]
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "counts": {
            "description": "How many items are in each status.",
            "type": "object",
            "propertyNames": {
              "type": "string",
              "enum": [
                "received",
                "in_production",
                "in_review",
                "approved",
                "delivered",
                "cancelled"
              ]
            },
            "additionalProperties": {
              "type": "integer"
            }
          },
          "items": {
            "description": "In GET /orders/{orderId} only.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "type": "string"
                },
                "status": {
                  "description": "Where the product is. Build your logic on this value.",
                  "type": "string",
                  "enum": [
                    "received",
                    "in_production",
                    "in_review",
                    "approved",
                    "delivered",
                    "cancelled"
                  ]
                },
                "statusDetail": {
                  "type": "string",
                  "const": "waiting_for_information"
                },
                "deliveryDate": {
                  "anyOf": [
                    {
                      "format": "date",
                      "description": "A date, YYYY-MM-DD.",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "pendingChanges": {
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "enum": [
                              "dimensionsCm",
                              "source3dUrl"
                            ]
                          },
                          "from": {
                            "description": "What we work from now."
                          },
                          "to": {
                            "description": "What you sent."
                          },
                          "requestedAt": {
                            "anyOf": [
                              {
                                "format": "date-time",
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "field",
                          "from",
                          "to",
                          "requestedAt"
                        ]
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "articleId",
                "status",
                "deliveryDate",
                "pendingChanges"
              ]
            }
          }
        },
        "required": [
          "id",
          "status",
          "source",
          "createdAt",
          "counts"
        ]
      },
      "OrderList": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "format": "uuid",
                  "type": "string"
                },
                "status": {
                  "description": "Worked out from the items: delivered when every item is delivered or cancelled; in_review when any item waits for you; in_production when any item is being made; else received.",
                  "type": "string",
                  "enum": [
                    "received",
                    "in_production",
                    "in_review",
                    "delivered",
                    "cancelled"
                  ]
                },
                "source": {
                  "description": "Where the order was placed: through the API, in the CharpstAR account, or by an import.",
                  "type": "string",
                  "enum": [
                    "api",
                    "platform",
                    "import"
                  ]
                },
                "createdAt": {
                  "format": "date-time",
                  "type": "string"
                },
                "counts": {
                  "description": "How many items are in each status.",
                  "type": "object",
                  "propertyNames": {
                    "type": "string",
                    "enum": [
                      "received",
                      "in_production",
                      "in_review",
                      "approved",
                      "delivered",
                      "cancelled"
                    ]
                  },
                  "additionalProperties": {
                    "type": "integer"
                  }
                }
              },
              "required": [
                "id",
                "status",
                "source",
                "createdAt",
                "counts"
              ]
            }
          },
          "nextCursor": {
            "description": "Pass it as cursor for the next page. null when there is no more.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "orders",
          "nextCursor"
        ]
      },
      "Import": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "completed",
              "failed"
            ]
          },
          "dryRun": {
            "type": "boolean"
          },
          "orderId": {
            "description": "The order the imported products landed in (null for a dry run).",
            "anyOf": [
              {
                "format": "uuid",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "rows": {
            "description": "Rows in the file, once read.",
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "processed": {
            "type": "integer"
          },
          "counts": {
            "description": "How many rows ended in each result so far.",
            "type": "object",
            "propertyNames": {
              "type": "string",
              "enum": [
                "created",
                "updated",
                "unchanged",
                "change_request",
                "exists_delivered",
                "refused"
              ]
            },
            "additionalProperties": {
              "type": "integer"
            }
          },
          "error": {
            "description": "Why the import failed, when it did.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "finishedAt": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "status",
          "dryRun",
          "orderId",
          "rows",
          "processed",
          "counts",
          "error",
          "createdAt",
          "finishedAt"
        ]
      },
      "ImportResultLine": {
        "type": "object",
        "properties": {
          "articleId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "result": {
            "type": "string",
            "enum": [
              "created",
              "updated",
              "unchanged",
              "change_request",
              "exists_delivered",
              "refused"
            ]
          },
          "status": {
            "description": "Where the product is. Build your logic on this value.",
            "type": "string",
            "enum": [
              "received",
              "in_production",
              "in_review",
              "approved",
              "delivered",
              "cancelled"
            ]
          },
          "statusDetail": {
            "type": "string",
            "const": "waiting_for_information"
          },
          "orderId": {
            "description": "The order (intake batch) the product landed in. From slice S4.",
            "format": "uuid",
            "type": "string"
          },
          "pendingChanges": {
            "description": "Changes held for our production team (result change_request).",
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "dimensionsCm",
                        "source3dUrl"
                      ]
                    },
                    "from": {
                      "description": "What we work from now."
                    },
                    "to": {
                      "description": "What you sent."
                    },
                    "requestedAt": {
                      "anyOf": [
                        {
                          "format": "date-time",
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "from",
                    "to",
                    "requestedAt"
                  ]
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "variantsCreated": {
            "description": "Variant article numbers that became their own products.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "warnings": {
            "description": "For example a reference image we could not fetch. The product itself was saved.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "error": {
            "description": "Only when result is refused.",
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "validation_failed",
                  "unauthorized",
                  "forbidden",
                  "allowance_reached",
                  "not_found",
                  "in_progress",
                  "not_ready",
                  "not_cancellable",
                  "idempotency_conflict",
                  "limit_reached",
                  "too_large",
                  "rate_limited",
                  "internal_error"
                ]
              },
              "message": {
                "description": "A sentence for people. Build your logic on code, not on the message.",
                "type": "string"
              },
              "details": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              }
            },
            "required": [
              "code",
              "message"
            ]
          },
          "row": {
            "description": "The line number in the file, counting from 1.",
            "type": "integer"
          },
          "httpStatus": {
            "type": "integer"
          }
        },
        "required": [
          "articleId",
          "result",
          "row",
          "httpStatus"
        ]
      },
      "Coverage": {
        "type": "object",
        "properties": {
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "total": {
            "type": "integer"
          },
          "with3d": {
            "description": "Products with a delivered model.",
            "type": "integer"
          },
          "inProduction": {
            "description": "Products being made, in review or approved.",
            "type": "integer"
          },
          "without3d": {
            "description": "Products we hold that have no model and no order in progress.",
            "type": "integer"
          },
          "byCategory": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "category": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "total": {
                  "type": "integer"
                },
                "with3d": {
                  "type": "integer"
                },
                "inProduction": {
                  "type": "integer"
                },
                "without3d": {
                  "type": "integer"
                }
              },
              "required": [
                "category",
                "total",
                "with3d",
                "inProduction",
                "without3d"
              ]
            }
          },
          "missing": {
            "description": "Article numbers without a model, up to 500; use GET /products?has3d=false for all of them.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "client",
          "total",
          "with3d",
          "inProduction",
          "without3d",
          "byCategory",
          "missing"
        ]
      },
      "Asset": {
        "type": "object",
        "properties": {
          "articleId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "description": "Where the product is. Build your logic on this value.",
            "type": "string",
            "enum": [
              "received",
              "in_production",
              "in_review",
              "approved",
              "delivered",
              "cancelled"
            ]
          },
          "statusDetail": {
            "description": "With status received: we need something from you, usually references or dimensions.",
            "type": "string",
            "const": "waiting_for_information"
          },
          "deliveryDate": {
            "description": "The planned delivery date, when there is one.",
            "anyOf": [
              {
                "format": "date",
                "description": "A date, YYYY-MM-DD.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "updatedAt": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "glbUrl": {
            "description": "The 3D model for web viewers and Android AR. Never changes for an article; the file behind it does.",
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "usdzUrl": {
            "description": "The model for AR on iPhone and iPad.",
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "usdzReady": {
            "description": "false for a short while after delivery, while the iPhone file is prepared.",
            "type": "boolean"
          },
          "thumbnailUrl": {
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "viewerUrl": {
            "description": "A hosted page with the interactive 3D view.",
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "arUrl": {
            "description": "One link that opens AR on any phone, and the 3D view on a computer.",
            "anyOf": [
              {
                "format": "uri",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "embed": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dataClient": {
                    "description": "The data-client value for the embed script.",
                    "type": "string"
                  },
                  "dataArticleId": {
                    "type": "string"
                  },
                  "snippet": {
                    "description": "The full snippet for this article, ready to paste.",
                    "type": "string"
                  }
                },
                "required": [
                  "dataClient",
                  "dataArticleId",
                  "snippet"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "images": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Stable id of the image. A replaced image gets a new id; the old one is listed under removed in asset.images.updated.",
                  "type": "string"
                },
                "type": {
                  "description": "packshot: the product on a plain background. thumbnail: the still of the model. scene: the product in a setting. render: other angles and details. overlay: a scene with the product placed in it. variation: the thumbnail of a variant. video: a short clip (posterUrl is its still). edit: an image changed by an edit job; the image it was made from stays as it was.",
                  "type": "string",
                  "enum": [
                    "packshot",
                    "thumbnail",
                    "scene",
                    "render",
                    "overlay",
                    "variation",
                    "video",
                    "edit"
                  ]
                },
                "variant": {
                  "description": "The variant the image shows, or null for the main product.",
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "url": {
                  "format": "uri",
                  "type": "string"
                },
                "fileName": {
                  "description": "The file name from your naming choice (GET /naming). A job's picture keeps the name it was made under; the rest follow the choice as it is now.",
                  "type": "string"
                },
                "posterUrl": {
                  "description": "Videos only: a still frame.",
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "width": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "height": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "bytes": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "createdAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "approved": {
                  "description": "true once the image is approved for use. Only use approved images in your shop.",
                  "type": "boolean"
                },
                "primary": {
                  "description": "true for the one image we suggest as the main product image.",
                  "type": "boolean"
                },
                "jobId": {
                  "description": "The job that made the image, or null.",
                  "anyOf": [
                    {
                      "format": "uuid",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "type",
                "variant",
                "url",
                "fileName",
                "width",
                "height",
                "bytes",
                "createdAt",
                "approved",
                "primary",
                "jobId"
              ]
            }
          },
          "variations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "type": "string"
                },
                "status": {
                  "description": "Where the product is. Build your logic on this value.",
                  "type": "string",
                  "enum": [
                    "received",
                    "in_production",
                    "in_review",
                    "approved",
                    "delivered",
                    "cancelled"
                  ]
                },
                "thumbnailUrl": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "glbUrl": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "articleId",
                "status",
                "thumbnailUrl",
                "glbUrl"
              ]
            }
          }
        },
        "required": [
          "articleId",
          "name",
          "status",
          "deliveryDate",
          "updatedAt",
          "glbUrl",
          "usdzUrl",
          "usdzReady",
          "thumbnailUrl",
          "viewerUrl",
          "arUrl",
          "embed",
          "images",
          "variations"
        ]
      },
      "AssetList": {
        "type": "object",
        "properties": {
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "assets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "status": {
                  "description": "Where the product is. Build your logic on this value.",
                  "type": "string",
                  "enum": [
                    "received",
                    "in_production",
                    "in_review",
                    "approved",
                    "delivered",
                    "cancelled"
                  ]
                },
                "statusDetail": {
                  "description": "With status received: we need something from you, usually references or dimensions.",
                  "type": "string",
                  "const": "waiting_for_information"
                },
                "deliveryDate": {
                  "description": "The planned delivery date, when there is one.",
                  "anyOf": [
                    {
                      "format": "date",
                      "description": "A date, YYYY-MM-DD.",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "updatedAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "glbUrl": {
                  "description": "The 3D model for web viewers and Android AR. Never changes for an article; the file behind it does.",
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "usdzUrl": {
                  "description": "The model for AR on iPhone and iPad.",
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "usdzReady": {
                  "description": "false for a short while after delivery, while the iPhone file is prepared.",
                  "type": "boolean"
                },
                "thumbnailUrl": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "viewerUrl": {
                  "description": "A hosted page with the interactive 3D view.",
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "arUrl": {
                  "description": "One link that opens AR on any phone, and the 3D view on a computer.",
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "embed": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "dataClient": {
                          "description": "The data-client value for the embed script.",
                          "type": "string"
                        },
                        "dataArticleId": {
                          "type": "string"
                        },
                        "snippet": {
                          "description": "The full snippet for this article, ready to paste.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "dataClient",
                        "dataArticleId",
                        "snippet"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "images": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "description": "Stable id of the image. A replaced image gets a new id; the old one is listed under removed in asset.images.updated.",
                        "type": "string"
                      },
                      "type": {
                        "description": "packshot: the product on a plain background. thumbnail: the still of the model. scene: the product in a setting. render: other angles and details. overlay: a scene with the product placed in it. variation: the thumbnail of a variant. video: a short clip (posterUrl is its still). edit: an image changed by an edit job; the image it was made from stays as it was.",
                        "type": "string",
                        "enum": [
                          "packshot",
                          "thumbnail",
                          "scene",
                          "render",
                          "overlay",
                          "variation",
                          "video",
                          "edit"
                        ]
                      },
                      "variant": {
                        "description": "The variant the image shows, or null for the main product.",
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "url": {
                        "format": "uri",
                        "type": "string"
                      },
                      "fileName": {
                        "description": "The file name from your naming choice (GET /naming). A job's picture keeps the name it was made under; the rest follow the choice as it is now.",
                        "type": "string"
                      },
                      "posterUrl": {
                        "description": "Videos only: a still frame.",
                        "anyOf": [
                          {
                            "format": "uri",
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "width": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "height": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "bytes": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "createdAt": {
                        "anyOf": [
                          {
                            "format": "date-time",
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "approved": {
                        "description": "true once the image is approved for use. Only use approved images in your shop.",
                        "type": "boolean"
                      },
                      "primary": {
                        "description": "true for the one image we suggest as the main product image.",
                        "type": "boolean"
                      },
                      "jobId": {
                        "description": "The job that made the image, or null.",
                        "anyOf": [
                          {
                            "format": "uuid",
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "variant",
                      "url",
                      "fileName",
                      "width",
                      "height",
                      "bytes",
                      "createdAt",
                      "approved",
                      "primary",
                      "jobId"
                    ]
                  }
                },
                "variations": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "articleId": {
                        "type": "string"
                      },
                      "status": {
                        "description": "Where the product is. Build your logic on this value.",
                        "type": "string",
                        "enum": [
                          "received",
                          "in_production",
                          "in_review",
                          "approved",
                          "delivered",
                          "cancelled"
                        ]
                      },
                      "thumbnailUrl": {
                        "anyOf": [
                          {
                            "format": "uri",
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "glbUrl": {
                        "anyOf": [
                          {
                            "format": "uri",
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      }
                    },
                    "required": [
                      "articleId",
                      "status",
                      "thumbnailUrl",
                      "glbUrl"
                    ]
                  }
                }
              },
              "required": [
                "articleId",
                "name",
                "status",
                "deliveryDate",
                "updatedAt",
                "glbUrl",
                "usdzUrl",
                "usdzReady",
                "thumbnailUrl",
                "viewerUrl",
                "arUrl",
                "embed",
                "images",
                "variations"
              ]
            }
          },
          "unknown": {
            "description": "Article numbers you asked for that we do not have.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "nextCursor": {
            "description": "Pass it as cursor for the next page. null when there is no more.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "client",
          "assets",
          "unknown",
          "nextCursor"
        ]
      },
      "Job": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "packshot",
              "scene",
              "edit",
              "video",
              "export"
            ]
          },
          "articleId": {
            "type": "string"
          },
          "variant": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "succeeded",
              "failed",
              "cancelled"
            ]
          },
          "options": {
            "description": "The options as applied, defaults filled in.",
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "naming": {
            "anyOf": [
              {
                "description": "How files are named.",
                "type": "object",
                "properties": {
                  "preset": {
                    "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                    "type": "string",
                    "enum": [
                      "standard",
                      "gs1",
                      "amazon",
                      "custom"
                    ]
                  },
                  "pattern": {
                    "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                    "type": "string",
                    "maxLength": 200
                  }
                },
                "required": [
                  "preset"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "startedAt": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "finishedAt": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "outputs": {
            "description": "The files made, in the order asked for. Empty until the job finishes; a failed job lists the files it did make.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "For images, the same id as in images[].",
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "packshot",
                    "scene",
                    "edit",
                    "video",
                    "export"
                  ]
                },
                "view": {
                  "description": "The packshot view, when there is one.",
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "format": {
                  "description": "For exports, the file format.",
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "fileName": {
                  "type": "string"
                },
                "url": {
                  "format": "uri",
                  "type": "string"
                },
                "width": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "height": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "bytes": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "type",
                "view",
                "format",
                "fileName",
                "url",
                "width",
                "height",
                "bytes"
              ]
            }
          },
          "error": {
            "description": "Why the job failed, when it did.",
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "validation_failed",
                      "unauthorized",
                      "forbidden",
                      "allowance_reached",
                      "not_found",
                      "in_progress",
                      "not_ready",
                      "not_cancellable",
                      "idempotency_conflict",
                      "limit_reached",
                      "plan_managed_by_sales",
                      "too_large",
                      "rate_limited",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "description": "A sentence for people. Build your logic on code, not on the message.",
                    "type": "string"
                  },
                  "details": {
                    "type": "object",
                    "propertyNames": {
                      "type": "string"
                    },
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "type",
          "articleId",
          "variant",
          "status",
          "options",
          "naming",
          "metadata",
          "createdAt",
          "startedAt",
          "finishedAt",
          "outputs",
          "error"
        ]
      },
      "JobBatchResult": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "allOf": [
                {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "format": "uuid",
                          "type": "string"
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "packshot",
                            "scene",
                            "edit",
                            "video",
                            "export"
                          ]
                        },
                        "articleId": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string",
                          "enum": [
                            "queued",
                            "running",
                            "succeeded",
                            "failed",
                            "cancelled"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "type",
                        "articleId",
                        "status"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "articleId": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "type": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "error": {
                          "type": "object",
                          "properties": {
                            "code": {
                              "type": "string",
                              "enum": [
                                "validation_failed",
                                "unauthorized",
                                "forbidden",
                                "allowance_reached",
                                "not_found",
                                "in_progress",
                                "not_ready",
                                "not_cancellable",
                                "idempotency_conflict",
                                "limit_reached",
                                "plan_managed_by_sales",
                                "too_large",
                                "rate_limited",
                                "internal_error"
                              ]
                            },
                            "message": {
                              "description": "A sentence for people. Build your logic on code, not on the message.",
                              "type": "string"
                            },
                            "details": {
                              "type": "object",
                              "propertyNames": {
                                "type": "string"
                              },
                              "additionalProperties": {}
                            }
                          },
                          "required": [
                            "code",
                            "message"
                          ]
                        }
                      },
                      "required": [
                        "articleId",
                        "type",
                        "error"
                      ]
                    }
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "httpStatus": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "httpStatus"
                  ]
                }
              ]
            }
          }
        },
        "required": [
          "results"
        ]
      },
      "JobList": {
        "type": "object",
        "properties": {
          "jobs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "format": "uuid",
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "packshot",
                    "scene",
                    "edit",
                    "video",
                    "export"
                  ]
                },
                "articleId": {
                  "type": "string"
                },
                "variant": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "queued",
                    "running",
                    "succeeded",
                    "failed",
                    "cancelled"
                  ]
                },
                "options": {
                  "description": "The options as applied, defaults filled in.",
                  "type": "object",
                  "propertyNames": {
                    "type": "string"
                  },
                  "additionalProperties": {}
                },
                "naming": {
                  "anyOf": [
                    {
                      "description": "How files are named.",
                      "type": "object",
                      "properties": {
                        "preset": {
                          "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                          "type": "string",
                          "enum": [
                            "standard",
                            "gs1",
                            "amazon",
                            "custom"
                          ]
                        },
                        "pattern": {
                          "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                          "type": "string",
                          "maxLength": 200
                        }
                      },
                      "required": [
                        "preset"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "metadata": {
                  "type": "object",
                  "propertyNames": {
                    "type": "string"
                  },
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "createdAt": {
                  "format": "date-time",
                  "type": "string"
                },
                "startedAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "finishedAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "outputs": {
                  "description": "The files made, in the order asked for. Empty until the job finishes; a failed job lists the files it did make.",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "description": "For images, the same id as in images[].",
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "packshot",
                          "scene",
                          "edit",
                          "video",
                          "export"
                        ]
                      },
                      "view": {
                        "description": "The packshot view, when there is one.",
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "format": {
                        "description": "For exports, the file format.",
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "fileName": {
                        "type": "string"
                      },
                      "url": {
                        "format": "uri",
                        "type": "string"
                      },
                      "width": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "height": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "bytes": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "view",
                      "format",
                      "fileName",
                      "url",
                      "width",
                      "height",
                      "bytes"
                    ]
                  }
                },
                "error": {
                  "description": "Why the job failed, when it did.",
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "validation_failed",
                            "unauthorized",
                            "forbidden",
                            "allowance_reached",
                            "not_found",
                            "in_progress",
                            "not_ready",
                            "not_cancellable",
                            "idempotency_conflict",
                            "limit_reached",
                            "plan_managed_by_sales",
                            "too_large",
                            "rate_limited",
                            "internal_error"
                          ]
                        },
                        "message": {
                          "description": "A sentence for people. Build your logic on code, not on the message.",
                          "type": "string"
                        },
                        "details": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {}
                        }
                      },
                      "required": [
                        "code",
                        "message"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "type",
                "articleId",
                "variant",
                "status",
                "options",
                "naming",
                "metadata",
                "createdAt",
                "startedAt",
                "finishedAt",
                "outputs",
                "error"
              ]
            }
          },
          "nextCursor": {
            "description": "Pass it as cursor for the next page. null when there is no more.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "jobs",
          "nextCursor"
        ]
      },
      "PresetList": {
        "type": "object",
        "properties": {
          "presets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "packshot",
                    "scene"
                  ]
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "defaults": {
                  "description": "The options the preset sets; your options win where they overlap.",
                  "type": "object",
                  "propertyNames": {
                    "type": "string"
                  },
                  "additionalProperties": {}
                },
                "exampleUrl": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "type",
                "description",
                "defaults",
                "exampleUrl"
              ]
            }
          }
        },
        "required": [
          "presets"
        ]
      },
      "StyleList": {
        "type": "object",
        "properties": {
          "styles": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "exampleUrl": {
                  "anyOf": [
                    {
                      "format": "uri",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "exampleUrl"
              ]
            }
          }
        },
        "required": [
          "styles"
        ]
      },
      "NamingView": {
        "type": "object",
        "properties": {
          "preset": {
            "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
            "type": "string",
            "enum": [
              "standard",
              "gs1",
              "amazon",
              "custom"
            ]
          },
          "pattern": {
            "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
            "type": "string",
            "maxLength": 200
          },
          "example": {
            "description": "What a front packshot of CH-1001 would be called.",
            "type": "string"
          }
        },
        "required": [
          "preset",
          "example"
        ]
      },
      "Webhook": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "url": {
            "format": "uri",
            "type": "string"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "product.received",
                "status.changed",
                "review.requested",
                "change.accepted",
                "change.rejected",
                "asset.approved",
                "asset.images.updated",
                "job.succeeded",
                "job.failed",
                "job.cancelled",
                "import.completed",
                "storage.transfer.succeeded",
                "storage.transfer.failed",
                "configurator.published",
                "account.activated"
              ]
            }
          },
          "active": {
            "type": "boolean"
          },
          "secretPrefix": {
            "description": "The first 12 characters of the signing secret, so you can tell secrets apart.",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "id",
          "url",
          "events",
          "active",
          "secretPrefix",
          "createdAt"
        ]
      },
      "WebhookCreated": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "url": {
            "format": "uri",
            "type": "string"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "product.received",
                "status.changed",
                "review.requested",
                "change.accepted",
                "change.rejected",
                "asset.approved",
                "asset.images.updated",
                "job.succeeded",
                "job.failed",
                "job.cancelled",
                "import.completed",
                "storage.transfer.succeeded",
                "storage.transfer.failed",
                "configurator.published",
                "account.activated"
              ]
            }
          },
          "active": {
            "type": "boolean"
          },
          "secretPrefix": {
            "description": "The first 12 characters of the signing secret, so you can tell secrets apart.",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "secret": {
            "description": "whsec_ followed by 43 characters. Shown once: store it now.",
            "type": "string"
          }
        },
        "required": [
          "id",
          "url",
          "events",
          "active",
          "secretPrefix",
          "createdAt",
          "secret"
        ]
      },
      "WebhookList": {
        "type": "object",
        "properties": {
          "webhooks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "format": "uuid",
                  "type": "string"
                },
                "url": {
                  "format": "uri",
                  "type": "string"
                },
                "events": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "product.received",
                      "status.changed",
                      "review.requested",
                      "change.accepted",
                      "change.rejected",
                      "asset.approved",
                      "asset.images.updated",
                      "job.succeeded",
                      "job.failed",
                      "job.cancelled",
                      "import.completed",
                      "storage.transfer.succeeded",
                      "storage.transfer.failed",
                      "configurator.published",
                      "account.activated"
                    ]
                  }
                },
                "active": {
                  "type": "boolean"
                },
                "secretPrefix": {
                  "description": "The first 12 characters of the signing secret, so you can tell secrets apart.",
                  "type": "string"
                },
                "createdAt": {
                  "format": "date-time",
                  "type": "string"
                }
              },
              "required": [
                "id",
                "url",
                "events",
                "active",
                "secretPrefix",
                "createdAt"
              ]
            }
          }
        },
        "required": [
          "webhooks"
        ]
      },
      "WebhookDeleted": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "active": {
            "type": "boolean",
            "const": false
          }
        },
        "required": [
          "id",
          "active"
        ]
      },
      "WebhookTestQueued": {
        "type": "object",
        "properties": {
          "queued": {
            "type": "boolean",
            "const": true
          },
          "deliveryId": {
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "queued",
          "deliveryId"
        ]
      },
      "DeliveryList": {
        "type": "object",
        "properties": {
          "deliveries": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "format": "uuid",
                  "description": "The delivery id, as in the CharpstAR-Delivery header.",
                  "type": "string"
                },
                "event": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "product.received",
                        "status.changed",
                        "review.requested",
                        "change.accepted",
                        "change.rejected",
                        "asset.approved",
                        "asset.images.updated",
                        "job.succeeded",
                        "job.failed",
                        "job.cancelled",
                        "import.completed",
                        "storage.transfer.succeeded",
                        "storage.transfer.failed",
                        "configurator.published",
                        "account.activated"
                      ]
                    },
                    {
                      "type": "string",
                      "const": "ping"
                    }
                  ]
                },
                "article": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "status": {
                  "description": "pending: not sent yet or waiting for a retry. dead: every attempt failed.",
                  "type": "string",
                  "enum": [
                    "pending",
                    "delivered",
                    "failed",
                    "dead"
                  ]
                },
                "attempts": {
                  "type": "integer"
                },
                "lastStatus": {
                  "description": "The HTTP status your receiver answered last.",
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "lastError": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "occurredAt": {
                  "format": "date-time",
                  "type": "string"
                },
                "deliveredAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "nextAttemptAt": {
                  "anyOf": [
                    {
                      "format": "date-time",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "event",
                "article",
                "status",
                "attempts",
                "lastStatus",
                "lastError",
                "occurredAt",
                "deliveredAt",
                "nextAttemptAt"
              ]
            }
          },
          "nextCursor": {
            "description": "Pass it as cursor for the next page. null when there is no more.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "deliveries",
          "nextCursor"
        ]
      },
      "RedeliverResult": {
        "type": "object",
        "properties": {
          "queued": {
            "type": "boolean",
            "const": true
          },
          "deliveryId": {
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "queued",
          "deliveryId"
        ]
      },
      "RotateSecretResult": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "secret": {
            "description": "The new secret, whsec_ followed by 43 characters. Shown once.",
            "type": "string"
          },
          "secretPrefix": {
            "type": "string"
          },
          "previousSecretValidUntil": {
            "format": "date-time",
            "description": "The old secret keeps signing for 24 hours; the header carries both signatures in that time.",
            "type": "string"
          }
        },
        "required": [
          "id",
          "secret",
          "secretPrefix",
          "previousSecretValidUntil"
        ]
      },
      "Account": {
        "type": "object",
        "properties": {
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "plan": {
            "description": "contract: managed by your CharpstAR contact. package: chosen through the API. none: nothing active yet; the account can read and explore but not order.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "contract",
                  "package",
                  "none"
                ]
              },
              "name": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "activatedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "kind",
              "name",
              "activatedAt"
            ]
          },
          "areas": {
            "description": "The product areas switched on for the account.",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "models",
                "configurators",
                "renders",
                "ai_studio"
              ]
            }
          },
          "period": {
            "description": "The calendar year (UTC), unless the plan says otherwise.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "month",
                  "year"
                ]
              },
              "startsAt": {
                "format": "date-time",
                "type": "string"
              },
              "endsAt": {
                "format": "date-time",
                "type": "string"
              }
            },
            "required": [
              "kind",
              "startsAt",
              "endsAt"
            ]
          },
          "currency": {
            "description": "ISO 4217. The currency prices and invoices are in: from the company's country, unless agreed otherwise.",
            "type": "string",
            "minLength": 3,
            "maxLength": 3
          },
          "usage": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "model_ordered",
                    "model_delivered",
                    "model_replaced",
                    "packshot",
                    "scene",
                    "edit",
                    "video",
                    "export"
                  ]
                },
                "used": {
                  "description": "In the line's period. Cancelled orders are not counted.",
                  "type": "integer"
                },
                "allowance": {
                  "description": "null means no limit.",
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "remaining": {
                  "description": "allowance minus used, never below 0; null without an allowance.",
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "period": {
                  "description": "The account's period, or the allowance's own when the kind has one. used starts again at endsAt.",
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "month",
                        "year"
                      ]
                    },
                    "startsAt": {
                      "format": "date-time",
                      "type": "string"
                    },
                    "endsAt": {
                      "format": "date-time",
                      "type": "string"
                    }
                  },
                  "required": [
                    "kind",
                    "startsAt",
                    "endsAt"
                  ]
                },
                "unitPrice": {
                  "description": "null while the kind is included in the plan.",
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "amount": {
                          "description": "In the currency's minor unit: 3600 with EUR is 36.00 EUR.",
                          "type": "integer"
                        },
                        "currency": {
                          "description": "ISO 4217, for example SEK or EUR.",
                          "type": "string",
                          "minLength": 3,
                          "maxLength": 3
                        }
                      },
                      "required": [
                        "amount",
                        "currency"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "kind",
                "used",
                "allowance",
                "remaining",
                "period",
                "unitPrice"
              ]
            }
          },
          "limits": {
            "description": "This token's own limits.",
            "type": "object",
            "properties": {
              "requestsPerMinute": {
                "type": "integer"
              },
              "requestsPerDay": {
                "type": "integer"
              },
              "writesPerDay": {
                "anyOf": [
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "requestsPerMinute",
              "requestsPerDay",
              "writesPerDay"
            ]
          }
        },
        "required": [
          "client",
          "plan",
          "areas",
          "period",
          "currency",
          "usage",
          "limits"
        ]
      },
      "Usage": {
        "type": "object",
        "properties": {
          "from": {
            "format": "date",
            "description": "The first day counted (UTC).",
            "type": "string"
          },
          "to": {
            "format": "date",
            "description": "The last day counted (UTC), included.",
            "type": "string"
          },
          "totals": {
            "description": "Every kind, 0 included.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "model_ordered",
                    "model_delivered",
                    "model_replaced",
                    "packshot",
                    "scene",
                    "edit",
                    "video",
                    "export"
                  ]
                },
                "count": {
                  "type": "integer"
                }
              },
              "required": [
                "kind",
                "count"
              ]
            }
          },
          "byDay": {
            "description": "Days with usage only, oldest first.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date",
                  "type": "string"
                },
                "kind": {
                  "type": "string",
                  "enum": [
                    "model_ordered",
                    "model_delivered",
                    "model_replaced",
                    "packshot",
                    "scene",
                    "edit",
                    "video",
                    "export"
                  ]
                },
                "count": {
                  "type": "integer"
                }
              },
              "required": [
                "date",
                "kind",
                "count"
              ]
            }
          }
        },
        "required": [
          "from",
          "to",
          "totals",
          "byDay"
        ]
      },
      "ProductReceivedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "product.received"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "articleId": {
                "type": "string"
              },
              "name": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "category": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "subcategory": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "dimensionsCm": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "w": {
                        "type": "number"
                      },
                      "h": {
                        "type": "number"
                      },
                      "d": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "w",
                      "h",
                      "d"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "productLink": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "description": "Where the product is. Build your logic on this value.",
                "type": "string",
                "enum": [
                  "received",
                  "in_production",
                  "in_review",
                  "approved",
                  "delivered",
                  "cancelled"
                ]
              },
              "receivedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "articleId",
              "name",
              "category",
              "subcategory",
              "dimensionsCm",
              "productLink",
              "status",
              "receivedAt"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "StatusChangedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "status.changed"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "from": {
                "description": "Where the product is. Build your logic on this value.",
                "type": "string",
                "enum": [
                  "received",
                  "in_production",
                  "in_review",
                  "approved",
                  "delivered",
                  "cancelled"
                ]
              },
              "to": {
                "description": "Where the product is. Build your logic on this value.",
                "type": "string",
                "enum": [
                  "received",
                  "in_production",
                  "in_review",
                  "approved",
                  "delivered",
                  "cancelled"
                ]
              }
            },
            "required": [
              "from",
              "to"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "ReviewRequestedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "review.requested"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "articleId": {
                "type": "string"
              },
              "reviewUrl": {
                "format": "uri",
                "description": "Opens the model in your CharpstAR account for review.",
                "type": "string"
              }
            },
            "required": [
              "articleId",
              "reviewUrl"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "AssetApprovedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "asset.approved"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "articleId": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "status": {
                    "description": "Where the product is. Build your logic on this value.",
                    "type": "string",
                    "enum": [
                      "received",
                      "in_production",
                      "in_review",
                      "approved",
                      "delivered",
                      "cancelled"
                    ]
                  },
                  "statusDetail": {
                    "description": "With status received: we need something from you, usually references or dimensions.",
                    "type": "string",
                    "const": "waiting_for_information"
                  },
                  "deliveryDate": {
                    "description": "The planned delivery date, when there is one.",
                    "anyOf": [
                      {
                        "format": "date",
                        "description": "A date, YYYY-MM-DD.",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "updatedAt": {
                    "anyOf": [
                      {
                        "format": "date-time",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "glbUrl": {
                    "description": "The 3D model for web viewers and Android AR. Never changes for an article; the file behind it does.",
                    "anyOf": [
                      {
                        "format": "uri",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "usdzUrl": {
                    "description": "The model for AR on iPhone and iPad.",
                    "anyOf": [
                      {
                        "format": "uri",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "usdzReady": {
                    "description": "false for a short while after delivery, while the iPhone file is prepared.",
                    "type": "boolean"
                  },
                  "thumbnailUrl": {
                    "anyOf": [
                      {
                        "format": "uri",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "viewerUrl": {
                    "description": "A hosted page with the interactive 3D view.",
                    "anyOf": [
                      {
                        "format": "uri",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "arUrl": {
                    "description": "One link that opens AR on any phone, and the 3D view on a computer.",
                    "anyOf": [
                      {
                        "format": "uri",
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "embed": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "dataClient": {
                            "description": "The data-client value for the embed script.",
                            "type": "string"
                          },
                          "dataArticleId": {
                            "type": "string"
                          },
                          "snippet": {
                            "description": "The full snippet for this article, ready to paste.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "dataClient",
                          "dataArticleId",
                          "snippet"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "images": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "description": "Stable id of the image. A replaced image gets a new id; the old one is listed under removed in asset.images.updated.",
                          "type": "string"
                        },
                        "type": {
                          "description": "packshot: the product on a plain background. thumbnail: the still of the model. scene: the product in a setting. render: other angles and details. overlay: a scene with the product placed in it. variation: the thumbnail of a variant. video: a short clip (posterUrl is its still). edit: an image changed by an edit job; the image it was made from stays as it was.",
                          "type": "string",
                          "enum": [
                            "packshot",
                            "thumbnail",
                            "scene",
                            "render",
                            "overlay",
                            "variation",
                            "video",
                            "edit"
                          ]
                        },
                        "variant": {
                          "description": "The variant the image shows, or null for the main product.",
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "url": {
                          "format": "uri",
                          "type": "string"
                        },
                        "fileName": {
                          "description": "The file name from your naming choice (GET /naming). A job's picture keeps the name it was made under; the rest follow the choice as it is now.",
                          "type": "string"
                        },
                        "posterUrl": {
                          "description": "Videos only: a still frame.",
                          "anyOf": [
                            {
                              "format": "uri",
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "width": {
                          "anyOf": [
                            {
                              "type": "integer"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "height": {
                          "anyOf": [
                            {
                              "type": "integer"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "bytes": {
                          "anyOf": [
                            {
                              "type": "integer"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "createdAt": {
                          "anyOf": [
                            {
                              "format": "date-time",
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "approved": {
                          "description": "true once the image is approved for use. Only use approved images in your shop.",
                          "type": "boolean"
                        },
                        "primary": {
                          "description": "true for the one image we suggest as the main product image.",
                          "type": "boolean"
                        },
                        "jobId": {
                          "description": "The job that made the image, or null.",
                          "anyOf": [
                            {
                              "format": "uuid",
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "type",
                        "variant",
                        "url",
                        "fileName",
                        "width",
                        "height",
                        "bytes",
                        "createdAt",
                        "approved",
                        "primary",
                        "jobId"
                      ]
                    }
                  },
                  "variations": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "articleId": {
                          "type": "string"
                        },
                        "status": {
                          "description": "Where the product is. Build your logic on this value.",
                          "type": "string",
                          "enum": [
                            "received",
                            "in_production",
                            "in_review",
                            "approved",
                            "delivered",
                            "cancelled"
                          ]
                        },
                        "thumbnailUrl": {
                          "anyOf": [
                            {
                              "format": "uri",
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "glbUrl": {
                          "anyOf": [
                            {
                              "format": "uri",
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "articleId",
                        "status",
                        "thumbnailUrl",
                        "glbUrl"
                      ]
                    }
                  }
                },
                "required": [
                  "articleId",
                  "name",
                  "status",
                  "deliveryDate",
                  "updatedAt",
                  "glbUrl",
                  "usdzUrl",
                  "usdzReady",
                  "thumbnailUrl",
                  "viewerUrl",
                  "arUrl",
                  "embed",
                  "images",
                  "variations"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "articleId": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "const": "approved"
                  }
                },
                "required": [
                  "articleId",
                  "status"
                ]
              }
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "AssetImagesUpdatedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "asset.images.updated"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "added": {
                "description": "Ids of images that are new or replaced.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "removed": {
                "description": "Ids of images that are gone.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "added",
              "removed"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "JobSucceededEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "job.succeeded"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "packshot",
                  "scene",
                  "edit",
                  "video",
                  "export"
                ]
              },
              "articleId": {
                "type": "string"
              },
              "variant": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "queued",
                  "running",
                  "succeeded",
                  "failed",
                  "cancelled"
                ]
              },
              "options": {
                "description": "The options as applied, defaults filled in.",
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              "naming": {
                "anyOf": [
                  {
                    "description": "How files are named.",
                    "type": "object",
                    "properties": {
                      "preset": {
                        "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                        "type": "string",
                        "enum": [
                          "standard",
                          "gs1",
                          "amazon",
                          "custom"
                        ]
                      },
                      "pattern": {
                        "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                        "type": "string",
                        "maxLength": 200
                      }
                    },
                    "required": [
                      "preset"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "metadata": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "createdAt": {
                "format": "date-time",
                "type": "string"
              },
              "startedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "finishedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "outputs": {
                "description": "The files made, in the order asked for. Empty until the job finishes; a failed job lists the files it did make.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "description": "For images, the same id as in images[].",
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "packshot",
                        "scene",
                        "edit",
                        "video",
                        "export"
                      ]
                    },
                    "view": {
                      "description": "The packshot view, when there is one.",
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "format": {
                      "description": "For exports, the file format.",
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "fileName": {
                      "type": "string"
                    },
                    "url": {
                      "format": "uri",
                      "type": "string"
                    },
                    "width": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "height": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "bytes": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "type",
                    "view",
                    "format",
                    "fileName",
                    "url",
                    "width",
                    "height",
                    "bytes"
                  ]
                }
              },
              "error": {
                "description": "Why the job failed, when it did.",
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "enum": [
                          "validation_failed",
                          "unauthorized",
                          "forbidden",
                          "allowance_reached",
                          "not_found",
                          "in_progress",
                          "not_ready",
                          "not_cancellable",
                          "idempotency_conflict",
                          "limit_reached",
                          "plan_managed_by_sales",
                          "too_large",
                          "rate_limited",
                          "internal_error"
                        ]
                      },
                      "message": {
                        "description": "A sentence for people. Build your logic on code, not on the message.",
                        "type": "string"
                      },
                      "details": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      }
                    },
                    "required": [
                      "code",
                      "message"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "type",
              "articleId",
              "variant",
              "status",
              "options",
              "naming",
              "metadata",
              "createdAt",
              "startedAt",
              "finishedAt",
              "outputs",
              "error"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "JobFailedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "job.failed"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "packshot",
                  "scene",
                  "edit",
                  "video",
                  "export"
                ]
              },
              "articleId": {
                "type": "string"
              },
              "variant": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "queued",
                  "running",
                  "succeeded",
                  "failed",
                  "cancelled"
                ]
              },
              "options": {
                "description": "The options as applied, defaults filled in.",
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              "naming": {
                "anyOf": [
                  {
                    "description": "How files are named.",
                    "type": "object",
                    "properties": {
                      "preset": {
                        "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                        "type": "string",
                        "enum": [
                          "standard",
                          "gs1",
                          "amazon",
                          "custom"
                        ]
                      },
                      "pattern": {
                        "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                        "type": "string",
                        "maxLength": 200
                      }
                    },
                    "required": [
                      "preset"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "metadata": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "createdAt": {
                "format": "date-time",
                "type": "string"
              },
              "startedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "finishedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "outputs": {
                "description": "The files made, in the order asked for. Empty until the job finishes; a failed job lists the files it did make.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "description": "For images, the same id as in images[].",
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "packshot",
                        "scene",
                        "edit",
                        "video",
                        "export"
                      ]
                    },
                    "view": {
                      "description": "The packshot view, when there is one.",
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "format": {
                      "description": "For exports, the file format.",
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "fileName": {
                      "type": "string"
                    },
                    "url": {
                      "format": "uri",
                      "type": "string"
                    },
                    "width": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "height": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "bytes": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "type",
                    "view",
                    "format",
                    "fileName",
                    "url",
                    "width",
                    "height",
                    "bytes"
                  ]
                }
              },
              "error": {
                "description": "Why the job failed, when it did.",
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "enum": [
                          "validation_failed",
                          "unauthorized",
                          "forbidden",
                          "allowance_reached",
                          "not_found",
                          "in_progress",
                          "not_ready",
                          "not_cancellable",
                          "idempotency_conflict",
                          "limit_reached",
                          "plan_managed_by_sales",
                          "too_large",
                          "rate_limited",
                          "internal_error"
                        ]
                      },
                      "message": {
                        "description": "A sentence for people. Build your logic on code, not on the message.",
                        "type": "string"
                      },
                      "details": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      }
                    },
                    "required": [
                      "code",
                      "message"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "type",
              "articleId",
              "variant",
              "status",
              "options",
              "naming",
              "metadata",
              "createdAt",
              "startedAt",
              "finishedAt",
              "outputs",
              "error"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "JobCancelledEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "job.cancelled"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "packshot",
                  "scene",
                  "edit",
                  "video",
                  "export"
                ]
              },
              "articleId": {
                "type": "string"
              },
              "variant": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "queued",
                  "running",
                  "succeeded",
                  "failed",
                  "cancelled"
                ]
              },
              "options": {
                "description": "The options as applied, defaults filled in.",
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              "naming": {
                "anyOf": [
                  {
                    "description": "How files are named.",
                    "type": "object",
                    "properties": {
                      "preset": {
                        "description": "standard: {articleId}_{type}_{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.",
                        "type": "string",
                        "enum": [
                          "standard",
                          "gs1",
                          "amazon",
                          "custom"
                        ]
                      },
                      "pattern": {
                        "description": "With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.",
                        "type": "string",
                        "maxLength": 200
                      }
                    },
                    "required": [
                      "preset"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "metadata": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "createdAt": {
                "format": "date-time",
                "type": "string"
              },
              "startedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "finishedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "outputs": {
                "description": "The files made, in the order asked for. Empty until the job finishes; a failed job lists the files it did make.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "description": "For images, the same id as in images[].",
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "packshot",
                        "scene",
                        "edit",
                        "video",
                        "export"
                      ]
                    },
                    "view": {
                      "description": "The packshot view, when there is one.",
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "format": {
                      "description": "For exports, the file format.",
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "fileName": {
                      "type": "string"
                    },
                    "url": {
                      "format": "uri",
                      "type": "string"
                    },
                    "width": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "height": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "bytes": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "type",
                    "view",
                    "format",
                    "fileName",
                    "url",
                    "width",
                    "height",
                    "bytes"
                  ]
                }
              },
              "error": {
                "description": "Why the job failed, when it did.",
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "enum": [
                          "validation_failed",
                          "unauthorized",
                          "forbidden",
                          "allowance_reached",
                          "not_found",
                          "in_progress",
                          "not_ready",
                          "not_cancellable",
                          "idempotency_conflict",
                          "limit_reached",
                          "plan_managed_by_sales",
                          "too_large",
                          "rate_limited",
                          "internal_error"
                        ]
                      },
                      "message": {
                        "description": "A sentence for people. Build your logic on code, not on the message.",
                        "type": "string"
                      },
                      "details": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      }
                    },
                    "required": [
                      "code",
                      "message"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "type",
              "articleId",
              "variant",
              "status",
              "options",
              "naming",
              "metadata",
              "createdAt",
              "startedAt",
              "finishedAt",
              "outputs",
              "error"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "ImportCompletedEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "import.completed"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "queued",
                  "running",
                  "completed",
                  "failed"
                ]
              },
              "dryRun": {
                "type": "boolean"
              },
              "orderId": {
                "description": "The order the imported products landed in (null for a dry run).",
                "anyOf": [
                  {
                    "format": "uuid",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "rows": {
                "description": "Rows in the file, once read.",
                "anyOf": [
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "processed": {
                "type": "integer"
              },
              "counts": {
                "description": "How many rows ended in each result so far.",
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "enum": [
                    "created",
                    "updated",
                    "unchanged",
                    "change_request",
                    "exists_delivered",
                    "refused"
                  ]
                },
                "additionalProperties": {
                  "type": "integer"
                }
              },
              "error": {
                "description": "Why the import failed, when it did.",
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "createdAt": {
                "format": "date-time",
                "type": "string"
              },
              "finishedAt": {
                "anyOf": [
                  {
                    "format": "date-time",
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "status",
              "dryRun",
              "orderId",
              "rows",
              "processed",
              "counts",
              "error",
              "createdAt",
              "finishedAt"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      },
      "PingEvent": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "const": "ping"
          },
          "occurredAt": {
            "format": "date-time",
            "description": "When it happened on our side.",
            "type": "string"
          },
          "client": {
            "description": "The company the key belongs to.",
            "type": "object",
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "article": {
            "description": "The article number the event is about, or null when the event is not about one product.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              }
            },
            "required": [
              "message"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "occurredAt",
          "client",
          "article",
          "data"
        ]
      }
    }
  },
  "x-scopes": [
    {
      "scope": "products:read",
      "description": "Listing and reading products, orders, imports and the coverage report."
    },
    {
      "scope": "products:write",
      "description": "Creating, updating and cancelling products, running imports and reporting sync runs."
    },
    {
      "scope": "reviews:write",
      "description": "Approving models and requesting changes."
    },
    {
      "scope": "assets:read",
      "description": "Reading assets and images."
    },
    {
      "scope": "webhooks:manage",
      "description": "Managing webhook subscriptions and deliveries."
    },
    {
      "scope": "account:read",
      "description": "Reading the account: the plan, usage per kind, allowances and the billing currency."
    },
    {
      "scope": "jobs:read",
      "description": "Reading jobs, render presets and styles."
    },
    {
      "scope": "jobs:write",
      "description": "Starting and cancelling jobs."
    },
    {
      "scope": "settings:write",
      "description": "Naming templates."
    }
  ],
  "x-deprecated": [],
  "x-limits": {
    "burstPerMinute": 120,
    "dailyQuota": 5000,
    "unauthPerMinute": 30,
    "maxBodyBytes": 4000000,
    "maxBatch": 50,
    "maxArticles": 100,
    "pageSize": 100,
    "maxReferenceImages": 10,
    "maxVariants": 50,
    "maxSubscriptions": 3,
    "sendTimeoutSeconds": 10,
    "retryScheduleMs": [
      60000,
      300000,
      1800000,
      7200000,
      21600000,
      43200000
    ],
    "signatureToleranceSeconds": 300,
    "approvedHoldMinutes": 30,
    "maxImportRows": 100000,
    "maxJobsPerBatch": 50,
    "maxAttributes": 50,
    "maxMetadata": 20,
    "maxSceneImages": 4,
    "maxWithArticles": 4,
    "idempotencyHours": 24,
    "deliveryLogDays": 30,
    "secretOverlapHours": 24,
    "fileNameMaxLength": 200
  }
}
