Endpoints

Full contract for every row in the quick-reference table in SKILL.md [blocked].

Every list endpoint accepts limit (1–100, default 50) and offset (≥0), and answers with pagination.total so you can page through everything.

Projects

List projects

GET /api/v1/projects?limit=50&offset=0Authorization: Bearer $SLEEK_API_KEY

Response 200:

{  "data": [    {      "id": "Nq4bZp8wLcT",      "name": "My App",      "slug": "my-app",      "createdAt": "2026-01-01T00:00:00Z",      "updatedAt": "..."    }  ],  "pagination": { "total": 12, "limit": 50, "offset": 0 }}

Create project

POST /api/v1/projectsAuthorization: Bearer $SLEEK_API_KEYContent-Type: application/json
{ "name": "My New App" }

Response 201: { "data": ... } with a single project.

A plan-capped account gets 403 FORBIDDEN at projects_limit here, and that body carries no data.url.

Get / Delete project

GET    /api/v1/projects/:projectIdDELETE /api/v1/projects/:projectId   → 204 No Content

Components

List components

GET /api/v1/projects/:projectId/components?limit=50&offset=0Authorization: Bearer $SLEEK_API_KEY

Both list and get accept an optional inlineIcons query param (default false). When omitted, icons render as <iconify-icon> web components and the HTML pulls in the Iconify script, so leave it off by default. Pass ?inlineIcons=true only when the consumer needs self-contained SVGs in the HTML (for example, importing into tools that don't run scripts).

Response 200:

{  "data": [    {      "id": "V1StGXR8Z5j",      "screenId": "7hSvA2kLpEr",      "name": "Hero Section",      "activeVersion": 3,      "versions": [        {          "id": "qkP2mN7bXsT",          "version": 1,          "code": "<!DOCTYPE html>...</html>",          "createdAt": "..."        }      ],      "createdAt": "...",      "updatedAt": "..."    }  ],  "pagination": { "total": 5, "limit": 50, "offset": 0 }}

activeVersion can be null or unmatched. See Which version to use [blocked] for code and screenshot selection. id is the component ID; nullable screenId addresses targeted chat edits.

Get component

GET /api/v1/projects/:projectId/components/:componentIdAuthorization: Bearer $SLEEK_API_KEY

Response 200: { "data": ... } with a single component in the same shape as a list item.

References

References are curated design styles from featured Sleek projects. They are world-readable: any valid API key can list them, no scope needed.

GET /api/v1/references?limit=50&offset=0Authorization: Bearer $SLEEK_API_KEY

Response 200:

{  "data": [    {      "id": "3fTkYw6RmQv",      "name": "Ember Fitness",      "previewImageUrls": ["https://.../screenshot.png"]    }  ],  "pagination": { "total": 44, "limit": 50, "offset": 0 }}

To use one, pass its id as referenceId on Send Message.

Chat: Send Message

POST /api/v1/projects/:projectId/chat/messages?wait=falseAuthorization: Bearer $SLEEK_API_KEYContent-Type: application/jsonidempotency-key: <optional, max 255 chars>
{  "message": { "text": "Add a pricing section with three tiers" },  "source": "claude-code",  "imageUrls": ["https://example.com/ref.png"],  "target": { "screenId": "7hSvA2kLpEr" },  "referenceId": "3fTkYw6RmQv"}

Response: async (default, wait=false)

Status 202 Accepted. result and error are absent until the run reaches a terminal state.

{  "data": {    "runId": "kR9dLm2XvBc",    "status": "queued",    "statusUrl": "/api/v1/projects/Nq4bZp8wLcT/chat/runs/kR9dLm2XvBc"  }}

Response: sync (wait=true)

Blocks up to 300 seconds. Returns 200 when completed, 202 if timed out.

{  "data": {    "runId": "kR9dLm2XvBc",    "status": "completed",    "statusUrl": "...",    "result": {      "assistantText": "I added a pricing section with...",      "operations": [        {          "type": "screen_created",          "screenId": "wG5xTn1PjHf",          "screenName": "Pricing",          "componentId": "V1StGXR8Z5j"        },        {          "type": "screen_updated",          "screenId": "7hSvA2kLpEr",          "componentId": "8rJvL4wYhKd"        },        { "type": "theme_updated" }      ]    }  }}

screenId and componentId are distinct ids for the same screen: screenId addresses it in target, componentId addresses it in GET .../components/:componentId and in componentIds on a screenshot.

Chat: Poll Run Status

GET /api/v1/projects/:projectId/chat/runs/:runIdAuthorization: Bearer $SLEEK_API_KEY

The response has the same data shape as send message: result when the run applied operations, error when failed.

{  "data": {    "runId": "kR9dLm2XvBc",    "status": "failed",    "statusUrl": "...",    "error": { "code": "execution_failed", "message": "..." }  }}

A failed run can carry both error and result: the server records the operations that were already applied before the failure. Read result on either terminal status.

Run status lifecycle: queued → running → completed | failed

Chat: Cancel Run

POST /api/v1/projects/:projectId/chat/runs/:runId/cancelAuthorization: Bearer $SLEEK_API_KEY

Marks a queued or running run as failed with error code cancelled and returns the updated run; already-finished runs are returned unchanged.

Screenshots

Takes a snapshot of one or more rendered components.

POST /api/v1/screenshotsAuthorization: Bearer $SLEEK_API_KEYContent-Type: application/json
{  "componentIds": ["V1StGXR8Z5j", "8rJvL4wYhKd"],  "projectId": "Nq4bZp8wLcT",  "format": "png",  "scale": 2,  "gap": 40,  "padding": 40,  "background": "transparent"}

componentIds takes componentId values, which the screenId from a chat operation is not.

Padding resolves per-side → axis → uniform: paddingTop falls back to paddingY, which falls back to padding.

Frames are capped at 4× the default frame height, so a screen longer than that is still cut off at the bottom even with fullHeight: true. On a very long screen, treat the component HTML as the authority for what's below the cap.

Response: raw binary image/png or image/webp with Content-Disposition: attachment.

Share Cards

Renders one shareable image from up to four screens — the social-post framing, distinct from the plain screenshot.

POST /api/v1/share-cardsAuthorization: Bearer $SLEEK_API_KEYContent-Type: application/json
{  "componentIds": ["V1StGXR8Z5j", "8rJvL4wYhKd"],  "projectId": "Nq4bZp8wLcT",  "layout": "stack",  "background": "midnight",  "title": "Ember Fitness"}

Response: raw binary image/png. Share cards and screenshots share one render budget — see the 429 row in SKILL.md [blocked].

Device: Start

POST /api/v1/device/startContent-Type: application/json
{ "source": "claude-code" }

No auth. source is optional (1–64 chars) and drives the <source> wants to connect copy the user sees on the approval page.

Response 201:

{  "data": {    "deviceCode": "...",    "userCode": "ABCD-1234",    "verificationUrl": "https://sleek.design/...",    "expiresIn": 900,    "interval": 5  }}

Device: Poll

POST /api/v1/device/pollContent-Type: application/json
{ "deviceCode": "..." }

No auth. data.status is one of pending, expired, or approved — and only the approved variant carries key, keyId and name. It is handed over exactly once; a poll on an already-claimed code answers 404 NOT_FOUND / Unknown device code, which is indistinguishable from a code that never existed. The full flow is in SKILL.md [blocked].