Quickstart

Complete your first API call in 10 minutes.

At a glance

This guide walks you from creating your API key to creating your first entity via the API.

Prerequisites

• Active Ontologie account
• Access to a workspace
• Terminal with curl installed

Step 1: Get your API key

1. Navigate to Settings > API Keys
2. Click Create an API key
3. Copy the key (displayed only once)

export ONTOLOGIE_API_KEY="df_xxxxxxxxxxxxxxxxxxxx"
export WORKSPACE_ID="550e8400-e29b-41d4-a716-446655440000"

Secure storage
API keys are displayed only once. Store them in a secure location (password manager, secrets vault).

Step 2: List entities

Retrieve all entities in your workspace:

curl -s -X GET "https://api.ontologie-growthsystemes.com/api/queries/nodes" \
  -H "Authorization: Bearer $ONTOLOGIE_API_KEY" \
  -H "x-workspace-id: $WORKSPACE_ID"

Expected response:

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Client",
      "entityType": "concept",
      "position": { "x": 100, "y": 100 }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}

Step 3: Create an entity

Create a new entity via the API:

curl -s -X POST "https://api.ontologie-growthsystemes.com/api/commands/execute" \
  -H "Authorization: Bearer $ONTOLOGIE_API_KEY" \
  -H "x-workspace-id: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "CREATE_NODE",
    "payload": {
      "name": "My first entity",
      "entityType": "concept",
      "position": { "x": 200, "y": 200 }
    }
  }'

Expected response:

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "name": "My first entity",
    "entityType": "concept"
  },
  "metadata": {
    "canUndo": true
  }
}

Step 4: Verify in the interface

1. Open the Ontologie application
2. Navigate to your workspace
3. Open the Modeler canvas
4. Your new entity should appear at position (200, 200)

Screenshots to produce (medium priority)

• /img/screenshots/api/access/01-keys-list.png - API key location in Settings
• /img/screenshots/api/access/02-create-key.png - API key creation flow
• /img/screenshots/ontologie/modeler/01-ontology-canvas-overview.png - Entity verification in canvas

Expected outcome: You have created an entity via the API and can view it in the Modeler canvas. You now understand the basics of Ontologie authentication and commands.

Next steps

• API Keys - Advanced authentication (scopes, rotation)
• Modeler - Understand the visual modeling system
• API Reference - Complete endpoint documentation
• Common errors - Error handling best practices

Common issues

Error	Cause	Solution
401 Unauthorized	Invalid or missing API key	Check the Authorization header format
403 Forbidden	Wrong workspace or insufficient scope	Check the x-workspace-id header
404 Not Found	Endpoint does not exist	Check the URL

See Common errors for detailed troubleshooting.

Need help?

Write to us: Support and contact.