Skip to main content

NucliaDB REST API (v1)

API reference for the NucliaDB, covering all the endpoints related to pushing or searching contents.

Resources

Knowledge Box resource endpoints

Get Resource (by id)


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • READER
path Parameters
kbid
required
string (Kbid)
rid
required
string (Rid)
query Parameters
show
Array of strings (Show)
Default: "basic"
Items Enum: "basic" "origin" "extra" "relations" "values" "extracted" "errors" "security"
field_type
Array of strings (Field Type)
Default: "text&field_type=file&field_type=link&field_type=layout&field_type=conversation&field_type=keywordset&field_type=datetime&field_type=generic"
Items Enum: "text" "file" "link" "layout" "conversation" "keywordset" "datetime" "generic"
extracted
Array of strings (Extracted)
Default: "text&extracted=metadata&extracted=link&extracted=file"
Items Enum: "text" "metadata" "shortened_metadata" "large_metadata" "vectors" "link" "file" "question_answers"
header Parameters
x-nucliadb-user
string (X-Nucliadb-User)
Default:
x-forwarded-for
string (X-Forwarded-For)
Default:

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "title": "string",
  • "summary": "string",
  • "icon": "string",
  • "layout": "string",
  • "thumbnail": "string",
  • "metadata": {
    },
  • "usermetadata": {
    },
  • "fieldmetadata": [
    ],
  • "computedmetadata": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "last_seqid": 0,
  • "last_account_seq": 0,
  • "queue": "private",
  • "origin": {
    },
  • "extra": {
    },
  • "relations": [
    ],
  • "data": {