API REFERENCE

Parametri universali

Intestazioni, schemi di autenticazione, buste di errore e convenzioni che si applicano a ogni endpoint.

Qui risiedono le convenzioni condivise da ogni endpoint: gli header di autenticazione accettati, l'uniforme involucro di errore e il modo in cui vengono negoziati i content type di richiesta e risposta.

I parametri specifici di un singolo endpoint sono documentati nella pagina di quell'endpoint; questa pagina è il riferimento trasversale.

Autenticazione

Tutti gli endpoint richiedono una chiave API Airforce. Generane uno nella dashboard qui sotto Chiavi API. Le chiavi iniziano con sk-air-.

Parameter	Type	Required	Description
Authorization	string	Required	Bearer sk-air-YOUR_API_KEY. Accepted on every endpoint.
x-api-key	string	Optional	Alternative auth header. Accepted on /v1/messages and /v1/responses for Anthropic SDK compatibility.
anthropic-version	string	Optional	Required when using /v1/messages with the @anthropic-ai/sdk. Use "2023-06-01".
Content-Type	string	Optional	application/json for body posts. multipart/form-data for endpoints that accept file uploads (transcriptions, voice cloning, etc.).

Esempi

# Standard
curl https://api.airforce/v1/chat/completions \
  -H "Authorization: Bearer sk-air-YOUR_API_KEY" \
  …

# Anthropic SDK style (only on /v1/messages, /v1/responses)
curl https://api.airforce/v1/messages \
  -H "x-api-key: sk-air-YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  …

# Multipart upload (file endpoints)
curl https://api.airforce/v1/audio/transcriptions \
  -H "Authorization: Bearer sk-air-YOUR_API_KEY" \
  -F "[email protected]" \
  -F "model=whisper-1"

Intestazioni di richiesta facoltative

Parameter	Type	Required	Description
User-Agent	string	Optional	Helpful for debugging. Logged with every request.

Intestazioni di risposta

Parameter	Type	Required	Description
Content-Type	string	Optional	application/json for JSON, text/event-stream for streams, or the media MIME (audio/mpeg, image/png, …) for binary endpoints.

Utilizzo e costo non vengono restituiti come header X-* personalizzati. I conteggi dei token vengono restituiti nell'oggetto usage del corpo della risposta su /v1/chat/completions e /v1/messages (anche gli hit della prompt-cache di Anthropic compaiono lì, es. cache_read_input_tokens). Il costo per richiesta è registrato nel log di utilizzo della tua dashboard, e i job media asincroni riportano un campo cost_cents nella loro risposta di stato.

Ragionamento e riflessione (cross-endpoint)

Modelli con supports_reasoning: true accettano gli stessi parametri canonici ovunque appaiano (attualmente /v1/chat/completions E /v1/messages).

Parameter	Type	Required	Description
reasoning_effort	string	Optional	"low" \| "medium" \| "high". OpenAI o-series / GPT-5 reasoning models only — has no effect on Claude. Use `thinking_budget` for Anthropic budget control.
thinking	string \| object	Optional	"on" / "off" / "auto" for a quick toggle, or { type: "enabled", budget_tokens: N } Anthropic shape. Both forms accepted, both normalised to the upstream's native shape.
thinking_budget	integer	Optional	Maximum tokens spent reasoning before visible output starts. Maps to budget_tokens (Anthropic) and thinking_budget (Gemini).
ignore_defaults	boolean	Optional	Bypass your saved per-model defaults for this single request. Useful when a saved default (e.g. thinking on) is overriding the value you sent.

Modelli con supporto del ragionamento

…· live

Vedere Completamenti chat → Ragionamento per esempi completi.

Convenzione sullo streaming

Endpoint che accettano stream: true rispondere con Content-Type: text/event-stream ed emettere eventi inviati dal server. Il formato del cavo dipende dal punto finale:

Parameter	Type	Required	Description
/v1/chat/completions	OpenAI SSE	Optional	data: {…JSON chunk…}, terminated by data: [DONE].
/v1/messages	Anthropic SSE	Optional	Named events: message_start, content_block_start, content_block_delta, content_block_stop, message_delta, message_stop.
/v1/images/generations (sse: true)	OpenAI-shape SSE	Optional	Single data: event with the full response, then [DONE]. Useful for long-running image jobs to keep the connection alive.
/v1/video/tasks/:id/stream	progress SSE	Optional	Periodic { progress, status } events for in-flight video tasks. Stream closes once the task is done.

Busta di errore

Ogni risposta all'errore utilizza la stessa forma JSON. Il codice di stato HTTP riflette la classe di errore.

Parameter	Type	Required	Description
error.message	string	Optional	Human-readable message safe to display.
error.type	string	Optional	Machine-readable category. See table below.
error.code	string	Optional	Specific identifier when applicable, e.g. "model_not_found".
error.param	string	Optional	Field name that failed validation, when relevant.

Parameter	Type	Required	Description
400	invalid_request	Optional	Malformed JSON, unknown field, validation failed.
401	authentication_error	Optional	Missing or invalid API key.
403	permission_error	Optional	Plan or per-key restriction blocks this request.
404	not_found	Optional	Unknown resource (model, task ID, voice ID).
413	payload_too_large	Optional	Upload exceeds size limit (200 MB for voice samples, etc.).
429	rate_limit	Optional	Per-second throttle, daily token cap, or balance exhausted.
500	internal_error	Optional	Unexpected. Quote the X-Request-ID when reporting.
503	upstream_error	Optional	Every key for the requested provider is failing right now. Retry with a different model or wait.

{
  "error": {
    "message": "Model 'gpt-99' not found.",
    "type": "invalid_request",
    "param": "model",
    "code": "model_not_found"
  }
}

Limiti di velocità e tentativi

I limiti vengono applicati per chiave API. Il superamento di uno qualsiasi di essi restituisce 429:

Per-second request throttle (plan-dependent).
Daily token cap on free / pay-as-you-go plans.
Limite di credito per chiave quando ne imposti uno nella dashboard.
Concurrent video tasks (typically 4 in flight).

Retry with exponential backoff on 429 and 503. Don't retry on 4xx other than 429.

Idempotenza

Gli endpoint di generazione (chat, immagini, audio, video) non sono idempotenti: ogni chiamata produce una nuova risposta e viene fatturata in modo indipendente. Per risultati deterministici, imposta un seed fisso dove supportato (immagine/audio/alcuni modelli di chat). Gli endpoint asincroni a esecuzione prolungata (/v1/video/generazioni) restituiscono un task_id che puoi ripetere il polling in sicurezza.

Mappa degli endpoint

Tutti gli endpoint pubblici a colpo d'occhio.

Parameter	Type	Required	Description
POST /v1/chat/completions	chat	Optional	OpenAI Chat Completions. See /docs/api/chat.
POST /v1/messages	chat	Optional	Anthropic Messages. See /docs/api/chat.
POST /v1/responses	chat	Optional	Anthropic Responses (stateful). See /docs/api/chat.
GET /v1/models	models	Optional	List available models. See /docs/api/models.
POST /v1/images/generations	image	Optional	Generate / edit images. See /docs/api/media.
POST /v1/audio/speech	audio	Optional	Text-to-speech. See /docs/api/audio.
POST /v1/audio/music	audio	Optional	Music generation.
POST /v1/audio/sound-effects	audio	Optional	SFX generation.
POST /v1/audio/transcriptions	audio	Optional	Speech-to-text.
POST /v1/audio/audio-isolation	audio	Optional	Voice isolation / noise removal.
POST /v1/audio/voice-changer	audio	Optional	Speech-to-speech voice conversion.
POST /v1/audio/dubbing	audio	Optional	Async multi-language dubbing.
GET /v1/audio/voices	audio	Optional	Catalog of TTS voices.
POST /v1/voices/clone	voice	Optional	Clone a custom voice. See /docs/api/audio#voice-cloning.
GET /v1/voices/library	voice	Optional	List your cloned voices.
POST /v1/video/generations	video	Optional	Async video generation. See /docs/api/video.
GET /v1/video/tasks/:id	video	Optional	Poll a video task.