Get design component

GET/v1/design/components/{id}

Signed-in sessionLaunch key product.designOperation design_component_get

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

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

status"active" | "archived"Required
versionnumberRequired
createdAtnumberRequired
updatedAtnumberRequired
sourcePathstring
idstringRequired
projectIdstringRequired
projectStatus"active" | "archived"Required
keystringRequired
namestringRequired
visibility"private" | "tenant"Required
familyKeystringRequired
briefstringRequired
repoRefobjectRequired
schemaVersion1Required

Errors

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

GET/v1/design/components/{id}

curl "$SPECIFY_API_ORIGIN/v1/design/components/<id>" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "status": "active",
    "version": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "id": "<id>",
    "projectId": "<projectId>",
    "projectStatus": "active",
    "key": "<key>",
    "name": "<name>",
    "visibility": "private",
    "familyKey": "<familyKey>",
    "brief": "<brief>",
    "repoRef": {
      "ref": "<ref>",
      "repository": "<repository>"
    },
    "schemaVersion": 1
  }
}