Syndai Docs

Design localized store screenshots

POST
/api/v1/external/coding/customers/{customer_id}/repositories/{repository_id}/store/listing/design

Starts a paid AI design campaign that turns the app's validated captures of the built commit into designed screenshots for every listing language, guided by direction (up to 500 characters); platform narrows it to one store. Its maximum cost is priced up front and billed to the workspace unless its own model key serves it (402 credit_quota_exhausted when the plan can't cover that maximum). Runs in the background and writes drafts only: nothing reaches a store until the owner ticks and pushes the locale. Resending the identical request returns the campaign already in flight; other listing work in flight is 409 listing_work_busy, and 409 screens_no_build / screens_need_flows mean no build or no captures yet.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

customer_id*string
Formatuuid
repository_id*string
Formatuuid

Request Body

application/json
  1. body
direction*string
Length1 <= length <= 500
max_usd*string
platform?|
Value in"ios""android"null

Response Body

Request fulfilled, document follows

application/json
  1. response
adopted*boolean
editable?
imported_at?string|null
languages?array<>
locales*array<>
review?
work?|null
Example Request
curl -X POST 'https://api.syndai.ai/api/v1/external/coding/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/repositories/497f6eca-6276-4993-bfeb-53cbbbba6f08/store/listing/design' \  -H 'Content-Type: application/json' \  -d '{  "direction": "string",  "max_usd": "string"}'
Example Response
{  "adopted": true,  "editable": {    "property1": true,    "property2": true  },  "imported_at": "string",  "languages": [    {      "apple": "string",      "in_app": true,      "key": "string",      "listed": true,      "name": "string",      "play": "string",      "translation_requested": false    }  ],  "locales": [    {      "captures": [        {          "ai_generated": true,          "artwork_model": "string",          "artwork_sha256": "string",          "caption": "string",          "caption_back_translation": "string",          "display_type": "string",          "height": 0,          "kind": "string",          "order": 0,          "output_review": {            "artifact_sha256": "string",            "issues": [              {                "category": "string",                "evidence": "string",                "suggestion": "string"              }            ],            "language": "string",            "model": "string",            "source_sha256": "string",            "status": "clear",            "version": 0          },          "pick": 0,          "pii": "string",          "problems": [            "string"          ],          "sha256": "string",          "source": "syndai",          "source_commit": "string",          "source_sha256": "string",          "source_tree": "string",          "url": "string",          "width": 0        }      ],      "fields": [        {          "back_translation": "string",          "draft": "string",          "field": "string",          "limit": 0,          "live": "string",          "over": 0,          "repo": "string",          "unit": "string"        }      ],      "locale": "string",      "platform": "string",      "shots": [        {          "ai_generated": true,          "artwork_model": "string",          "artwork_sha256": "string",          "caption": "string",          "caption_back_translation": "string",          "display_type": "string",          "height": 0,          "kind": "string",          "order": 0,          "output_review": {            "artifact_sha256": "string",            "issues": [              {                "category": "string",                "evidence": "string",                "suggestion": "string"              }            ],            "language": "string",            "model": "string",            "source_sha256": "string",            "status": "clear",            "version": 0          },          "pick": 0,          "pii": "string",          "problems": [            "string"          ],          "sha256": "string",          "source": "syndai",          "source_commit": "string",          "source_sha256": "string",          "source_tree": "string",          "url": "string",          "width": 0        }      ],      "state": "string",      "ticked_at": "string"    }  ],  "review": {    "demo_kind": "string",    "demo_username": "string",    "needs_login": false,    "notes": "string",    "refusal": "string"  },  "work": {    "error": {      "detail": "string",      "kind": "string"    },    "id": "string",    "items": [      {        "locale": "string",        "platform": "string",        "state": "string"      }    ],    "kind": "string",    "requested_at": "string",    "state": "string",    "updated_at": "string"  }}