Get design component context

GET/v1/design/components/{id}/context

Signed-in sessionLaunch key product.designOperation design_component_context_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
revisionIdstring
reviewCursorstring
guidanceCursorstring
requestCursorstring
ifContextHashstring

Returns

bundlenull | object
clarificationRefsobject[]
guidanceobject[]
componentobject
revisionnull | object
acceptedRevisionnull | object
reviewsobject[]
openRequestsobject[]
nextCursorsobject
schemaVersionnumberRequired
contextHashstringRequired
unchangedfalse | trueRequired

Errors

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

GET/v1/design/components/{id}/context

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

Response

{
  "result": {
    "bundle": "<bundle>",
    "clarificationRefs": [
      {
        "id": "<id>",
        "changeRequestId": "<changeRequestId>",
        "question": "<question>",
        "status": "answered",
        "version": 1,
        "revisitAt": "<revisitAt>"
      }
    ],
    "guidance": [
      {
        "answerId": "<answerId>",
        "changeRequestId": "<changeRequestId>",
        "answer": "<answer>",
        "disposition": "answer"
      }
    ],
    "component": {
      "id": "<id>",
      "name": "<name>",
      "brief": "<brief>",
      "version": 1,
      "status": "active"
    },
    "revision": "<revision>",
    "acceptedRevision": "<acceptedRevision>",
    "reviews": [
      {
        "id": "<id>",
        "kind": "judgment",
        "verdict": "keep",
        "activeEvidence": true,
        "categories": {},
        "note": "<note>",
        "annotations": [
          {
            "sha256": "<sha256>",
            "previewKey": "<previewKey>",
            "note": "<note>"
          }
        ],
        "reviewedPreviewKeys": [
          "<reviewedPreviewKey>"
        ]
      }
    ],
    "openRequests": [
      {
        "id": "<id>",
        "componentId": "<componentId>",
        "baseRevisionId": "<baseRevisionId>",
        "state": "cancelled",
        "version": 1,
        "instruction": "<instruction>"
      }
    ],
    "nextCursors": {
      "guidance": [
        {
          "requestId": "<requestId>",
          "cursor": "<cursor>"
        }
      ],
      "requests": "<requests>",
      "reviews": "<reviews>"
    },
    "schemaVersion": 1,
    "contextHash": "<contextHash>",
    "unchanged": false
  }
}