Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Sample shape for DataDoc.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "folderId": "<folder_id>",
  "name": "Example name",
  "context": [
    "<doc-context>"
  ],
  "restrictedTo": [
    "example"
  ],
  "aiAccess": false,
  "archived": false,
  "author": "example"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
folderIdstringOptional
namestringRequired
contextarray<DocContext>Optional
restrictedToarray<string>Optional
aiAccessbooleanOptional
archivedbooleanOptional
authorstringOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/docs/doc
  • PUT /api/docs/doc/{docId}

​
Response body

  • GET /api/docs/doc/{docId}
  • GET /api/docs/folder/{folderId}/list
  • POST /api/docs/doc

​
CLI

ekso docs doc — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.