List AI agent documents

List every knowledge document in the organization.

GET /api/v1/aiAgents/documents

Error

A valid request URL is required to generate request examples

200

{
  "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"
}

Query Parameters

projectUuid · string

Response

200

application/json

Success

results · object[] · required

Show child attributes

status · enum<string> · required

Available options: ok