Endpoints
List of all endpoints, organized by group.
Element
Core CRUD operations for nodes and relations in the graph. Elements are the primary building blocks of the data model and can be nodes or relations. Use these endpoints to create, read, update, and delete any element you have access to.
GET /
Get index
GET /<uuid>
Get element
GET /<uuid>/parents
Get parents
GET /<uuid>/children
Get children
GET /<uuid>/related
Get related
POST /
Post index
POST /<uuid>
Post element
PUT /<uuid>
Put element
PATCH /<uuid>
Patch element
DELETE /<uuid>
Delete element
File and upload
Endpoints for attaching binary files to elements and managing resumable uploads. Resumable uploads let you reliably transfer large files in chunks, even over unreliable connections.
GET /<uuid>/file
Get element file
POST /<uuid>/file
Post element file
PUT /<uuid>/file
Put element file
DELETE /<uuid>/file
Delete element file
HEAD /upload/<uuid>
Head upload
PATCH /upload/<uuid>
Patch upload
DELETE /upload/<uuid>
Delete upload
Search
Full-text and structured search across the graph. See the search tutorial for a detailed guide on building search queries.
User
Authentication and account management endpoints. Use these endpoints to register, log in, manage tokens, and retrieve information about the currently authenticated user.
POST /register
Post register
POST /change-password
Post change password
GET /me
Get me
POST /token
Post token
GET /token
Get token
DELETE /token
Delete token
System
Instance-level introspection endpoints. These endpoints expose configuration parameters, the graph’s type structure, and standard security disclosure files for the running instance.
GET /instance-configuration
Get instance configuration
GET /graph-structure
Get graph structure
GET /.well-known/security.txt
Get well known security.txt
Error
Canonical error response pages. Each error endpoint returns a static, machine-readable error response for a specific HTTP status code. They are useful for understanding the error format returned by all other endpoints.
GET /error/400/bad-content
400 bad content
GET /error/400/forbidden-property
400 forbidden property
GET /error/400/incomplete-mutual-dependency
400 incomplete mutual dependency
GET /error/400/missing-property
400 missing property
GET /error/400/reserved-identifier
400 reserved identifier
GET /error/400/reserved-type
400 reserved type
GET /error/401/unauthorized
401 unauthorized
GET /error/403/forbidden
403 forbidden
GET /error/404/not-found
404 not found
GET /error/412/precondition-failed
412 precondition failed
GET /error/500/internal-server-error
500 internal server error
GET /error/501/not-implemented
501 not implemented