Skip to content
use-forever Docs
Esc
navigateopen⌘Jpreview

Create knowledge source

Creates a FILE or WEBSITE knowledge source and triggers ingestion.

POST/v1/knowledge/sources
Authorization
AuthorizationBearer token (JWT) · headerrequired
Request body
requiredapplication/json
One of:
CreateKnowledgeFileSourceRequest
typestringrequired
namestringrequired
min length 1 · max length 160
fileNamestringrequired
min length 1
fileKeystring
min length 1
sizeBytesinteger
min 1
CreateKnowledgeWebsiteSourceRequest
typestringrequired
namestringrequired
min length 1 · max length 160
sourceUrlstring<uri>required
Responses
201Knowledge source created.
idstringrequired
min length 1
namestringrequired
min length 1 · max length 160
typeKnowledgeSourceTyperequired
Allowed:FILEWEBSITE
statusKnowledgeSourceStatusrequired
Allowed:READYSYNCINGFAILED
sourceUrlstring<uri> | nullrequired
fileKeystring | nullrequired
fileNamestring | nullrequired
sizeBytesinteger | nullrequired
min 1
lastSyncedAtstring<date-time> | nullrequired
lastSyncErrorstring | nullrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
Request
curl -X POST "https://api.hackathon.space/v1/knowledge/sources" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "FILE",
  "name": "string",
  "fileName": "string",
  "fileKey": "string",
  "sizeBytes": 0
}'
Response
{
  "id": "string",
  "name": "string",
  "type": "FILE",
  "status": "READY",
  "sourceUrl": "<uri>",
  "fileKey": "string",
  "fileName": "string",
  "sizeBytes": 0,
  "lastSyncedAt": "2024-01-01T00:00:00Z",
  "lastSyncError": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}