Skip to main content
POST
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
Създаване на документ
curl --request POST \
  --url https://call.aiployees.com/api/user/knowledgebases/{knowledgebaseId}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "url": "<string>",
  "links": [
    {
      "link": "<string>"
    }
  ],
  "relative_links_limit": 123
}
'
{
  "message": "Document created successfully. Processing will begin shortly.",
  "data": {
    "id": 1,
    "name": "Company Website",
    "description": "Main website content",
    "type": "website",
    "type_label": "Website",
    "status": "processing",
    "status_label": "Processing",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}
Този endpoint създава нов документ в база от знания. Документите се обработват асинхронно - endpoint-ът връща резултат незабавно, докато обработката продължава на заден план.

​
Path параметри

​
knowledgebaseId
integer
required
Уникалният идентификатор на базата от знания

​
Request Body

​
name
string
required
Името на документа (максимум 255 символа)
​
description
string
Опционално описание на документа (максимум 255 символа)
​
type
string
required
Тип документ: website, pdf, txt, или docx

​
Website документи

​
url
string
Основният URL за scraping. Задължителен, ако links не е предоставен.
​
links
array
Масив от конкретни URL-и за scraping. Задължителен, ако url не е предоставен.
​
relative_links_limit
integer
default:"10"
Максимален брой относителни връзки за следване при scraping (1-50)

​
Файлови документи (PDF, TXT, DOCX)

​
file
file
required
Файлът за качване (максимум 20MB). Използвайте multipart/form-data encoding.

​
Response

​
message
string
Съобщение за успех
​
data
object
Създаденият документ обект
{
  "message": "Document created successfully. Processing will begin shortly.",
  "data": {
    "id": 1,
    "name": "Company Website",
    "description": "Main website content",
    "type": "website",
    "type_label": "Website",
    "status": "processing",
    "status_label": "Processing",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}

​
Типове документи

ТипОписаниеВход
websiteИзвлича уеб страници и извлича текстово съдържаниеURL или списък с URL-и
pdfИзвлича текст от PDF файловеКачване на PDF файл
txtОбикновено текстово съдържаниеКачване на TXT файл
docxИзвлича текст от Word документиКачване на DOCX файл

​
Пример: Създаване на Website документ

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

​
Пример: Качване на PDF документ

curl -X POST https://call.aiployees.com/api/user/knowledgebases/1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "name=Product Manual" \
  -F "description=User guide for our product" \
  -F "type=pdf" \
  -F "file=@/path/to/document.pdf"
Обработката на документи е асинхронна. Проверете get document endpoint-а, за да видите кога обработката е завършена.