Add sources to a knowledge base

Add PDF files or text content as sources to an existing knowledge base.

POST /v1/knowledge-bases/{knowledge_base_id}/sources

Try it

Add sources to a knowledge base

cURL

curl --request POST \
  --url https://api.callrounded.com/v1/knowledge-bases/{knowledge_base_id}/sources \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --form 'file_sources=<string>' \
  --form 'text_sources=<string>' \
  --form file_sources.0.items='@example-file'

200

Example

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "status": "ingesting",
    "organization_id": "123e4567-e89b-12d3-a456-426614174001",
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "file_name": "<string>",
        "file_url": "<string>",
        "type": "file"
      }
    ]
  },
  "message": "Sources added to knowledge base successfully",
  "error": {
    "details": [
      {
        "field": "email",
        "message": "Invalid email format"
      }
    ],
    "message": "An error occurred while processing your request",
    "status": 400,
    "type": "generic_error"
  },
  "status": 200
}

Authorizations

X-Api-Key · string · header · required

The API Key created in Rounded Studio.

• You can create it by going to the "API Keys" settings of your profile.
• Need help? You can email us at [e-mail] or join our Discord community.

Path Parameters

knowledge_base_id · string<uuid> · required

Body

multipart/form-data

file_sources · file[] | null

List of PDF files to upload as sources. Only PDF files are supported.

text_sources · string | null

JSON string containing an array of text sources, each with 'title' and 'content' fields.

Response

200

application/json

Successfully added sources to knowledge base

data · KnowledgeBaseGetApiResponseData · object · required

The updated knowledge base data.

Show child attributes

data. id · string<uuid> · required

Unique identifier for the knowledge base.

data. name · string · required

Name of the knowledge base.

data. created_at · string<date-time> · required

Timestamp when the knowledge base was created.

data. status · enum<string> · required

Current status of the knowledge base ('ready' or 'ingesting').

Available options: ingesting, ready

data. organization_id · string<uuid> | null

ID of the organization the knowledge base belongs to.

Example:

"123e4567-e89b-12d3-a456-426614174001"

data. sources · (FileSourceApiResponseData · object | TextSourceApiResponseData · object)[]

List of sources included in the knowledge base.

FileSourceApiResponseData

TextSourceApiResponseData

Show child attributes

data.sources. id · string<uuid> · required

Unique identifier for the source.

data.sources. created_at · string<date-time> · required

Timestamp when the source was created.

data.sources. file_name · string · required

Name of the file.

data.sources. file_url · string · required

URL where the file can be accessed.

data.sources. type · string · default: file

Indicates this is a file source.

message · string · default: Sources added to knowledge base successfully

Response message indicating the result of the operation.

error · ApiResponseError · object

Show child attributes

error. message · string · required

error. type · string · required

error. status · integer · required

error. details · ApiResponseErrorDetail · object[] | null

Show child attributes

error.details. message · string · required

error.details. field · string | null

Example:

{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}

status · integer · default: 200

HTTP status code of the response.