Skip to main content
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
aiAgents
/
{agentUuid}
/
documents
Error
A valid request URL is required to generate request examples
{
  "results": [
    {
      "name": "<string>",
      "projectUuid": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "organizationUuid": "<string>",
      "uuid": "<string>",
      "originalFilename": "<string>",
      "mimeType": "<string>",
      "contentSizeBytes": 123,
      "alwaysIncludeInContext": true,
      "summary": {
        "warning": "<string>",
        "useWhen": "<string>",
        "relatedExploreNames": [
          "<string>"
        ],
        "definedTerms": [
          "<string>"
        ],
        "description": "<string>"
      },
      "agentAccess": [
        "<string>"
      ],
      "createdByUserUuid": "<string>",
      "updatedByUserUuid": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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}

Response

Success

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