Validate Agent Document

POST

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

POST

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

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

{
  "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.

documentstringRequired<=1000000 characters

Response

Successful Response

errorslist of objects

mentionslist of objects

publishableboolean

editorobject or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error