Chat

Send generation message

Send a natural-language prompt to generate or modify screens in a project. Returns immediately with a run_id (status 202). Poll the run status URL to check progress, or use ?wait=true to block up to 300 seconds for the result.

Image references: Pass an images array to include up to 5 reference images (logos, screenshots, brand marks). Each image must be base64-encoded (max 5 MB decoded, formats: PNG, JPEG, WebP). The server validates each image, strips metadata, and re-encodes it before storage.

Idempotency: Pass an Idempotency-Key header (any unique string, max 255 chars). If the same key is sent again, the existing run is returned instead of creating a new one. This makes retries safe.

Concurrency: Only one run is allowed per project at a time. If a run is already in progress, returns 409 with the active run ID.

post/v1/developer/projects/{project_id}/chat/messages/

Request

  • Base URL: https://screensdesign.com
  • URL: https://screensdesign.com/v1/developer/projects/{project_id}/chat/messages/
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Query parameters

waitboolean

If true, block until the generation completes (max 300s). Returns 202 if it times out.

Headers

Idempotency-Keystring

Optional unique key (e.g. UUID) to make the request safely retryable. Max 255 chars.

Request body

promptstring required

Natural-language description of what to generate or modify.

imagesobject[]

Optional list of base64-encoded reference images. Each item is an object with a 'data' field (base64 string, optionally as a data URL like 'data:image/png;base64,...') and an optional 'content_type'. Max 5 images, 5 MB each. Allowed formats: PNG, JPEG, WebP. Server validates and re-encodes every image, stripping metadata.

Response

Sync mode (?wait=true): generation completed within 300s. Returns the full result.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.