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

# TypeScript SDK Installation

> How to install and set up the Phaseo TypeScript SDK

The SDK is published as [`@phaseo/sdk`](https://www.npmjs.com/package/@phaseo/sdk) on npm.

## Installation

Install the SDK using your preferred package manager:

```bash title="npm" theme={null}
npm install @phaseo/sdk
```

```bash title="pnpm" theme={null}
pnpm add @phaseo/sdk
```

```bash title="yarn" theme={null}
yarn add @phaseo/sdk
```

## Requirements

* Node.js 18+
* TypeScript 4.5+ (for type definitions)

## Setup

### API Key

You'll need a Phaseo API key to use the SDK. Create one with `phaseo keys create` in the [Phaseo CLI](https://phaseo.app/docs/v1/guides/integrations/phaseo-cli.md) or in [Gateway Keys](https://phaseo.app/settings/keys).

### Environment Variables

Set your API key as an environment variable:

```bash theme={null}
export PHASEO_API_KEY="phaseo_v1_sk_<kid>_<secret>"
```

### Basic Usage

```typescript theme={null}
import Phaseo from "@phaseo/sdk";

// Initialize the client
const client = new Phaseo({
	apiKey: process.env.PHASEO_API_KEY!,
});

// Make your first request
const response = await client.generateText({
	model: "openai/gpt-4o-mini",
	messages: [{ role: "user", content: "Hello!" }],
});

console.log(response.choices[0].message.content);
```

## Next Steps

* Check out the [Usage Guide](https://phaseo.app/docs/v1/sdk-reference/typescript/usage.md) for detailed examples
* View the [API Reference](https://phaseo.app/docs/v1/api-reference/introduction.md) for endpoint documentation


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