Quickstart - Apiosk

1. Create a team account

Sign up in the app, choose a team account, and confirm your email. This creates an organisation. An owner or admin can open Organisation → API keys. Fund the organisation’s main balance before making a paid call; creating a key and browsing sources do not charge it.

2. Create an API key

Give the key a name, expiry, per-request limit, monthly limit and the permissions it needs. Copy the secret when it appears; it is shown once. Keep it on your server.

export APIOSK_KEY="apk_org_live_…"

For this guide, enable sources:read, sources:execute and billing:read. Add ask:create and ask:execute to run questions through Ask.

3. Check the key and browse

curl https://gateway.apiosk.com/v2/balance \
  -H "Authorization: Bearer $APIOSK_KEY"

curl -G https://gateway.apiosk.com/v2/sources \
  -H "Authorization: Bearer $APIOSK_KEY" \
  --data-urlencode "search=company registry"

The directory includes sources that cannot currently run. Choose a row with available_in_v2: true, then inspect its executable operations, exact inputs and current prices:

curl https://gateway.apiosk.com/v2/sources/kvk-dutch-business-register \
  -H "Authorization: Bearer $APIOSK_KEY"

4. Run one operation

Use an operation and input returned by the source detail. Set a unique Idempotency-Key for this purchase:

curl https://gateway.apiosk.com/v1/execute/kvk-dutch-business-register/company_registry.search \
  -H "Authorization: Bearer $APIOSK_KEY" \
  -H "Idempotency-Key: quickstart-1" \
  -H "Content-Type: application/json" \
  -d '{"company.name":"Mollie B.V."}'

A completed response includes data, results[].metadata, usage.cost, usage.held and balance.remaining. If it returns HTTP 202, read the saved run at GET /v2/runs/. This is a paid operation; do not run the example simply to test a key.

When you do not know the source

Ask for a free priced plan:

curl https://gateway.apiosk.com/v2/ask \
  -H "Authorization: Bearer $APIOSK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"Registered address and filed accounts for Mollie B.V."}'

If the response needs input or an entity selection, ask the person for the missing detail and submit a clarified question. If a plan is ready, review its total ceiling before calling POST /v2/asks//run. See Ask and Prices and balance.

​1. Create a team account

​2. Create an API key

​3. Check the key and browse

​4. Run one operation

​When you do not know the source

1. Create a team account

2. Create an API key

3. Check the key and browse

4. Run one operation

When you do not know the source