API ReferenceDesigns
Get a design
Preview URLs are re-signed on every read. When the previews are missing or out of date, a render starts and previewUrls fills on a later read.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
curl -X GET "https://example.com/v1/designs/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "0d9c3a52-7b1e-4f7a-9d55-3f4b2a1c9e10", "name": "Summer sale", "width": 1080, "height": 1350, "pageCount": 1, "sizePreset": "ig-post-45", "editUrl": "https://app.nimply.io/workspace/8b2e5821-…/studio/design/0d9c3a52-…", "previewUrls": [ "string" ], "thumbnailUrl": "string", "createdAt": "2026-10-21T09:00:00.000Z", "brandMatch": 82, "styleVersion": 3}Empty