> ## Documentation Index
> Fetch the complete documentation index at: https://phaseo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Phaseo Gateway base URL: https://api.phaseo.app/v1. Send `Authorization: Bearer $PHASEO_API_KEY` with every request.
> Model IDs look like `provider/model`, for example `openai/gpt-6-astra`. Do not guess IDs: list them with `GET /v1/models` or check https://phaseo.app/models. `phaseo/free` routes to an available free model and needs no wallet balance.
> For new text integrations prefer `POST /v1/responses`. `POST /v1/chat/completions` (OpenAI format) and `POST /v1/messages` (Anthropic format) suit existing code.
> The full API contract is https://phaseo.app/docs/openapi/v1/openapi.yaml. Official SDKs: `@phaseo/sdk` (TypeScript) and `phaseo` (Python), plus Go, C#, PHP, Ruby and Rust.
> Search these docs over MCP at https://phaseo.app/docs/mcp, and install Phaseo skills with `npx skills add https://phaseo.app/docs`. If a page is wrong or out of date, report it with the MCP `submit_feedback` tool.
> Manage Phaseo accounts with the `phaseo` CLI (`npm install -g @phaseo/cli`, then `phaseo login` or `phaseo login --device-code`), the `/v1` Management API or the MCP server at `https://mcp.phaseo.app/mcp?access=manage`. Do not send users to the dashboard for account tasks. A person is still needed for sign-up, approving a sign-in, paying the first top-up on the checkout link that `phaseo credits add` returns when no card is saved, confirming each saved-card top-up from the emailed link, and account security (password, MFA, passkeys). Create API keys with `phaseo keys create --name <name> --json`; never guess one. Credit top-ups need `phaseo login --scopes billing:write` first. Task map: https://phaseo.app/docs/v1/developers/manage-from-an-agent.md.

# Ruby SDK

> Official Ruby client for the Phaseo Gateway.

Install the published [`phaseo_sdk`](https://rubygems.org/gems/phaseo_sdk) gem from RubyGems.

The local wrapper at `packages/sdk/sdk-ruby/lib/index.rb` currently exposes these methods:

* `generate_text(...)`
* `generate_response(...)`
* `create_anthropic_message(...)`
* `generate_image(...)`
* `generate_image_edit(...)`
* `generate_video(...)`, `get_video(...)`, `cancel_video(...)`, `delete_video(...)`, `list_video_models`, `list_videos(...)`
* `generate_embedding(...)`
* `generate_moderation(...)`
* `generate_speech(...)`
* `generate_transcription(...)`
* `generate_translation(...)`
* `create_batch(...)`, `retrieve_batch(...)`, `cancel_batch(...)`
* `get_async_job_websocket_url(...)`, `batch_websocket_url(...)`, `video_websocket_url(...)`, `async_jobs.websocket_url(...)`
* `list_files(...)`, `retrieve_file(...)`, `retrieve_file_content(...)`, `retrieve_video_content(...)`, `get_video_download_url(...)`, `upload_file(...)`
* `list_models(...)`
* `model_endpoint_capabilities(...)`, `check_model_parameters(...)`
* `list_api_keys(...)`, `create_api_key(...)`, `update_api_key(...)`, `delete_api_key(...)`
* `get_api_key(...)`
* `list_workspaces(...)`, `get_workspace(...)`, `create_workspace(...)`, `update_workspace(...)`, `delete_workspace(...)`
* `list_endpoints`
* `list_organisations(...)`
* `list_pricing_models(...)`
* `calculate_pricing(...)`
* `get_current_api_key`
* `list_providers(...)`, `get_analytics(...)`, `get_credits(...)`, `get_activity(...)`
* `get_generation(...)`
* `health`, `healthz`

```ruby theme={null}
require 'phaseo_sdk'

client = PhaseoSdk::Phaseo.new(api_key: 'YOUR_KEY')
models = client.list_models(limit: 5)
```

`check_model_parameters(...)` uses live provider-route metadata to highlight unsupported or invalid values and return the routes that accept the complete parameter set.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.