API Reference

At a glance

Complete documentation for the Ontologie REST API. Authenticate your requests, browse available endpoints, and integrate Ontologie with your tools.

Technical prerequisites

• An active API key (see the API Keys Guide).
• The UUID identifier of your workspace.
• An HTTP client (curl, Postman, Insomnia, or equivalent).

Explore your endpoints in Ontologie: the API Manager module lets you test and simulate all the endpoints generated by your ontology, directly from the application.

Base URL

https://api.ontologie-growthsystemes.com

Authentication

All endpoints require authentication:

curl "https://api.ontologie-growthsystemes.com/api/queries/nodes" \
  -H "Authorization: Bearer df_xxxxxxxxxxxxxxxxxxxx" \
  -H "x-workspace-id: 550e8400-e29b-41d4-a716-446655440000"

Required headers

Header	Required	Description
Authorization	Yes	Bearer <API_KEY>
x-workspace-id	Yes*	Workspace UUID (*except global routes)
Content-Type	For POST/PUT	application/json

See the API Keys Guide for key management.

Response format

Success response

{
  "success": true,
  "data": { ... },
  "meta": {
    "total": 100,
    "limit": 50,
    "offset": 0
  },
  "requestId": "req_xxxxxxxxxxxx"
}

Error response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid entity type",
    "details": { ... }
  },
  "requestId": "req_xxxxxxxxxxxx"
}

Main endpoints

Queries (Read)

Method	Endpoint	Description
GET	/api/queries/nodes	List all entities
GET	/api/queries/nodes/:id	Get an entity by ID
GET	/api/queries/edges	List all relationships
GET	/api/queries/edges/:id	Get a relationship by ID

Commands (Write)

Method	Endpoint	Description
POST	/api/commands/execute	Execute a command

Command types:

• CREATE_NODE - Create an entity
• UPDATE_NODE - Update an entity
• DELETE_NODE - Delete an entity
• CREATE_EDGE - Create a relationship
• DELETE_EDGE - Delete a relationship
• UNDO - Undo the last action
• REDO - Redo the last undone action

Live Data

Method	Endpoint	Description
GET	/api/live-data/sources	List data sources
POST	/api/live-data/sources	Create a data source
POST	/api/live-data/ingest	Ingest data points
GET	/api/live-data/query	Query time series

RAG

Method	Endpoint	Description
POST	/api/rag/search	Semantic search
POST	/api/rag/hybrid-search	Hybrid vector+graph search
GET	/api/rag/index/status	Index status

Pagination

GET /api/queries/nodes?limit=50&offset=100

Parameter	Default	Max	Description
limit	50	100	Items per page
offset	0	-	Items to skip

Filtering

GET /api/queries/nodes?entityType=concept&name=Client

Sorting

GET /api/queries/nodes?sort=-createdAt,name

• Prefix - for descending order
• Multiple fields separated by comma

Rate limits

Plan	Requests/min	Requests/day
Starter	60	10,000
Pro	300	100,000
Enterprise	Custom	Custom

Headers in the response:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1700000000

HTTP status codes

Code	Meaning
200	Success
201	Created
204	No content (DELETE)
400	Bad request
401	Unauthenticated
403	Forbidden
404	Not found
409	Version conflict
429	Rate limit exceeded
500	Server error

cURL examples

export API_KEY="df_xxx"
export WORKSPACE_ID="550e8400-..."
export API_URL="https://api.ontologie-growthsystemes.com"

curl "$API_URL/api/queries/nodes" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-workspace-id: $WORKSPACE_ID"

OpenAPI specification

The OpenAPI specification is available in the repository at docs/api/openapi.yaml.

Import it into Postman, Insomnia, or generate client SDKs.

Expected outcome

You can authenticate your requests, read and write data via the Ontologie REST API, and integrate the platform with your existing tools.

Need help?

Write to us: Support and contact.