Skip to content

Quickstart

From a new Workspace to one working request: create a Pool, issue a key, call the API.

Updated View as Markdown
For humans

This is the shortest honest path to a first successful call. It assumes you can sign in to the console at https://console.airuntime.dev.

1. Pick a Workspace

Sign in, choose the Organization, then choose a Workspace from the scope switcher. Production and development are separate scopes; start in the one you actually intend to call.

2. Create a Pool

Open Pools and create one:

  1. Choose the capability — for a first text call, text.
  2. Choose the provider connection and model that should answer. Add a fallback if you have one.
  3. Set a hard monthly budget and a request rate limit. The budget is enforced, not advisory.
  4. Save, then copy the Pool slug. That slug is the model name in your requests.

3. Issue a Workspace API key

Open API keys, issue a key for this Environment, and grant it the Pool you just created. The secret is shown once and starts with rk_. Store it in your secret manager; the console never shows it again.

4. Confirm what the key can reach

curl https://api.airuntime.dev/v1/models \
  -H "Authorization: Bearer $AIRUNTIME_API_KEY"

The response lists only the Pools this exact key, Environment, Agreement, Home Cloud, provider connection and fallback policy can call right now. If your Pool is missing, the reason is one of those — see Troubleshooting.

5. Send one request

curl https://api.airuntime.dev/v1/responses \
  -H "Authorization: Bearer $AIRUNTIME_API_KEY" \
  -H "X-AIRuntime-Route: YOUR_POOL_SLUG" \
  -H "Idempotency-Key: quickstart-request-0001" \
  -H "Content-Type: application/json" \
  -d '{"input": "Summarize our deployment notes", "store": false}'

X-AIRuntime-Route selects the Pool. When a body also carries model, it must name the same Pool, because the Pool is the only model a caller ever sends.

6. Look at what happened

The response carries an x-airuntime-request-id header. Open Requests in the console to see that exact record, and Usage to see the interval cost it settled into.

Next

  • Pools — lifecycle, fallback and budget policy.
  • Requests — every interface, header and error shape.
  • Usage and billing — where the money view lives.

Type to search…

↑↓ navigate↵ selectEsc close