Skip to main content
POST
/
knowledge
/
{knowledge_base_id}
/
register_file
Register File Upload
import requests

url = "https://api.opper.ai/v2/knowledge/{knowledge_base_id}/register_file"

payload = {
    "filename": "example.pdf",
    "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content_type": "application/pdf",
    "configuration": {
        "text_processing.chunk_size": 2000,
        "text_processing.chunk_overlap": 200
    },
    "metadata": {
        "category": "legal",
        "client": "acme"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key": "<string>",
  "original_filename": "<string>",
  "document_id": 123,
  "metadata": {}
}

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 register the file for

Body

application/json
​
filename
string
required

The filename of the file to register

Example:

"example.pdf"

​
file_id
string<uuid>
required

The id of the file to register

​
content_type
string
required

The content type of the file to register

Example:

"application/pdf"

​
configuration
TextProcessingConfiguration · object

The configuration for the file to register

​
metadata
Metadata · object

Optional metadata to attach to the file

Example:
{ "category": "legal", "client": "acme" }

Response

Successful Response

​
id
string<uuid>
required
​
key
string
required
​
original_filename
string
required
​
document_id
integer
required
​
metadata
Metadata · object