DJC AI API
Documentation menu

Start here

Guides

API reference

More

Reference

API reference

One origin, https://api.simplynice.ai, with a base path per resource. JSON in, JSON out, one bearer token. Every endpoint below links to its parameters, samples, scope and error codes.

Conventions

Base URLsKnowledge https://api.simplynice.ai/api/ai/knowledgeWorkflows https://api.simplynice.ai/api/ai/simple-flow
AuthenticationAuthorization: Bearer djc_… (or X-API-Key) on every request. See Authentication & scopes.
ScopeEach endpoint is tagged read or read & write. GET, search and ask are reads; everything else needs write access on that resource.
Content typeapplication/json; multipart/form-data only for the source upload.
Where parameters goPath ids in the URL; filters on GET in the query string; everything else in the JSON body.
Success200 with the documented body; 201 on create; 202 when a run was started.
ErrorsAlways {"success": false, "error", "code", "details"?} with a 4xx/5xx status. See Errors.
TimestampsISO 8601, UTC.
IdentifiersUUIDs for bases, entries, sources, flows, executions; node1-style node ids; e-node1-node2-style edge ids. See Core concepts.
A complete request
curl -X POST "https://api.simplynice.ai/api/ai/knowledge/bases/$KB_ID/search" \
  -H "Authorization: Bearer $DJC_TOKEN" -H "Content-Type: application/json" \
  -d '{ "query": "warranty on the X200", "topK": 3 }'

Endpoint index

Knowledge24 routes

https://api.simplynice.ai/api/ai/knowledge

GET/meWho am Iread
GET/basesList knowledge basesread
POST/basesCreate a knowledge baseread & write
GET/bases/{kbId}Get a knowledge baseread
PATCH/bases/{kbId}Update a knowledge baseread & write
POST/bases/{kbId}/searchSearch entriesread
POST/bases/{kbId}/askAsk (grounded answer)read
GET/bases/{kbId}/entriesList entriesread
GET/bases/{kbId}/subjectsList subjectsread
POST/bases/{kbId}/entriesAdd one entryread & write
PATCH/bases/{kbId}/entries/{id}Edit an entryread & write
DELETE/bases/{kbId}/entries/{id}Delete an entryread & write
POST/bases/{kbId}/entries/bulkBulk actionread & write
POST/bases/{kbId}/importImport ready Q&A pairsread & write
GET/bases/{kbId}/exportExport entriesread
POST/bases/{kbId}/submissionsSubmit material for extractionread & write
GET/bases/{kbId}/messagesSubmission historyread
DELETE/bases/{kbId}/messages/{id}Delete a submission turnread & write
GET/bases/{kbId}/sourcesList sourcesread
POST/bases/{kbId}/sources/uploadUpload a sourceread & write
GET/bases/{kbId}/sources/{id}/downloadDownload the original fileread
DELETE/bases/{kbId}/sources/{id}Delete a source and its entriesread & write
GET/bases/{kbId}/unansweredUnanswered questions (gaps)read
DELETE/bases/{kbId}/unansweredClear unanswered questionsread & write

Workflows20 routes

https://api.simplynice.ai/api/ai/simple-flow

GET/meWho am Iread
GET/node-typesNode catalogread
GET/flowsList flowsread
POST/flowsCreate a flowread & write
GET/flows/{flowId}Get a flow summaryread
PATCH/flows/{flowId}Rename or activate a flowread & write
GET/flows/{flowId}/graphGet the full graphread
PUT/flows/{flowId}/graphReplace the whole graphread & write
GET/flows/{flowId}/nodesList / search nodesread
GET/flows/{flowId}/nodes/{nodeId}Get a noderead
POST/flows/{flowId}/nodesAdd a noderead & write
PATCH/flows/{flowId}/nodes/{nodeId}Edit a noderead & write
DELETE/flows/{flowId}/nodes/{nodeId}Delete a noderead & write
POST/flows/{flowId}/nodes/{nodeId}/testTest one noderead & write
GET/flows/{flowId}/edgesList edgesread
POST/flows/{flowId}/edgesConnect two nodesread & write
DELETE/flows/{flowId}/edges/{edgeId}Delete an edgeread & write
POST/flows/{flowId}/executeRun the flowread & write
GET/flows/{flowId}/executionsRecent runsread
GET/flows/{flowId}/executions/{executionId}Run status and logread