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

# Streaming

> Stream text, reasoning, tool activity, and complete agent events.

Use `stream()` when your interface should show an agent's response or tool activity while the run is still in progress. It starts the same resumable state machine as `run()` with a streaming model client.

## Stream text

```typescript theme={null}
const result = agent.stream({ input, client });

for await (const delta of result.getTextStream()) {
  process.stdout.write(delta);
}

const completed = await result.getResult();
console.log(completed.run.status);
```

## Read the result in more than one place

Stream consumers are replayable, so rendering, telemetry, and persistence code can consume the same run concurrently:

```typescript theme={null}
const result = agent.stream({ input, client });

const [text, completed] = await Promise.all([
  result.getText(),
  result.getResult(),
]);
```

## Choose a stream

* `getTextStream()` yields answer text.
* `getReasoningStream()` yields reasoning updates when the model provides them.
* `getItemsStream()` yields typed `AgentItem<TOutput>` values for messages, reasoning, tool activity, errors, and final outputs.
* `getToolStream()` yields tool activity.
* `getFullStream()` yields complete runtime events.

Use `cancel()` to abort the run. Local tools receive cancellation through their runtime signal.

## Stream tool progress

Tools implemented as async generators can publish preliminary results. These appear in the full stream as `tool.preliminary_result` events and remain attached to the completed step.

```typescript theme={null}
const indexRepository = defineTool({
  id: "index-repository",
  async *execute(input: { path: string }) {
    yield { phase: "scan" };
    yield { phase: "embed" };
    return { indexed: 248 };
  },
});
```

## Related guides

* [Define and run tools](https://phaseo.app/docs/v1/sdk-reference/typescript/agent-sdk-tools.md)
* [Work with typed items](https://phaseo.app/docs/v1/sdk-reference/typescript/agent-sdk-items.md)
* [Lifecycle hooks](https://phaseo.app/docs/v1/sdk-reference/typescript/agent-sdk-lifecycle-hooks.md)
* [Build a durable agent loop](https://phaseo.app/docs/v1/cookbook/agent-sdk-durable-loop.md)


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