Create document

Adds a new document to a knowledge base. Documents are processed asynchronously — the endpoint returns immediately while processing continues in the background.

Endpoint

POST /user/knowledgebases/{knowledgebaseId}/documents

Path parameters

integer

required

Unique identifier of the knowledge base.

Request

string

required

Name of the document. Maximum 255 characters.

string

required

Document type: website, pdf, txt, or docx.

string

Optional description. Maximum 255 characters.

Website documents

string

Main URL to scrape. Required if links is not provided.

array

Specific URLs to scrape. Required if url is not provided.

Show Link properties

string

required

A valid URL to include.

integer

default:"10"

Maximum number of relative links to follow when scraping. Range: 1–50.

File documents (PDF, TXT, DOCX)

file

required

File to upload. Maximum 20 MB. Use multipart/form-data encoding.

Document types

Type	Description	Input
`website`	Scrapes web pages and extracts text	URL or list of URLs
`pdf`	Extracts text from PDF files	PDF file upload
`txt`	Plain text content	TXT file upload
`docx`	Extracts text from Word documents	DOCX file upload

Response

string

Confirmation message.

object

The created document.

Show properties

integer

Unique identifier of the document.

string

Document name.

string

Document description.

string

Document type.

string

Human-readable type label.

string

Processing status — always processing initially.

string

Human-readable status label.

string

ISO 8601 creation timestamp.

Example

curl -X POST "https://portal.intellixent.ai/api/user/knowledgebases/1/documents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Company Website",
    "type": "website",
    "url": "https://example.com",
    "relative_links_limit": 20
  }'

curl -X POST "https://portal.intellixent.ai/api/user/knowledgebases/1/documents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "name=Product Manual" \
  -F "type=pdf" \
  -F "file=@/path/to/document.pdf"

const response = await fetch('https://portal.intellixent.ai/api/user/knowledgebases/1/documents', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Company Website',
    type: 'website',
    url: 'https://example.com',
    relative_links_limit: 20
  })
});

const data = await response.json();
console.log(data.data.id);

201 Created

{
  "message": "Document created successfully. Processing will begin shortly.",
  "data": {
    "id": 1,
    "name": "Company Website",
    "type": "website",
    "type_label": "Website",
    "status": "processing",
    "status_label": "Processing",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}

404 Knowledge base not found

{
  "error": "Knowledgebase not found."
}

Document processing is asynchronous. Poll the knowledge base status using Get knowledge bases to check when all documents are ready.

Overview

Assistants

Calls

Campaigns & Leads

Conversations

Messaging

Phone Numbers

Knowledge & Tools

Webhooks

Endpoint

Path parameters

Request

Website documents

File documents (PDF, TXT, DOCX)

Document types

Response

Example

​Endpoint

​Path parameters

​Request

​Website documents

​File documents (PDF, TXT, DOCX)

​Document types

​Response

​Example

Endpoint

Path parameters

Request

Website documents

File documents (PDF, TXT, DOCX)

Document types

Response

Example