Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
aiAgents
/
{agentUuid}
/
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>",
      "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"
}

Path Parameters

projectUuid
string<uuid>
required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
agentUuid
string<uuid>
required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Body

application/json

Body of POST /api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/documents.

content
string
required
mimeType
string
required
originalFilename
string
required
name
string
required

Response

Created

results
object
required
status
enum<string>
required
Available options:
ok