AI sign designs

Validate an AI sign design source create

Copy page

Dry-runs POST/api/v3/ai-sign-design-sources with the same body. It returns the problem the create would return, or a verdict that the create would succeed.

POST/api/v3/ai-sign-design-sources/validate-create

Validate an AI sign design source create

Dry-runs `POST /api/v3/ai-sign-design-sources` with the same body. It returns the problem the create would return, or a verdict that the create would succeed. Requires `ai_sign_designs:write`. Nothing is created, no target is minted, no idempotency key is used, no budget is spent and no credit is reserved.

Validate an AI sign design source create

Overview

Requires ai_sign_designs:write. Nothing is created, no target is minted, no idempotency key is used, no budget is spent and no credit is reserved.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: ai_sign_designs:write

Request body

filenamestringbody

content_typestringbody

byte_sizeintegerbody

Request body example

{
  "filename": "shopfront-logo.png",
  "content_type": "image/png",
  "byte_size": 482133
}

Validate an AI sign design source create

curl https://web.signcustomiser.com/api/v3/ai-sign-design-sources/validate-create \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "filename": "shopfront-logo.png",
  "content_type": "image/png",
  "byte_size": 482133
}'

{
  "data": {
    "object": "ai_sign_design_source_validation",
    "operation": "create",
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/ai-sign-design-sources/validate-create",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the ai_sign_designs:write scope.",
  "required_scopes": [
    "ai_sign_designs:write"
  ],
  "granted_scopes": [
    "ai_sign_designs:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "The requested endpoint does not exist. The API reference lists every available operation: https://www.signcustomiser.com/help/api/",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/source_size_exceeded",
  "title": "Source size exceeded",
  "status": 422,
  "code": "source_size_exceeded",
  "detail": "An AI sign design source must not exceed 5242880 bytes, and this one declares 9437184.",
  "errors": [
    {
      "pointer": "/byte_size",
      "code": "source_size_exceeded",
      "detail": "An AI sign design source must not exceed 5242880 bytes, and this one declares 9437184."
    }
  ],
  "max_byte_size": 5242880,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/ai_sign_designer_unavailable",
  "title": "AI sign designer unavailable",
  "status": 503,
  "code": "ai_sign_designer_unavailable",
  "detail": "The AI sign designer is turned off for this store. Sources and designs that already exist stay readable. Read GET /api/v3/ai-sign-design-capabilities and try again when available is true.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}