ElevenLabs
Canonical tools, triggers, auth, schemas, and mock behavior for ElevenLabs.
Run a valid elevenlabs.synthesize_speech call through the same SDK surface used by every toolkit.
Minimal tool call
import { Eyeball } from "@eyeball/sdk";
const eyeball = new Eyeball({
apiKey: process.env.EYEBALL_API_KEY!,
baseUrl: process.env.EYEBALL_EXECUTOR_URL!,
});
const output = await eyeball.tools.run(
"elevenlabs.synthesize_speech",
{
"text": "example_text",
"voiceId": "example_voiceId",
"audioFormat": "mp3"
},
{ userId: "demo_user" },
);
console.log(output);The model receives canonical output. Your application retains the execution envelope through tools.execute or the execution APIs when it needs IDs, status, versions, and latency.
Supported canonical tools
| Tool | Purpose | Execution | Effect | Version |
|---|---|---|---|---|
elevenlabs.synthesize_speech | Convert text to speech using a selected voice. Mock mode returns a deterministic audio_ref string instead of audio bytes. | sync or async | read | 1.0.0 |
Only the rows above are implemented. A capability tool omitted by this manifest returns not_supported; eyeball never synthesizes provider parity.
Supported canonical triggers
This manifest does not implement a canonical trigger.
Input and output schemas
elevenlabs.synthesize_speech
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:voice_telephony:synthesize_speech:1.0.0:elevenlabs",
"type": "object",
"description": "Text, voice, and optional synthesis controls.",
"additionalProperties": false,
"required": [
"text",
"voiceId"
],
"properties": {
"text": {
"type": "string",
"description": "Text to synthesize.",
"minLength": 1
},
"voiceId": {
"type": "string",
"description": "Provider voice identifier.",
"minLength": 1
},
"modelId": {
"type": "string",
"description": "Optional provider speech model identifier.",
"minLength": 1
},
"audioFormat": {
"type": "string",
"description": "Requested audio serialization.",
"enum": [
"mp3",
"wav",
"pcm",
"ulaw"
],
"default": "mp3"
},
"stability": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"similarityBoost": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:voice_telephony:synthesize_speech:output:1.0.0:elevenlabs",
"type": "object",
"description": "Reference to synthesized audio and billable character count.",
"additionalProperties": false,
"required": [
"audioRef",
"characters",
"audioFormat"
],
"properties": {
"audioRef": {
"type": "string",
"description": "Opaque audio reference; fixture:tts:* identifies deterministic mock audio.",
"minLength": 1
},
"characters": {
"type": "integer",
"description": "Unicode character count synthesized.",
"minimum": 0
},
"audioFormat": {
"type": "string",
"enum": [
"mp3",
"wav",
"pcm",
"ulaw"
]
}
}
}Authentication
| Property | Value |
|---|---|
| Auth class | api_key |
| Required scopes | None |
| Optional scopes | None |
| Credential fields | apiKey |
Credentials are resolved inside the executor by CredentialProvider. They never belong in tool input, x_provider, model context, logs, or execution output.
Provider-specific extensions
This manifest declares no provider-specific schema extensions. Use only canonical fields.
Provider differences may appear only under x_provider.elevenlabs and only when the schema above declares them.
Sync and async behavior
All tools are synchronous by nature, but callers may choose mode: "async" to queue them.
Mutations require a stable Idempotency-Key. The TypeScript SDK accepts it as idempotencyKey; it is never part of the JSON request body.
REST example
curl "$EYEBALL_EXECUTOR_URL/v1/execute" \
-H "Authorization: Bearer $EYEBALL_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"tool":"elevenlabs.synthesize_speech","userId":"demo_user","input":{"text":"example_text","voiceId":"example_voiceId","audioFormat":"mp3"},"mode":"sync"}'Mock support
Point EYEBALL_EXECUTOR_URL at a mock-configured executor to run through the real catalog, validation, credential seam, adapter, normalized errors, and execution records with no ElevenLabs account. Mock selection changes the executor endpoint and trusted provider base-URL configuration, never the execute request.
Limitations
- This page describes the manifest's explicit P0 subset, not every operation offered by the provider.
- Provider account policy, consent UI, quota details, and current wire compatibility still require a real-provider certification pass.
- Fields outside the canonical schemas and declared
x_providerextensions are rejected.
Versions
| Contract | Version |
|---|---|
| Runtime catalog | 1.1 |
| Manifest catalog | 1.0 |
| Manifest schema | 1.0 |
| Source | native |
| Tier | P0 |
| Capabilities | voice_telephony |
Next
Use Testing with mocks to exercise this toolkit before connecting a live provider account.