API & docs

Call the AI tools from your own code.

Self-serve keys open the two Gen-AI tools to your code: KSA Sovereign Gen-AI, processed in-Kingdom on Cohere Command A (Oracle, Riyadh), and Gen-AI Global, whose frontier models run outside the Kingdom. Every call draws on your workspace credits and obeys the same plan limits as the app.

// self-serve keys from the dashboard · one per tool, shown once

curl
# KSA Sovereign Gen-AI — processed in-Kingdom
curl https://ksa.sigmix.ai/api/chat \
  -H "x-sigmix-key: $SIGMIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "لخّص هذا التقرير"
  }'
Built for your stack
Self-serve API keys One key per person, per tool Arabic + English Credits reserved, then settled Same limits as the app
Quickstart

Point it at the tool you use.

Each tool is its own service with its own base URL, and each key belongs to one tool. The paths are the same on both — the base URL decides whether your call is sovereign.

In-Kingdom · sovereign

KSA Sovereign Gen-AI

https://ksa.sigmix.ai/api

Processed in-Kingdom on Cohere Command A (Oracle, Riyadh).

Global · not in-Kingdom

Gen-AI Global

https://genai.sigmix.ai/api

Frontier models — Claude on AWS Bedrock in the US, and Google Gemini. Labelled Global everywhere: your request leaves the Kingdom.

Authentication

One key per tool, revocable.

Create keys yourself on the API keys page of your dashboard — no ticket, no sales call. Each key belongs to one person and one tool, and can be rotated or revoked without touching the others. Send it in the x-sigmix-key header on every request; entitlement, plan limits and credits are still checked on every call.

Keys are shown once at creation and stored hashed. If a key is lost it is rotated, not recovered — which is the behaviour your security team expects.
python
import os, requests

resp = requests.post(
    "https://ksa.sigmix.ai/api/chat",
    headers={"x-sigmix-key": os.environ["SIGMIX_API_KEY"]},
    json={"message": "Summarise Q3 revenue"},
    timeout=120,
)
data = resp.json()
print(data["text"])            # the answer
print(data["creditsCharged"])  # what this call cost
Reference

Endpoints.

The same three paths on both tools. Each request returns one JSON response with the whole answer — not a stream.

MethodPathWhat it does
POST/api/chatA chat completion, in Arabic or English. Send message, or a messages array of user and assistant turns; model and conversationId are optional. Returns the answer, the tokens used and the credits charged.
GET/api/modelsThe models this tool serves — on KSA Sovereign Gen-AI, in-Kingdom models only.
POST/api/creditsYour remaining credit balance.

// full reference, schemas and error codes live in the developer docs — link from your dashboard once you have a key

How it behaves

What your security team will ask.

Residency you choose per call

The base URL is the choice. KSA Sovereign Gen-AI is processed in-Kingdom. Gen-AI Global runs outside the Kingdom and is labelled so.

Honest model listing

GET /api/models returns what this tool serves. On KSA Sovereign Gen-AI, that is in-Kingdom models only.

Same limits as the app

Entitlement, plan caps and credits are enforced on every API call exactly as in the workspace. The API is not a way around them.

No charge for a failed call

Each call reserves its maximum cost first and settles only what it used. A call that fails, or is refused, is not charged.

No training on your calls

API traffic is never used to train any model, ours or a vendor's.

Client libraries

Any HTTP client.

There is no SDK to install: the API is plain JSON over HTTPS. Use whatever your team already runs, and keep the key on the server — never in a browser or an app bundle.

$_curlfrom any shell
PyPythonrequests or httpx
JSNodefetch
{ }RESTany HTTP client
Rate limits

Bounded by your plan.

Limits come from your plan — requests and tokens per minute — and are the same in the app and over the API. Every refusal says why, and none of them is charged.

CaseStatusWhat to do
Over your plan's rate429Back off and retry.
Not enough credits402Top up from Billing — nothing ran, and nothing was charged.
Tool not in your plan403Add the tool to your workspace.
Missing or revoked key401Create or rotate a key from the dashboard.
Questions

For developers

Which tools can I call?
KSA Sovereign Gen-AI and Gen-AI Global. The other tools are used from the workspace; they are not open over the API yet.
Do I need a different key per tool?
Yes. A key belongs to one person and one tool. Create it on the API keys page of your dashboard — it is shown once and stored only as a hash, so a lost key is rotated, not recovered.
Which models can I request?
Call GET /api/models on the tool you are using. On KSA Sovereign Gen-AI it lists in-Kingdom models only. Leave model out and the tool's default is used.
What does a call cost?
It draws on the same credits as your workspace. The maximum is reserved before the work starts and only what the call used is settled. If your balance cannot cover it, the call returns 402 and nothing runs.
Does the API stream?
No. Each request returns one JSON response with the whole answer, the tokens used and the credits charged.
Is API traffic used for training?
No — not by us and not by a vendor behind us. There is no shared training pool.
Start building

Get a key and make one call.

Create a key from your dashboard and make your first call. It draws on the same credits, and obeys the same limits, as your workspace.

Service health and incident notices go to your technical account contact.