API Guides

These guides answer “how do I use this API?” Choose a protocol or capability, then follow the request flow and examples. Every request requires an API key and a compatible model ID.

If you need exact fields, parameter types, response schemas, or status codes, use the API Reference.

Authorization: Bearer YOUR_API_KEY

Text and agents

  • Chat Completions — OpenAI-compatible message-based text and multimodal requests
  • Responses API — response items, reasoning, tools, and continuation workflows
  • Streaming — receive incremental output from Chat Completions or Responses

Retrieval

  • Embeddings — convert text into vectors
  • Rerank — score and reorder documents against a query

Media

  • Images — generate and edit images
  • Audio — transcribe, translate, and synthesize speech
  • Video — create and poll asynchronous video tasks

Provider-compatible protocols

Before sending a request

  1. Create an API key.
  2. Copy an exact model ID from Models.
  3. Verify that the model supports the endpoint and capabilities you need.
  4. Review the live Pricing page.

The API Reference is the machine-generated contract for the public endpoints; it complements these task-oriented guides.