Platform APIs

Authentication

Bearer tokens and base URLs.

Every Converge API call needs a bearer token.

Base URLs

ServiceBase URL
Ontology, data and platform APIhttps://cnvrg.si/api
AI APIhttps://cnvrg.si/ai

Paths in these docs are given relative to the host, for example /api/v2/ontologies.

Bearer tokens

Send the token in the Authorization header:

curl https://cnvrg.si/api/v2/ontologies \
  -H "Authorization: Bearer $TOKEN"

Requests without a valid token are rejected with 401. Calls run with the token's identity, so the same roles, markings and policies apply as in the user interface. When the AI service calls the ontology on your behalf, it forwards your token, so actions still run as you.

Service clients

Automated clients use the OAuth 2.0 client credentials grant. An administrator creates a confidential client with service accounts enabled and grants it the roles it needs. The client then exchanges its credentials for a token:

curl -X POST https://cnvrg.si/api/v2/multipass/oauth2/token \
  -d grant_type=client_credentials \
  -d client_id=$CLIENT_ID \
  -d client_secret=$CLIENT_SECRET

The response contains access_token, token_type (Bearer) and expires_in.

Errors and limits

APIs answer 403 when you lack permission and 429 with Retry-After when you exceed a rate limit.

Converge