Create design capture

POST/v1/design/captures

Signed-in sessionLaunch key product.designOperation design_capture_create

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

Body

fileIdstring
titlestring
urlstring
expectedAuthorizationVersionstring
notestring
kind"link" | "note" | "screenshot"Required
idempotencyKeystringRequired
folderIdstringRequired

Returns

schemaVersion1Required
idstringRequired
versionnumberRequired
status"active" | "archived"Required
receiptIdstringRequired
replayedbooleanRequired
itemobjectRequired
preview"failed" | "none" | "pending" | "ready"Required

Errors

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

curl "$SPECIFY_API_ORIGIN/v1/design/captures" \ -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 '{"kind":"link","idempotencyKey":"retry-1","folderId":"<folderId>"}'

{ "result": { "schemaVersion": 1, "id": "<id>", "version": 1, "status": "active", "receiptId": "<receiptId>", "replayed": true, "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>" }, "preview": "failed" } }

Create design capture

Headers

Body

Returns

Errors