Error
A valid request URL is required to generate request examples{
"results": {
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedByUserUuid": "<string>",
"createdByUserUuid": "<string>",
"agentAccess": [
"<string>"
],
"storageKey": "<string>",
"summary": {
"warning": "<string>",
"relevance": "high",
"useWhen": "<string>",
"relatedExploreNames": [
"<string>"
],
"definedTerms": [
"<string>"
],
"description": "<string>"
},
"alwaysIncludeInContext": true,
"contentSizeBytes": 123,
"mimeType": "<string>",
"originalFilename": "<string>",
"name": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"uuid": "<string>"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}API Reference
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
Error
A valid request URL is required to generate request examples{
"results": {
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedByUserUuid": "<string>",
"createdByUserUuid": "<string>",
"agentAccess": [
"<string>"
],
"storageKey": "<string>",
"summary": {
"warning": "<string>",
"relevance": "high",
"useWhen": "<string>",
"relatedExploreNames": [
"<string>"
],
"definedTerms": [
"<string>"
],
"description": "<string>"
},
"alwaysIncludeInContext": true,
"contentSizeBytes": 123,
"mimeType": "<string>",
"originalFilename": "<string>",
"name": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"uuid": "<string>"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Body
application/json
Body of POST /api/v1/aiAgents/documents. Both scope fields are deprecated: scope now comes from the agent-scoped route path. Once they are removed this endpoint only creates organization level documents.
Was this page helpful?