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

# Install a client SDK

> Install a Phaseo client SDK, set your API key and send a first request.

Add the Phaseo package for your language, set `PHASEO_API_KEY`, and send your first request. The [overview](https://phaseo.app/docs/v1/sdk-reference/client/overview.md) lists each package's registry and published version.

**1. Install the package**

> [tab] TypeScript
>
> ```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
> ```
>
> You need Node.js 18 or later, and TypeScript 4.5 or later for the type definitions.

> [tab] Python
>
> ```bash title="pip" theme={null}
> pip install phaseo
> ```
>
> ```bash title="uv" theme={null}
> uv add phaseo
> ```
>
> You need Python 3.10 or later. For [realtime voice](https://phaseo.app/docs/v1/sdk-reference/client/audio-realtime.md), install the extra: `pip install "phaseo[realtime]"`.

> [tab] Go
>
> ```bash theme={null}
> go get github.com/phaseoteam/Phaseo/packages/sdk/sdk-go/v3@latest
> ```
>
> You need Go 1.23 or later. Import the `v3` module path:
>
> ```go theme={null}
> import phaseo "github.com/phaseoteam/Phaseo/packages/sdk/sdk-go/v3"
> ```

> [tab] C#
>
> ```bash theme={null}
> dotnet add package Phaseo.Sdk
> ```
>
> You need .NET 8 or later. The client is in the `PhaseoSdk` namespace.

> [tab] PHP
>
> ```bash theme={null}
> composer require phaseo/sdk
> ```
>
> You need PHP 8.1 or later and Composer. Composer also installs Guzzle 7. The client class is `Phaseo\Sdk\Phaseo`.

> [tab] Ruby
>
> ```bash title="gem" theme={null}
> gem install phaseo_sdk
> ```
>
> ```ruby title="Gemfile" theme={null}
> gem "phaseo_sdk"
> ```
>
> You need Ruby 3.0 or later. Load it with `require 'phaseo_sdk'`; the client is `PhaseoSdk::Phaseo`.

> [tab] Java
>
> The `3.0.0` artifact on [Maven Central](https://repo.maven.apache.org/maven2/app/phaseo/phaseo-sdk/3.0.0/) has the older API, without the current retry, response metadata and parameter-checking APIs. To use the current SDK, build the pinned source. You need Java 17 or later, Maven 3.8 or later, and Git.
>
> ```bash theme={null}
> git clone https://github.com/phaseoteam/Phaseo.git
> cd Phaseo
> git checkout 1ff1119f41ceb3ac2c85ed605f6e1c4beca6e011
> mvn -f packages/sdk/sdk-java/pom.xml -DskipTests install
> ```
>
> Maven installs `app.phaseo:phaseo-sdk:3.0.0` in your local repository, including its Jackson dependency. Then add the dependency:
>
> ```xml theme={null}
> <dependency>
>   <groupId>app.phaseo</groupId>
>   <artifactId>phaseo-sdk</artifactId>
>   <version>3.0.0</version>
> </dependency>
> ```

> [tab] Rust
>
> ```toml title="Cargo.toml" theme={null}
> [dependencies]
> phaseo = "0.2"
> serde_json = "1"
> ```
>
> ```bash title="cargo" theme={null}
> cargo add phaseo@0.2 serde_json
> ```
>
> You need Rust 1.86 or later. The crate is pre-`1.0`, and its API can still change between minor versions, so pin a compatible minor version in production.

**2. Set your API key**

Create a key with `phaseo keys create` in the [Phaseo CLI](https://phaseo.app/docs/v1/guides/integrations/phaseo-cli.md) or in [API Keys](https://phaseo.app/settings/keys), then export it:

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

```powershell title="PowerShell" theme={null}
$env:PHASEO_API_KEY = "phaseo_v1_sk_<kid>_<secret>"
```

Keep the key on your server. Don't compile it into a desktop, mobile, browser, or other distributed client.

**3. Send a request**

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

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

const response = await client.generateText({
  model: "openai/gpt-6-astra",
  messages: [{ role: "user", content: "Hello!" }],
});

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

```python Python theme={null}
from phaseo import Phaseo
import os

client = Phaseo(api_key=os.environ["PHASEO_API_KEY"])

response = client.generate_text(
    {
        "model": "openai/gpt-6-astra",
        "messages": [{"role": "user", "content": "Hello!"}],
    }
)

print(response["choices"][0]["message"]["content"])
```

```go Go theme={null}
client, err := phaseo.NewFromEnv() // reads PHASEO_API_KEY
if err != nil {
  panic(err)
}

chat, err := client.GenerateText(context.Background(), phaseo.ChatCompletionsRequest{
  Model:    "openai/gpt-6-astra",
  Messages: []map[string]interface{}{{"role": "user", "content": "Hello!"}},
})
if err != nil {
  panic(err)
}
fmt.Println(chat["choices"])
```

```csharp C# theme={null}
using PhaseoSdk;

var client = new Phaseo(); // reads PHASEO_API_KEY

var chat = await client.GenerateText(new Dictionary<string, object>
{
    ["model"] = "openai/gpt-6-astra",
    ["messages"] = new[]
    {
        new Dictionary<string, object> { ["role"] = "user", ["content"] = "Hello!" },
    },
});
```

```php PHP theme={null}
<?php
require 'vendor/autoload.php';

use Phaseo\Sdk\Phaseo;

$client = new Phaseo(); // reads PHASEO_API_KEY

$chat = $client->generateText([
    'model' => 'openai/gpt-6-astra',
    'messages' => [['role' => 'user', 'content' => 'Hello!']],
]);

echo $chat['choices'][0]['message']['content'];
```

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

client = PhaseoSdk::Phaseo.new # reads PHASEO_API_KEY

chat = client.generate_text(
  model: 'openai/gpt-6-astra',
  messages: [{ role: 'user', content: 'Hello!' }]
)
```

```java Java theme={null}
import app.phaseo.sdk.Phaseo;
import java.util.List;
import java.util.Map;

Phaseo client = new Phaseo(System.getenv("PHASEO_API_KEY"));

var chat = client.createChatCompletion(Map.of(
    "model", "openai/gpt-6-astra",
    "messages", List.of(Map.of("role", "user", "content", "Hello!"))
));
System.out.println(chat.path("choices").path(0).path("message").path("content").asText());
```

```rust Rust theme={null}
use phaseo::Phaseo;
use serde_json::json;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Phaseo::from_env()?;
    let response = client.chat_completions(&json!({
        "model": "openai/gpt-6-astra",
        "messages": [{ "role": "user", "content": "Hello!" }]
    }))?;

    println!("{}", response.body);
    Ok(())
}
```

If you don't pass a key, the client reads `PHASEO_API_KEY` itself.

## Point the client at another base URL

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

const client = new Phaseo({
  apiKey: "your-api-key",
  baseUrl: "https://api.phaseo.app/v1",
  timeoutMs: 30_000,
});
```

```python Python theme={null}
from phaseo import Phaseo

client = Phaseo(
    api_key="your-api-key",
    base_url="https://api.phaseo.app/v1",
    timeout=30.0,
)
```

```go Go theme={null}
client := phaseo.New(os.Getenv("PHASEO_API_KEY"), "https://api.phaseo.app/v1")
```

```rust Rust theme={null}
let client = Phaseo::from_env()?.with_base_url("http://localhost:8787/v1")?;
```

The timeout is in milliseconds in TypeScript (`timeoutMs`) and in seconds in Python (`timeout`). In Rust, you can also set `PHASEO_BASE_URL` (for example `http://localhost:8787/v1`) for `Phaseo::from_env()` to pick up. Rust accepts plain HTTP only when the host is exactly `localhost` or a loopback IP address; remote endpoints must use HTTPS.

The [overview](https://phaseo.app/docs/v1/sdk-reference/client/overview.md#configure-the-client) lists every option per language. Next, see [Usage](https://phaseo.app/docs/v1/sdk-reference/client/usage.md) for one example per endpoint, or the [API Reference](https://phaseo.app/docs/v1/api-reference/introduction.md) for every field.


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