Pioneer API authentication: generate and use API keys

Every request to the Pioneer API must include your API key. Pioneer uses a simple header-based scheme — no OAuth flow or token exchange required. Your key identifies you and determines which resources and rate limits apply to your requests.

Getting an API key

Log in at pioneer.ai.
Go to Settings → API Keys.
Click Create key, give it a name, and copy the value shown.

Store your key in an environment variable (for example PIONEER_API_KEY) rather than hard-coding it in source files.

Passing your API key

Include your key in the X-API-Key header on every request:

cURL

curl -X POST https://api.pioneer.ai/inference \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model_id": "YOUR_TRAINING_JOB_ID",
    "text": "Apple announced the MacBook Pro.",
    "schema": {"entities": ["organization", "product"]}
  }'

Managing keys

Create new API keys from Settings -> API Keys in the Pioneer dashboard. API-key-authenticated requests can list and revoke keys, but cannot create more keys.

Create a key

POST /create-api-key is used by the web dashboard and requires a browser session. Calls authenticated with X-API-Key return 403 Forbidden with the message API key creation is only allowed from the web dashboard. The creation response includes the new secret_key value. Copy it immediately — it is not shown again.

List keys

cURL

curl https://api.pioneer.ai/list-api-keys \
  -H "X-API-Key: YOUR_API_KEY"

Returns all keys associated with your account, including their names and creation dates. Key values are not returned in list responses.

Revoke a key

cURL

curl -X DELETE https://api.pioneer.ai/delete-api-key \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key_id": "YOUR_KEY_ID"               
  }'

Revoked keys are rejected immediately on the next request. There is no undo.

Testing connectivity before you have a key

To verify your network can reach the Pioneer API during integration, send a request with a placeholder key. You’ll get a 401 back — which confirms the endpoint is reachable and your request is wired correctly.

curl -X POST https://api.pioneer.ai/v1/messages \
  -H "X-API-Key: pio_sk_test" \
  -H "Content-Type: application/json" \
  -d '{"model":"claude-haiku-4-5","max_tokens":10,"messages":[{"role":"user","content":"hi"}]}'

# Expected: {"detail":"Invalid API key format. API keys must start with 'pio_sk_'. Please check your X-API-Key header."}
# A 401 with this body = integration is wired correctly. Swap in a real key to get completions.

Error responses

Status	Meaning
`401 Unauthorized`	The key is missing, malformed, or has been revoked. Check that the `X-API-Key` header is present and contains a valid key.
`402 Payment Required`	Your account has insufficient credits to complete the request. Visit Settings → Billing to top up your balance.

A 402 response means your account is out of credits. Requests will continue to fail until you add credits or upgrade your plan. See Plans & Pricing for your options.

Get Started

Integrations

Core Concepts

API Reference

Guides

Account

Changelog

Pioneer API authentication: generate and use API keys

Getting an API key

Passing your API key

Managing keys

Create a key

List keys

Revoke a key

Testing connectivity before you have a key

Error responses

​Getting an API key

​Passing your API key

​Managing keys

​Create a key

​List keys

​Revoke a key

​Testing connectivity before you have a key

​Error responses

Getting an API key

Passing your API key

Managing keys

Create a key

List keys

Revoke a key

Testing connectivity before you have a key

Error responses