Design capture link preview

POST/v1/design/items/{id}/preview

Signed-in sessionLaunch key product.designOperation design_capture_link_preview

An internal tool for the components agents build and the rules they follow.

Path parameters

idstringRequired

Body

expectedAuthorizationVersionstring

Returns

preview"failed" | "none" | "pending" | "ready"Required
itemobjectRequired
schemaVersion1Required

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

curl "$SPECIFY_API_ORIGIN/v1/design/items/<id>/preview" \ -X POST \ -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \ -H "X-Specify-Account-Id: <accountId>" \ -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>" \ -H "Content-Type: application/json" \ -d '{}'

{ "result": { "preview": "failed", "item": { "id": "<id>", "folderId": "<folderId>", "kind": "block", "title": "<title>", "body": "<body>", "url": "<url>", "visibility": "private", "createdAt": 1, "updatedAt": 1, "version": "<version>", "author": { "name": "<name>", "agent": true }, "component": "<component>", "image": "<image>" }, "schemaVersion": 1 } }

Design capture link preview

Headers

Path parameters

Body

Returns

Errors