Edit Document Setting

POST

https://api.sikaru.ai/v1/projects/:project_id/agent-documents/settings

POST

/v1/projects/:project_id/agent-documents/settings

curl -X POST https://api.sikaru.ai/v1/projects/project_id/agent-documents/settings \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "document": "string",
  "path": [
    "string"
  ]
}'

{
  "document": "string",
  "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": {}
    }
  }
}

Set or remove one setting without rewriting the rest of the document.

Authentication

AuthorizationBearer

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

Path parameters

project_idstringRequired

Request

This endpoint expects an object.

documentstringRequired<=1000000 characters

pathlist of stringsRequired

openumOptionalDefaults to set

Allowed values:

valueanyOptional

Response

Successful Response

documentstring

validationobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error