Knowledge

Knowledge sources for RAG

List knowledge sources

get

Returns a list of knowledge sources (RAG documents). Requires Power plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

pageintegerOptional

Page number for pagination

Responses

200

A list of knowledge sources

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

source_typestring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-time · nullableOptional

get

/v1/knowledge

HTTPcURLJavaScriptPython

GET /v1/knowledge HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

A list of knowledge sources

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "source_type": "text",
    "indexing": {
      "chunks_indexed": 1,
      "total_chunks": 1,
      "was_limited": true,
      "indexed_at": "2026-03-20T12:43:50.981Z"
    },
    "created_at": "2026-03-20T12:43:50.981Z",
    "updated_at": "2026-03-20T12:43:50.981Z"
  }
]

Create a text knowledge source

post

Create a knowledge source from text content. For file uploads, use POST /v1/knowledge/upload.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

namestring · max: 200Required

descriptionstring · max: 500Optional

contentstring · max: 100000Required

The text content to index

Responses

201

Knowledge source created

application/json

post

/v1/knowledge

HTTPcURLJavaScriptPython

POST /v1/knowledge HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "text",
  "description": "text",
  "content": "text"
}

201

Knowledge source created

{
  "id": 1,
  "name": "text",
  "description": "text",
  "source_type": "text",
  "indexing": {
    "chunks_indexed": 1,
    "total_chunks": 1,
    "was_limited": true,
    "indexed_at": "2026-03-20T12:43:50.981Z"
  },
  "created_at": "2026-03-20T12:43:50.981Z",
  "updated_at": "2026-03-20T12:43:50.981Z"
}

Request upload URL for file-based knowledge

post

Get a signed URL to upload a PDF or TXT file. After uploading, call POST /v1/knowledge/{id}/confirm to trigger processing. Maximum file size: 50MB.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

namestring · max: 200Required

descriptionstring · max: 500Optional

filenamestringRequired

content_typestring · enumRequiredPossible values:

Responses

201

Upload URL generated

application/json

post

/v1/knowledge/upload

HTTPcURLJavaScriptPython

POST /v1/knowledge/upload HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "text",
  "description": "text",
  "filename": "text",
  "content_type": "application/pdf"
}

201

Upload URL generated

{
  "knowledge_id": 1,
  "upload_url": "text",
  "expires_at": "2026-03-20T12:43:50.981Z"
}

Get a knowledge source

get

Get a single knowledge source by ID. Requires Power plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idintegerRequired

Knowledge source ID

Responses

200

Knowledge source detail

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

source_typestring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-time · nullableOptional

get

/v1/knowledge/{id}

HTTPcURLJavaScriptPython

GET /v1/knowledge/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Knowledge source detail

{
  "id": 1,
  "name": "text",
  "description": "text",
  "source_type": "text",
  "indexing": {
    "chunks_indexed": 1,
    "total_chunks": 1,
    "was_limited": true,
    "indexed_at": "2026-03-20T12:43:50.981Z"
  },
  "created_at": "2026-03-20T12:43:50.981Z",
  "updated_at": "2026-03-20T12:43:50.981Z"
}

Delete a knowledge source

delete

Delete a knowledge source and its embeddings. Requires Power plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idintegerRequired

Knowledge source ID

Responses

204

Knowledge source deleted

delete

/v1/knowledge/{id}

HTTPcURLJavaScriptPython

DELETE /v1/knowledge/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

204

Knowledge source deleted

No content

Update a knowledge source

patch

Update knowledge source metadata (name, description, etc.). Requires Power plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idintegerRequired

Knowledge source ID

Body

application/json

namestringOptional

descriptionstring · nullableOptional

site_idstring · uuid · nullableOptional

enabledbooleanOptional

Responses

200

Knowledge source updated

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

source_typestring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-time · nullableOptional

patch

/v1/knowledge/{id}

HTTPcURLJavaScriptPython

PATCH /v1/knowledge/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "name": "text",
  "description": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "enabled": true
}

200

Knowledge source updated

{
  "id": 1,
  "name": "text",
  "description": "text",
  "source_type": "text",
  "indexing": {
    "chunks_indexed": 1,
    "total_chunks": 1,
    "was_limited": true,
    "indexed_at": "2026-03-20T12:43:50.981Z"
  },
  "created_at": "2026-03-20T12:43:50.981Z",
  "updated_at": "2026-03-20T12:43:50.981Z"
}