Skip to content
SylphxSylphx
Sign inStart building
Console
Menu

Start

Platform

AI

App store purchases

Auth

Builds

Database

Email

Flags

Hosting

Jobs and cron

KV

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Realtime

Runners

Sandboxes

Search

Storage

Webhooks

Workflows

Getting Started

Authentication

AI Services

KV Store

Webhooks

Email

Deploy & Infrastructure

Reference

On this page

Reference

AI API contract

Every endpoint of the AI API, with keys, errors and encodings

The AI API at https://api.sylphx.ai/v1 is three things you can build on.

  • A model store. The catalogue lists the models we sell with their context windows and data policy. You call a model id from it.
  • One inference document. Requests are the official OpenAI Responses document, and responses are official Responses objects with metered usage.
  • One Sylphx key. Keys start with sylphx_sk_ and are created and revoked in the console. Apps read the key from SYLPHX_API_KEY.

#Endpoints

Inference, catalogue and file calls take your bearer key; the public catalogue endpoints do not.

MethodPathPurpose
POST/responsesCreate a response. Add stream: true for server-sent events.
POST/responses/compactCompact a stored response.
GET/responses/{response_id}Retrieve a stored response while it is retained.
GET/responses/{response_id}/input_itemsList a response's stored input items.
DELETE/responses/{response_id}Forget a stored response.
POST/responses/{response_id}/cancelThe official cancel route; responses are not background jobs.
POST/chat/completionsThe Chat Completions encoding.
POST/messagesThe Anthropic Messages encoding.
POST/embeddingsText embeddings.
POST/images/generationsImage generation.
POST/audio/speechText to speech.
POST/audio/transcriptionsSpeech to text.
POST/audio/translationsSpeech to English text.
GET/realtime/transcriptionLive transcription over a WebSocket upgrade.
POST/decisionsA structured decision from a model.
GET/modelsThe full catalogue for your key.
GET/models/{model}One model document for your key.
GET/public/modelsThe catalogue without authentication.
GET/public/models/{model}One public model.
POST/filesMultipart upload.
GET/filesList your key's files.
GET/files/{file_id}File metadata, no bytes.
GET/files/{file_id}/contentRaw file bytes.
DELETE/files/{file_id}Delete a file you own.

This API does not create keys or hold accounts: create and revoke sylphx_sk_ keys in the console.

#Keys

One credential shape: a Sylphx API key sent as a bearer token.

HTTP
POST /responses HTTP/1.1
Host: api.sylphx.ai
Authorization: Bearer sylphx_sk_…
Content-Type: application/json
  • A key is shown once when created and can be revoked at any time; a revoked key stops authenticating.
  • A key sees only its own organization's stored responses, files and usage. Another organization's object id is a 404.
  • Never ship a key to a browser.

#Errors

Failures return one JSON envelope: an official error object plus the typed fields a client needs to decide what to do next. The status codes, the code table, the retry rules and the rate-limit headers are on errors and retries.

#Encodings

Three request encodings, one document underneath.

  • Responses is the primary wire. Use it for new code.
  • Messages accepts the Anthropic Messages format and can call any model in the catalogue.
  • Chat Completions accepts the OpenAI Chat Completions format and answers chat.completion objects and chat.completion.chunk streams.

#Limits

Free-tier keys share one envelope across every model: 300 burst requests per minute, 180 sustained requests per minute and 32 requests in flight. Every denial carries Retry-After and a typed envelope.

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links