VoxLink.ai

API Reference

Create knowledgebase

Create a new knowledgebase

Updated 25 Jan 2026

This endpoint creates a new knowledgebase. After creation, you can add documents to it using the create document endpoint.

Request Body

namestringrequired

The name of the knowledgebase (max 255 characters)

descriptionstring

Optional description of the knowledgebase (max 255 characters)

Response

messagestring

Success message

dataobject

The created knowledgebase object

idinteger

  The unique identifier of the knowledgebase

namestring

  The name of the knowledgebase

descriptionstring

  Description of the knowledgebase

statusstring

  Current status (will be `empty` for new knowledgebases)

status_labelstring

  Human-readable status label

created_atstring

  ISO 8601 timestamp of creation

updated_atstring

  ISO 8601 timestamp of last update
{
  "message": "Knowledgebase created successfully.",
  "data": {
    "id": 1,
    "name": "Product Documentation",
    "description": "Technical documentation for our products",
    "status": "empty",
    "status_label": "Empty",
    "created_at": "2025-01-08T10:30:00.000000Z",
    "updated_at": "2025-01-08T10:30:00.000000Z"
  }
}
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}
{
  "error": "Failed to create knowledgebase. Please try again."
}

Next Steps

After creating a knowledgebase, you'll want to:

  1. Add documents - Use the create document endpoint to add content
  2. Wait for processing - Documents are processed asynchronously
  3. Attach to assistant - Use the update assistant endpoint to attach the knowledgebase

Related guides