beatra文档

从文本生成音效

Creates an asynchronous sound-effects generation task (`elevenlabs-sfx-v3` or `auto`, 0.5 to 30 seconds). Charged per requested audio second (rounded up) or 5 seconds when `duration_seconds` is omitted. When the task succeeds, `output` contains `{type: "sound_effects", model, loop, audio: {url, artifact_id, duration_seconds, mime_type, size_bytes}}`.

下方的接口说明（参数、请求和响应）是英文原文，字段名与接口完全一致。

POST
/v1/audio/sound-effects

Request Body

application/jsonRequired
metadataMetadata

Caller-supplied metadata; ≤16 keys, key ≤64 chars, value ≤512 chars

callback_urlCallback Url

HTTPS URL Beatra will POST the final Task envelope to when the Task reaches a terminal state

callback_signing_key_idCallback Signing Key Id

Optional standalone callback signing key. Omit for unsigned callback delivery; requires callback_url when provided.

prompt
Required
Prompt

Text description of the sound effect or ambient audio to generate (1-2000 characters).

Minimum length: 1Maximum length: 2000
modelModel

Sound-effects model identifier, or 'auto' for automatic selection.

Default: "auto"Value in: "auto" | "elevenlabs-sfx-v3"
duration_secondsDuration Seconds

Target duration in seconds (0.5-30.0). Omit to let the model choose duration automatically.

loopLoop

When true, generate a seamlessly looping sound effect or ambient bed.

Default: false
prompt_influencePrompt Influence

How strictly generation follows the prompt (0.0-1.0, default 0.3).

Default: 0.3Minimum: 0Maximum: 1
formatFormat

Output audio container/encoding format.

Default: "mp3"Value in: "mp3" | "wav" | "opus" | "pcm"
model_optionsModel Options

Optional model-family-specific options (for example, {"elevenlabs": {...}}). Unrecognized keys emit an option_ignored warning.

Header Parameters

X-Request-Idstring

Optional client request id echoed in the response.

Idempotency-Key
Required
Idempotency-Key
Minimum length: 1Maximum length: 128
Authorization
Required
string

Bearer API key.

curl -X POST "https://api.beatra.cn/v1/audio/sound-effects" \
  -H "X-Request-Id: string" \
  -H "Idempotency-Key: string" \
  -H "Authorization: string" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "callback_url": "string",
    "callback_signing_key_id": "string",
    "prompt": "string",
    "model": "auto",
    "duration_seconds": 0.5,
    "loop": false,
    "prompt_influence": 0.3,
    "format": "mp3",
    "model_options": {}
  }'

Task accepted

{
  "object": "task",
  "task_id": "string",
  "status": "queued",
  "capability": "string",
  "workload_type": "model",
  "model": "string",
  "resolved_model": "string",
  "model_selection_reason": null,
  "social": {
    "platform": "string",
    "operation_key": "string",
    "operation_name": "string",
    "schema_hash": "string"
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "input": {},
  "progress": {
    "percent": 100,
    "stage": "string",
    "message": "string"
  },
  "output": {},
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "field": "string"
    }
  ],
  "error": {
    "code": "string",
    "type": "string",
    "message": "string",
    "retryable": true,
    "param": "string",
    "details": {},
    "request_id": "string"
  },
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "cache_read_tokens": 0,
    "cache_creation_tokens": 0,
    "reasoning_tokens": 0,
    "image_count": 0,
    "image_pixels": 0,
    "video_seconds": 0,
    "input_video_seconds": 0,
    "output_video_seconds": 0,
    "audio_seconds": 0,
    "characters": 0,
    "lines": [
      {
        "meter": "string",
        "quantity": "string",
        "unit": "string",
        "billed_amount_credits": "string"
      }
    ],
    "credits": "string"
  },
  "billing": {
    "charged_credits": "string",
    "refunded_credits": "string",
    "granted_credits": "string",
    "grant_source": "string",
    "net_charged_credits": "string"
  },
  "callback": {
    "url": "string",
    "status": "pending",
    "attempt_count": 0,
    "delivered_at": "2019-08-24T14:15:22Z",
    "last_error": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "deadline_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "cancel_requested_at": "2019-08-24T14:15:22Z",
  "links": {
    "self": "string",
    "cancel": "string",
    "assets": "string"
  }
}

最后更新