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

# TTS (تحويل النص إلى كلام)

> حوّل النص إلى صوت باستخدام POST /v1/audio/speech من أي حزمة Phaseo SDK.

أرسل نصًا إلى `POST /v1/audio/speech` لتحصل على الصوت المنطوق بالتنسيق الذي تطلبه. تستخدم الأمثلة `client` مُنشأً كما في [التثبيت](https://phaseo.app/docs/ar/v1/sdk-reference/client/installation.md).

```typescript TypeScript theme={null}
import { writeFile } from "node:fs/promises";

const audio = await client.generateSpeech({
  model: "openai/gpt-4o-mini-tts",
  input: "Hello world",
  voice: "alloy",
  format: "mp3",
});

await writeFile("hello.mp3", Buffer.from(await audio.arrayBuffer()));
```

```python Python theme={null}
audio = client.generate_speech({
    "model": "openai/gpt-4o-mini-tts",
    "input": "Hello world",
    "voice": "alloy",
    "format": "mp3",
})

with open("hello.mp3", "wb") as file:
    file.write(audio)
```

```go Go theme={null}
audio, err := client.CreateSpeech(context.Background(), map[string]interface{}{
  "model":  "openai/gpt-4o-mini-tts",
  "input":  "Hello world",
  "voice":  "alloy",
  "format": "mp3",
})
if err != nil {
  panic(err)
}
fmt.Printf("%T\n", audio) // تحقّق من النوع الفعلي قبل كتابته في ملف
```

```csharp C# theme={null}
var audio = await client.CreateSpeech(new Dictionary<string, object>
{
    ["model"] = "openai/gpt-4o-mini-tts",
    ["input"] = "Hello world",
    ["voice"] = "alloy",
    ["format"] = "mp3",
});
```

```php PHP theme={null}
$audio = $client->createSpeech([
    'model' => 'openai/gpt-4o-mini-tts',
    'input' => 'Hello world',
    'voice' => 'alloy',
    'format' => 'mp3',
]);
```

```ruby Ruby theme={null}
audio = client.generate_speech(
  model: 'openai/gpt-4o-mini-tts',
  input: 'Hello world',
  voice: 'alloy',
  format: 'mp3'
)
```

```java Java theme={null}
String body = """
{
  "model": "openai/gpt-4o-mini-tts",
  "input": "Hello world",
  "voice": "alloy",
  "format": "mp3"
}
""";

byte[] audio = client.rawClient().requestBytes("POST", "/audio/speech", null, null, body);
java.nio.file.Files.write(java.nio.file.Path.of("hello.mp3"), audio);
```

## الدالة في كل لغة

| اللغة | الدالة | القيمة المُعادة |
| - | - | - |
| TypeScript | `client.generateSpeech(request)` | كائن `Blob` |
| Python | `client.generate_speech(request)` أو `client.audio.speech.create(request)` | `bytes` |
| Go | `client.CreateSpeech(ctx, req)` | `interface{}`؛ تحقّق من النوع الفعلي قبل كتابته في ملف |
| C# | `client.CreateSpeech(request)` | `object?`؛ تحقّق من النوع الفعلي قبل كتابته في ملف |
| PHP | `$client->createSpeech($request)` | الصوت؛ تحقّق من نوع القيمة قبل كتابتها في ملف |
| Ruby | `client.generate_speech(...)`، والاسم البديل `create_speech` | الصوت؛ تحقّق من صنف القيمة قبل كتابتها في ملف |
| Java | لا توجد دالة للكلام. ترسل `client.rawClient().requestBytes("POST", "/audio/speech", ...)` جسم JSON | `byte[]` |

لا تتضمن Rust دالة للكلام، ودالتها المساعدة `post()` تحلّل الاستجابات بوصفها JSON، لذا لا يمكنها إعادة الصوت.

## المعاملات

أسماء الحقول في كل حزمة SDK هي حقول جسم JSON. استخدم `format`: تقبل الواجهة البرمجية أيضًا `response_format`، لكن نوع الطلب في TypeScript يرفضه.

| الحقل | ملاحظات |
| - | - |
| `model` | مطلوب. معرّف نموذج كلام. |
| `input` | مطلوب. النص المراد نطقه. يقبل معظم المزوّدين ما يصل إلى 4,096 حرفًا؛ وتسمح نماذج ElevenLabs بما بين 5,000 و40,000 حسب النموذج. |
| `voice` | اسم صوت بديل موحّد عبر المزوّدين (موصى به)، أو قيمة الصوت الخاصة بالمزوّد، أو كائن يحتوي على `id` أو `name`. إذا لم يكن الصوت صالحًا للمزوّد الذي وُجّه إليه الطلب، تعيد الواجهة البرمجية `400` مع `param: "voice"`. |
| `format` | `mp3` أو `wav` أو `ogg` أو `aac` أو `flac` أو `opus` أو `pcm`. |
| `speed` | سرعة التشغيل، من `0.25` إلى `4`. |
| `instructions` | إرشادات الأسلوب، حيث يدعمها النموذج. |
| `config` | إعدادات خاصة بالمزوّد؛ انظر أدناه. |
| `provider` | تفضيلات توجيه المزوّد. |

المخطط الكامل موجود في [مرجع Speech API](https://phaseo.app/docs/ar/v1/api-reference/endpoint/audio-speech.md).

## تعيين صوت خاص بالمزوّد

مرّر الصوت الدقيق الخاص بالمزوّد ضمن `config`. يعمل الكائن المتداخل نفسه في خريطة الطلب لكل حزمة SDK.

```typescript TypeScript theme={null}
// ElevenLabs: اختر معرّف صوت دقيقًا
await client.generateSpeech({
  model: "eleven-labs/eleven-v3",
  input: "Hello from ElevenLabs",
  voice: "rachel",
  config: {
    elevenlabs: {
      voice_id: "21m00Tcm4TlvDq8ikWAM",
    },
  },
});

// Google: اختر اسم صوت دقيقًا
await client.generateSpeech({
  model: "google/gemini-3.1-flash-tts-preview",
  input: "Hello from Gemini",
  voice: "kore",
  config: {
    google: {
      voice_name: "Kore",
    },
  },
});
```

```python Python theme={null}
# ElevenLabs: اختر معرّف صوت دقيقًا
client.generate_speech({
    "model": "eleven-labs/eleven-v3",
    "input": "Hello from ElevenLabs",
    "voice": "rachel",
    "config": {"elevenlabs": {"voice_id": "21m00Tcm4TlvDq8ikWAM"}},
})

# Google: اختر اسم صوت دقيقًا
client.generate_speech({
    "model": "google/gemini-3.1-flash-tts-preview",
    "input": "Hello from Gemini",
    "voice": "kore",
    "config": {"google": {"voice_name": "Kore"}},
})
```


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