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

# Instalação do Agent SDK

> Instale o Agent SDK da Phaseo e defina a chave de API que o cliente de gateway dele usa.

Instale o pacote do Agent SDK da sua linguagem, defina `PHASEO_API_KEY` e crie um primeiro agente em [Uso](https://phaseo.app/docs/pt-BR/v1/sdk-reference/agent/usage.md). Cada pacote traz como dependência o cliente principal da Phaseo da sua linguagem.

**1. Instale o pacote**

> [tab] TypeScript
>
> Instale [`@phaseo/agent-sdk`](https://www.npmjs.com/package/@phaseo/agent-sdk) 0.3.0 em um projeto TypeScript ou JavaScript. O `@phaseo/sdk` vem junto.
>
> ```bash npm theme={null}
> npm install @phaseo/agent-sdk
> ```
>
> ```bash pnpm theme={null}
> pnpm add @phaseo/agent-sdk
> ```
>
> ```bash yarn theme={null}
> yarn add @phaseo/agent-sdk
> ```
>
> ```bash bun theme={null}
> bun add @phaseo/agent-sdk
> ```

> [tab] Python
>
> Instale [`phaseo-agent-sdk`](https://pypi.org/project/phaseo-agent-sdk/) 0.3.0 em um ambiente com Python 3.10 ou mais recente. O cliente principal `phaseo` (3.x) vem junto, e o pacote é instalado como o módulo `phaseo_agent`.
>
> ```bash pip theme={null}
> pip install phaseo-agent-sdk
> ```
>
> ```bash uv theme={null}
> uv add phaseo-agent-sdk
> ```

> [tab] Go
>
> Adicione [`agent-sdk-go`](https://pkg.go.dev/github.com/phaseoteam/Phaseo/packages/sdk/agent-sdk-go) `v0.3.0` com Go 1.24 ou mais recente. O Go adiciona o cliente principal, `github.com/phaseoteam/Phaseo/packages/sdk/sdk-go/v3`, como dependência.
>
> ```bash theme={null}
> go get github.com/phaseoteam/Phaseo/packages/sdk/agent-sdk-go@latest
> ```
>
> Importe o pacote do agente como `phaseoagent`:
>
> ```go theme={null}
> import phaseoagent "github.com/phaseoteam/Phaseo/packages/sdk/agent-sdk-go"
> ```

> [tab] C#
>
> Adicione [`Phaseo.AgentSdk`](https://www.nuget.org/packages/Phaseo.AgentSdk) 0.3.0 pelo NuGet. Você precisa do .NET 8 ou mais recente. O NuGet adiciona `Phaseo.Sdk` como dependência.
>
> ```bash theme={null}
> dotnet add package Phaseo.AgentSdk
> ```
>
> Os tipos do agente ficam no namespace `PhaseoAgentSdk`:
>
> ```csharp theme={null}
> using PhaseoAgentSdk;
> ```

> [tab] PHP
>
> Adicione [`phaseo/agent-sdk`](https://packagist.org/packages/phaseo/agent-sdk) `v0.3.0` com o Composer. Você precisa do PHP 8.1 ou mais recente. O Composer adiciona `phaseo/sdk` (`^3.0.0`) como dependência.
>
> ```bash theme={null}
> composer require phaseo/agent-sdk
> ```
>
> As classes do agente ficam no namespace `Phaseo\AgentSdk`:
>
> ```php theme={null}
> use Phaseo\AgentSdk\AgentDefinition;
> use Phaseo\AgentSdk\AgentSdk;
> use Phaseo\AgentSdk\Tool;
> ```

> [tab] Ruby
>
> Adicione [`phaseo_agent_sdk`](https://rubygems.org/gems/phaseo_agent_sdk) 0.3.0 com o RubyGems ou o Bundler. Você precisa do Ruby 3.2 ou mais recente. O RubyGems adiciona `phaseo_sdk` (`>= 3.0.0, < 4.0.0`) como dependência.
>
> ```bash gem theme={null}
> gem install phaseo_agent_sdk
> ```
>
> ```ruby Gemfile theme={null}
> gem "phaseo_agent_sdk"
> ```
>
> Carregue o módulo do agente com:
>
> ```ruby theme={null}
> require "phaseo_agent_sdk"
> ```

> [tab] Java
>
> Adicione `app.phaseo:phaseo-agent-sdk` 0.3.0 pelo Maven Central. Você precisa do Java 17 ou mais recente. O build adiciona `app.phaseo:phaseo-sdk` 3.0.0 e o Jackson como dependências. Todos os tipos são records aninhados em `app.phaseo.agent.AgentSdk`.
>
> ```xml Maven theme={null}
> <dependency>
>   <groupId>app.phaseo</groupId>
>   <artifactId>phaseo-agent-sdk</artifactId>
>   <version>0.3.0</version>
> </dependency>
> ```
>
> ```kotlin Gradle theme={null}
> implementation("app.phaseo:phaseo-agent-sdk:0.3.0")
> ```
>
> Para compilar a partir do código-fonte:
>
> ```bash theme={null}
> git clone https://github.com/phaseoteam/Phaseo.git
> cd Phaseo
> mvn -f packages/sdk/agent-sdk-java/pom.xml package
> ```

> [tab] Rust
>
> Adicione [`phaseo-agent`](https://crates.io/crates/phaseo-agent) e o cliente `phaseo`, ambos na versão 0.2.0 no crates.io, com Rust 1.86 ou mais recente. Diferente das outras linguagens, você mesmo adiciona o cliente principal.
>
> ```toml Cargo.toml theme={null}
> [dependencies]
> phaseo = "0.2"
> phaseo-agent = "0.2"
> serde_json = "1"
> ```
>
> ```bash cargo theme={null}
> cargo add phaseo@0.2 phaseo-agent@0.2 serde_json
> ```

**2. Defina sua chave de API**

Crie uma chave em [Chaves de API](https://phaseo.app/settings/keys) e depois exporte-a:

```bash macOS and Linux theme={null}
export PHASEO_API_KEY="phaseo_v1_sk_..."
```

```powershell Windows theme={null}
$env:PHASEO_API_KEY = "phaseo_v1_sk_..."
```

A maioria dos clientes de gateway lê a chave do ambiente; o do Python não. TypeScript, Python e Java ignoram `PHASEO_BASE_URL`:

| Linguagem | Cliente de gateway | Lê `PHASEO_API_KEY` | Lê `PHASEO_BASE_URL` | Passe no código com |
| - | - | - | - | - |
| TypeScript | `createGatewayAgentClient()` | Sim | Não | `clientOptions.apiKey`, `clientOptions.baseUrl` |
| Python | `create_gateway_agent_client()` | Não; lança `ValueError` sem uma chave | Não | `client_options={"api_key": ...}` ou `client=Phaseo()` |
| Go | `CreateGatewayAgentClient(...)` | Sim, quando `APIKey` está vazio | Sim, quando `BaseURL` está vazio | `GatewayAgentClientOptions.APIKey`, `.BaseURL` |
| C# | `AgentSdk.CreateGatewayAgentClient()` | Sim | Sim | `apiKey`, `baseUrl` em `GatewayAgentClientOptions.ClientOptions` |
| PHP | `AgentSdk::createGatewayAgentClient()` | Sim | Sim | `api_key`, `base_url` em `GatewayAgentClientOptions::$clientOptions` |
| Ruby | `PhaseoAgentSdk.create_gateway_agent_client` | Sim | Sim | `api_key:`, `base_url:` |
| Java | `AgentSdk.createGatewayAgentClient()` | Sim | Não | `new AgentSdk.GatewayOptions(null, apiKey, baseUrl, null, null, null)` |
| Rust | `create_gateway_agent_client(model)`, `GatewayAgentClient::from_env(model)` | Sim | Sim, pelo cliente `phaseo` | `GatewayAgentClient::new(client, model)` |

A URL base padrão é `https://api.phaseo.app/v1`.

**3. Verifique a instalação**

Crie um agente sem chamar o modelo. Se isto compilar e rodar, o pacote está instalado:

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

createAgent({ id: "verification-agent", model: "openai/gpt-6-astra" });
console.log("Phaseo Agent SDK installed");
```

```python Python theme={null}
from phaseo_agent import create_agent

create_agent({"id": "verification-agent", "model": "openai/gpt-6-astra"})
print("Phaseo Agent SDK installed")
```

```go Go theme={null}
package main

import (
  "fmt"

  phaseoagent "github.com/phaseoteam/Phaseo/packages/sdk/agent-sdk-go"
)

func main() {
  phaseoagent.CreateAgent(phaseoagent.AgentDefinition{ID: "verification-agent", Model: "openai/gpt-6-astra"})
  fmt.Println("Phaseo Agent SDK installed")
}
```

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

AgentSdk.CreateAgent(new AgentDefinition { Id = "verification-agent", Model = "openai/gpt-6-astra" });
Console.WriteLine("Phaseo Agent SDK installed");
```

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

use Phaseo\AgentSdk\AgentDefinition;
use Phaseo\AgentSdk\AgentSdk;

AgentSdk::createAgent(new AgentDefinition(id: "verification-agent", model: "openai/gpt-6-astra"));
echo "Phaseo Agent SDK installed" . PHP_EOL;
```

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

PhaseoAgentSdk.create_agent(id: "verification-agent", model: "openai/gpt-6-astra")
puts "Phaseo Agent SDK installed"
```

```rust Rust theme={null}
use phaseo_agent::{create_agent, AgentDefinition};

fn main() {
    let _agent = create_agent(AgentDefinition::new(
        "verification-agent",
        "openai/gpt-6-astra",
    ));
    println!("Phaseo Rust Agent SDK installed");
}
```

O Java não tem forma curta: `AgentDefinition` é um record posicional, mostrado por completo em [Uso](https://phaseo.app/docs/pt-BR/v1/sdk-reference/agent/usage.md).


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