SynkVault documentation
Back to SynkVault →

REST API

An overview of calling SynkVault from your own software.

The REST API lets your software read your knowledge base without using the web app.

Base path and sign-in

  • All routes start with /api/v1 on your SynkVault address.
  • Send your API key in the X-Api-Key header.
  • Every route except the health check needs your organisation ID as the org_id query parameter. You can copy it from Organisation settings. Your key only works for organisations it has access to.

Example request

curl "https://<your-synkvault-address>/api/v1/ontology?org_id=<your-organisation-id>" \
  -H "X-Api-Key: <your-api-key>"

This returns the ontology nodes of your organisation.

Common responses

StatusMeaning
401The key is missing or invalid.
400The org_id query parameter is missing.
403The key has no access to that organisation.
Ask your administrator for the address of your SynkVault deployment. Keep your key secret. If it may have been shared, create a new one and delete the old one.

API keys

Create a service account and an API key for programs that call SynkVault.

Apps

Enable or disable apps for your organisation and review what they may do.