Designs

Create a Design Studio project — blank at a given size, from a built-in template slug, or as a copy of an existing design (an org template, say). Returns the new design; edit its doc with designs.update.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/designs.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "width": 1
  }'

Over MCP the same operation is the tool designs_create at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a design project. Exported PNGs already in the media library are kept. This cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/designs.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool designs_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one design with its full document: pages of positioned text, image and shape elements on a fixed-size canvas. PNG export happens in the browser editor; machines read the doc here and the thumbnail URL from designs.list.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/designs.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool designs_get at https://app.chirply.io/api/mcp, same bearer token, same input.

List the organization's Design Studio projects, most recently edited first, with canvas size and thumbnail URL.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/designs.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 48,
    "offset": 0
  }'

Over MCP the same operation is the tool designs_list at https://app.chirply.io/api/mcp, same bearer token, same input.

List the built-in design templates — slug, name, category and canvas size — plus the size presets for a blank canvas. Pass include_documents to also get each template's full starter document, which is the actual arrangement of text, image and shape elements it would create; that payload is large, so it is off by default. Use a template's slug, or a preset's width and height, with designs.create. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/designs.list_templates \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "include_documents": false
  }'

Over MCP the same operation is the tool designs_list_templates at https://app.chirply.io/api/mcp, same bearer token, same input.

Rename a design, replace its document, or promote/demote it as a reusable org template. `doc` REPLACES the whole document — there is no per-element patch and NO VERSION HISTORY, so whatever was on the canvas before is gone the moment this returns. Always read the current document with designs.get, change what you need, and send the whole thing back. The document is normalized on save: unrecognised element types are dropped and every number is clamped (20 pages, 200 elements per page, 10000 px canvas), so an element that silently disappears is one the schema did not recognise.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/designs.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool designs_update at https://app.chirply.io/api/mcp, same bearer token, same input.