Skip to main content
POST
/
api
/
v1
/
knowledge-bases
/
add
Add to knowledge base
curl --request POST \
  --url https://app.dumplingai.com/api/v1/knowledge-bases/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "knowledgeBaseId": "kb_123",
  "name": "Product FAQ",
  "content": "Step-by-step onboarding guide..."
}
'
{}

​
Description

This endpoint adds a new text resource to a specified knowledge base. The content is automatically split into chunks and embedded for vector similarity search.
Note: Creating new knowledge bases is no longer available, but this endpoint continues to work for adding content to existing knowledge bases. Knowledge bases will be fully retired in December 2025 due to low usage.

​
Endpoint

POST https://app.dumplingai.com/api/v1/knowledge-bases/add

​
Headers

  • Content-Type: application/json
  • Authorization: Bearer <API_KEY> (required for API access)

​
Request Body

{
  "knowledgeBaseId": "string", // Required. The ID of the knowledge base to add to.
  "name": "string", // Required. The name of the resource.
  "content": "string" // Required. The text content to add.
}

​
Responses

​
Success (201)

Returns the created resource object. 
{
  "id": "string",
  "name": "string",
  "mimeType": "text/plain",
  "size": "number",
  "knowledgeBaseId": "string",
  "content": "string",
  "characterCount": "number",
  "createdAt": "string",
  "updatedAt": "string"
}
  • X-RateLimit-Limit: The rate limit for the user.
  • X-RateLimit-Remaining: The remaining number of requests for the user.

​
Bad Request (400)

Returned if required fields are missing or if adding the resource would exceed the knowledge base character limit. 
{
  "error": "Error message describing the issue"
}

​
Unauthorized (401)

Returned if the API key is invalid or missing. 
{
  "error": "Invalid or missing Authorization header"
}

​
Not Found (404)

Returned if the specified knowledge base is not found. 
{
  "error": "Knowledge base not found"
}

​
Internal Server Error (500)

Returned if there’s an error during the addition process. 
{
  "error": "Failed to query knowledge base"
}

​
Example Request

curl -X POST https://app.dumplingai.com/api/v1/knowledge-bases/add \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "knowledgeBaseId": "kb123456",
  "name": "Company Guidelines",
  "content": "This document outlines our company guidelines..."
}'

​
Notes

  • Credits used are calculated based on character count (10 credits per 10,000 characters).
  • There is a total character limit of 10,000,000 characters per knowledge base.
  • The content is automatically split into chunks and embedded for vector similarity search.
  • The resource is stored with metadata including size, character count, and mime type.
  • Usage is recorded for each addition, including the knowledge base ID and the number of credits used.
  • The content must be in plain text format (mime type: text/plain).

​
Rate Limiting

Rate limit headers (X-RateLimit-Limit and X-RateLimit-Remaining) are included in the response to indicate the user’s current rate limit status.

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Add a plain-text resource to a knowledge base.

​
knowledgeBaseId
string
required

Knowledge base identifier receiving the resource.

​
name
string
required

Human readable name for the resource.

​
content
string
required

Full text content that should be chunked and embedded.

Response

Knowledge base updated.

Flexible JSON structure; fields differ per endpoint.