> ## 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.

# Usage

> Run tool loops, human review, retries, and resumable agents with the Ruby Agent SDK.

## Prepare the runtime

The Agent SDK gem is not yet on RubyGems. Follow the [source installation instructions](https://phaseo.app/docs/v1/sdk-reference/ruby/agent-sdk-installation.md).

## Quickstart

```ruby theme={null}
require "phaseo_agent_sdk"

agent = PhaseoAgentSdk.create_agent(
  id: "quickstart-agent",
  model: "openai/gpt-5.4-nano",
  instructions: "Answer concisely and helpfully."
)

result = agent.run(
  input: "Give me one fun fact about cURL.",
  client: PhaseoAgentSdk.create_gateway_agent_client
)

puts result.output
```

## What it ships

* `PhaseoAgentSdk.create_agent(...)`
* `PhaseoAgentSdk.define_tool(...)`
* `PhaseoAgentSdk.create_gateway_agent_client(...)`
* a bounded tool loop over the Phaseo `responses` API

## Advanced runtime

Ruby supports validation and approval callables, HITL and manual tools, progress, recoverable errors, replayable enumerators, stop helpers, dynamic turns, persisted next-turn parameters, normalized usage/cost, and duck-typed state accessors.

## Streaming and cancellation

`Agent#stream(...)` and `Agent#continue_stream(...)` consume the gateway's Responses SSE stream on a worker thread. Use `text_stream`, `reasoning_stream`, `item_stream`, or `full_stream`; call `cancel` to stop the worker and close the HTTP stream. Completed steps retain request IDs, provider metadata, finish reasons, warnings, usage, and cost.

## Related

* [Agent SDK overview](https://phaseo.app/docs/v1/sdk-reference/agent-sdk/overview.md)
* [TypeScript Agent SDK](https://phaseo.app/docs/v1/sdk-reference/typescript/agent-sdk.md)


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