Review Document

POST

https://api.sikaru.ai/v1/projects/:project_id/managed-agents/:agent_slug/document/review

POST

/v1/projects/:project_id/managed-agents/:agent_slug/document/review

curl -X POST https://api.sikaru.ai/v1/projects/project_id/managed-agents/agent_slug/document/review \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "revision": 1
}'

{
  "accessAfter": {},
  "accessBefore": {},
  "accessDelta": {
    "added": [
      "string"
    ],
    "changed": [
      "string"
    ],
    "removed": [
      "string"
    ],
    "capabilities": [
      {}
    ]
  },
  "accessDigest": "string",
  "affectedSchedules": [
    {}
  ],
  "blockers": [
    {
      "mention": "string",
      "reason": "string",
      "state": "string"
    }
  ],
  "ceilingViolations": [
    {
      "message": "string",
      "column": 1,
      "line": 1
    }
  ],
  "diff": "string",
  "document": "string",
  "earlierSessions": [
    {
      "harnessVersionId": "string",
      "sessionId": "string"
    }
  ],
  "harnessVersionId": "string",
  "liveVersionId": "string",
  "revision": 1,
  "validation": {
    "errors": [
      {
        "message": "string",
        "column": 1,
        "line": 1
      }
    ],
    "mentions": [
      {
        "mention": {
          "column": 1,
          "end": 1,
          "kind": "string",
          "line": 1,
          "slug": "string",
          "start": 1,
          "text": "string"
        },
        "state": "string",
        "allowed_hosts": [
          "string"
        ],
        "reason": "string",
        "resource_id": "string",
        "tool_digests": {},
        "warning": "string"
      }
    ],
    "publishable": true,
    "editor": {
      "bodyOffset": 1,
      "settings": {},
      "ceilings": {}
    }
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired

agent_slugstringRequired

Request

This endpoint expects an object.

revisionintegerRequired>=0

acknowledgeRemovalsbooleanOptionalDefaults to false

acknowledgeWideningbooleanOptionalDefaults to false

expectedAccessDigeststring or nullOptional

expectedLiveVersionIdstring or nullOptional

harnessVersionIdstring or nullOptional

Response

Successful Response

accessAftermap from strings to objects

accessBeforemap from strings to objects

accessDeltaobject

accessDigeststring

affectedScheduleslist of maps from strings to any

blockerslist of objects

ceilingViolationslist of objects

diffstring

documentstring

earlierSessionslist of objects

harnessVersionIdstring or null

liveVersionIdstring or null

revisioninteger

validationobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error