Skip to main content
GET
/
knowledge
/
{knowledge_base_id}
/
files
Python
from opperai import Opper

opper = Opper()

# List all files in a knowledge base
files = opper.knowledge.list_files(
    knowledge_base_id="your-kb-id"
)

for file in files.data:
    print(f"File: {file.original_filename}")
    print(f"  ID: {file.id}")
    print(f"  Size: {file.size} bytes")
    print(f"  Status: {file.status}")
    print(f"  Metadata: {file.metadata}")
{
  "meta": {
    "total_count": 1
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "original_filename": "<string>",
      "size": 123,
      "status": "<string>",
      "document_id": 123,
      "metadata": {
        "category": "legal",
        "client": "acme"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

knowledge_base_id
string<uuid>
required

The id of the knowledge base to list files from

Query Parameters

offset
integer
default:0

The offset to start the list from

Required range: x >= 0
limit
integer
default:100

The number of files to return

Required range: 1 <= x <= 100

Response

Successful Response

meta
Meta · object
required

Metadata about the response

data
ListFilesResponse · object[]
required

List of items returned in the response