Create design component

POST/v1/design/components

Signed-in sessionLaunch key product.designOperation design_component_create

An internal tool for design rules and components that agents synthesize, review and promote, with evaluation runs to check them.

Body

expectedAuthorizationVersionstring
sourcePathstring
visibility"private" | "tenant"Required
namestringRequired
keystringRequired
projectIdstringRequired
idempotencyKeystringRequired
repoRefobjectRequired
familyKeystringRequired
briefstringRequired

Returns

schemaVersion1Required
idstringRequired
status"active" | "archived"Required
versionnumberRequired
receiptIdstringRequired
replayedbooleanRequired

Errors

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

POST/v1/design/components

curl "$SPECIFY_API_ORIGIN/v1/design/components" \
  -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 '{"visibility":"private","name":"<name>","key":"<key>","projectId":"<projectId>","idempotencyKey":"retry-1","repoRef":{"ref":"<ref>","repository":"<repository>"},"familyKey":"<familyKey>","brief":"<brief>"}'

Response

{
  "result": {
    "schemaVersion": 1,
    "id": "<id>",
    "status": "active",
    "version": 1,
    "receiptId": "<receiptId>",
    "replayed": true
  }
}