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 {#base-url}

https://api.ontologie-growthsystemes.com

Authentication {#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 {#required-headers}

See the API Keys Guide for key management.

Response format {#response-format}

Success response {#success}

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

Error response {#error}

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

Main endpoints {#main-endpoints}

Queries (Read) {#queries}

Commands (Write) {#commands}

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 {#live-data}

RAG {#rag}

Pagination {#pagination}

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

Filtering {#filtering}

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

Sorting {#sorting}

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

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

Rate limits {#rate-limits}

Headers in the response:

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

HTTP status codes {#status-codes}

cURL examples {#curl}

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

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

OpenAPI specification {#openapi}

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

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

Expected outcome

Need help?

Write to us: Support and contact.