AI sign designs

Get an AI sign design source

Copy page

Returns a source's metadata and its current status. Requires ai_sign_designs:read.

GET/api/v3/ai-sign-design-sources/{source_id}

Get an AI sign design source

Returns a source's metadata and its current status. Requires `ai_sign_designs:read`. Only the API key, or the AI agent connection, that created the source can read it: another key's source, another store's source and an unknown id all answer the same 404. `status` separates arrival from verification. `pending` means no bytes have arrived. `uploaded` means bytes arrived and are not yet verified. `consumed` means a design verified and used them; `width_px` and `height_px` then give the verified image size. `rejected` means verification failed, and `verification_failure_code` says why. `expired` means the source can no longer be used. The upload target is never returned here.

Get an AI sign design source

Click Send to see the live response.

Overview

Only the API key, or the AI agent connection, that created the source can read it: another key's source, another store's source and an unknown id all answer the same 404. status separates arrival from verification. pending means no bytes have arrived. uploaded means bytes arrived and are not yet verified. consumed means a design verified and used them; width_px and height_px then give the verified image size. rejected means verification failed, and verification_failure_code says why. expired means the source can no longer be used. The upload target is never returned here.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: ai_sign_designs:read

Path parameters

source_idstringpathrequired

The opaque source ID.

Example: aisrc_9f2c4b7ad13e6058ba41cd4201

Get an AI sign design source

curl https://web.signcustomiser.com/api/v3/ai-sign-design-sources/aisrc_9f2c4b7ad13e6058ba41cd4201 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "ai_sign_design_source",
    "id": "aisrc_9f2c4b7ad13e6058ba41cd4201",
    "filename": "shopfront-logo.png",
    "content_type": "image/png",
    "byte_size": 482133,
    "status": "consumed",
    "verification_failure_code": null,
    "width_px": 1600,
    "height_px": 900,
    "expires_at": "2026-10-21T09:30:00Z",
    "consumed_at": "2026-10-20T09:32:00Z",
    "created_at": "2026-10-20T09:30:00Z",
    "upload_target": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/ai-sign-design-sources/aisrc_9f2c4b7ad13e6058ba41cd4201",
    "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:read scope.",
  "required_scopes": [
    "ai_sign_designs:read"
  ],
  "granted_scopes": [
    "customisers:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "The requested resource does not exist or does not belong to the authenticated store.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
  "title": "Unknown query parameter",
  "status": 422,
  "code": "unknown_parameter",
  "detail": "This endpoint accepts no query parameters.",
  "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"
}