ReferenceUntagged
Create AI agent document
Create a knowledge document. The projectUuid and agentAccess body fields are deprecated: scope the document by creating it on the agent route instead. Without them the document is available to every agent.
POST/api/v1/aiAgents/documents
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Request body
{
"agentAccess": [
"string"
],
"projectUuid": "string",
"content": "string",
"mimeType": "string",
"originalFilename": "string",
"name": "string"
}Responses
201 — Created
{
"results": {
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedByUserUuid": "string",
"createdByUserUuid": "string",
"agentAccess": [
"string"
],
"storageKey": "string",
"summary": {
"warning": "string",
"relevance": "high",
"useWhen": "string",
"relatedExploreNames": [
"string"
],
"definedTerms": [
"string"
],
"description": "string"
},
"alwaysIncludeInContext": true,
"contentSizeBytes": 0,
"mimeType": "string",
"originalFilename": "string",
"name": "string",
"projectUuid": "string",
"organizationUuid": "string",
"uuid": "string"
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}