Quickstart

Use Bash and cURL to verify a complete request. If you use a ready-made application, start with the client guides.

1. Create an API key

Create a key on the API Keys page, select an available group and model permissions, and save the full key. These commands work in macOS, Linux, or another Bash environment.

export APIONE_API_KEY="YOUR_APIONE_KEY"

Replace YOUR_APIONE_KEY with your key and keep it in your own terminal or server environment.

2. List and select a model

curl --fail-with-body --max-time 120 https://api.apione.ai/v1/models \
  -H "Authorization: Bearer $APIONE_API_KEY"

Copy an ID from data[].id for a model that supports Chat Completions. Check protocols and parameters in the model directory.

export APIONE_MODEL="YOUR_APIONE_MODEL_ID"

Replace YOUR_APIONE_MODEL_ID with the actual case-sensitive ID. If a model is missing from your key’s list, check the key’s permissions and group.

3. Send the first request

curl --fail-with-body --max-time 120 https://api.apione.ai/v1/chat/completions \
  -H "Authorization: Bearer $APIONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"model\":\"$APIONE_MODEL\",\"messages\":[{\"role\":\"user\",\"content\":\"Explain an API gateway in one sentence.\"}]}"

Windows PowerShell quick check

Windows users can run the steps below in PowerShell. First confirm available balance in the APIONE console, then create a key.

$env:APIONE_API_KEY = "YOUR_APIONE_KEY"
$apioneHeaders = @{ Authorization = "Bearer $env:APIONE_API_KEY" }
$apioneModels = Invoke-RestMethod `
  -Uri "https://api.apione.ai/v1/models" `
  -Headers $apioneHeaders -TimeoutSec 30
$apioneModels.data | Select-Object id

Copy a Chat Completions model ID from the list, replace the placeholder below, and then send the request.

$env:APIONE_MODEL = "YOUR_APIONE_MODEL_ID"
$apioneBody = @{
  model = $env:APIONE_MODEL
  messages = @(
    @{ role = "user"; content = "Reply only OK." }
  )
  stream = $false
} | ConvertTo-Json -Depth 6

$apioneReply = Invoke-RestMethod `
  -Uri "https://api.apione.ai/v1/chat/completions" `
  -Method Post -Headers $apioneHeaders `
  -ContentType "application/json; charset=utf-8" `
  -Body ([System.Text.Encoding]::UTF8.GetBytes($apioneBody)) `
  -TimeoutSec 120
$apioneReply.choices[0].message.content
$apioneReply.usage

If you see the model list first and then the reply, both requests succeeded. A client still needs separate verification for streaming, tool calls, and other production capabilities. Keep the HTTP status code and response body when an error occurs, and handle it according to troubleshooting.

4. Check the response and usage

Read the reply from choices[0].message.content and token usage from usage. This example shows only part of the response; text and numbers depend on the actual request:

{
  "choices": [{"message": {"role": "assistant", "content": "Text returned by the model"}}],
  "usage": {"prompt_tokens": 20, "completion_tokens": 30, "total_tokens": 50}
}

Review the request details and charges in the console. API usage fields alone do not replace the bill.

Problem	Check first
401	The complete, valid key and a single authentication method
403 or unavailable model	Model ID, key permissions, and billing group
404	Whether the full request URL duplicates `/v1`
402 / 429	Balance, costs, and concurrency limits

Next: Python and Node.js, streaming, and troubleshooting.

Getting started

Account and billing

Troubleshooting and support

1. Create an API key

2. List and select a model

3. Send the first request

Windows PowerShell quick check

4. Check the response and usage