Quickstart
Get your API key from the portal, set the Base URL, pick a current Model ID, and make your first request. Asterionyx speaks the OpenAI API, so most clients and libraries work out of the box.
Last verified 2026-08-27 against the advertised Chat Completions contract (HTTP 402 INSUFFICIENT_CREDITS, X-Asterionyx-Request-ID). Named client guides record official documentation sources; clean third-party installs were not re-run in this cycle.
Get started in four steps
- Create an account & sign in. Register in the customer portal and sign in. Your account gets a unique ID and a single API key.
- Copy your API key & Base URL. From the API Access page in the portal, reveal and copy your key, and copy the Base URL shown there.
- Recharge Credits. Create a recharge order so your account has Credits. Every request draws from them.
- Make your first request. Send Chat Completions to the Base URL, authenticate with your key, and pass a current Model ID.
Base URL
Use this Base URL with a client that supports a custom OpenAI-compatible Chat Completions endpoint:
https://api.a.eus/v1Authentication
Authenticate with a standard bearer token: send your API key in the Authorization header as "Bearer <your-key>". Keep your key secret — treat it like a password. You can reveal and copy it any time from the portal.
Model Catalog
Discover the current catalog first, then pass a published Asterionyx model ID as the "model" field. Unknown or retired IDs are rejected.
Discover current modelsExample request
Replace the clearly marked placeholder with an ID obtained from the live Model Catalog.
curl https://api.a.eus/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "<MODEL_ID_FROM_CATALOG>",
"messages": [{ "role": "user", "content": "Hello" }]
}'Advertised API surface
The public customer API currently advertises model listing and chat completions. Other OpenAI endpoints are not advertised and should not be assumed to work.
| Capability | Status |
|---|---|
| GET /v1/models | Advertised |
| POST /v1/chat/completions (including stream) | Advertised |
| Tool/function calls | Only if the published model lists tools |
| Vision image input | Only if the published model lists vision |
| Embeddings, Responses, images, audio, files, Assistants | Not advertised |
When Credits run out
If your account has no remaining Credits, API requests are declined until you recharge. The public contract is HTTP 402 with JSON {"error":{"code":"INSUFFICIENT_CREDITS","message":"Credits are insufficient. Recharge in the Portal and try again."}}. That is separate from HTTP 401 authentication failure. Create a recharge in the portal; requests resume with the same API key after Credits are added.
Connect your tools
Guides for clients that can use a custom OpenAI-compatible Chat Completions endpoint. Start with Manual setup if your tool is not listed. Set the Base URL, paste your API key, and select a published Asterionyx Model ID. Embeddings, Responses, images, audio, files, and Assistants are not advertised.