Vista previa de la API pública Cloud
La API Cloud para desarrolladores aún no publicada, con Artifacts de entrada y Jobs duraderos de salida.
La API Cloud no se ha publicado
Esta es una vista previa del contrato, no un destino para tráfico de producción. El documento OpenAPI no tiene servidor y los ejemplos usan el marcador $VOICESTUDIO_CLOUD_ORIGIN.
| Procedencia | Valor |
|---|---|
| Producto | API pública para desarrolladores de VoiceStudio Cloud |
| Público | Solo credenciales públicas de desarrollador |
| Versión del contrato | 1.0.0 |
| Versión del contrato generado | 1.0.0 |
| Repositorio de origen | debpalash/vssaas |
| Commit de origen | c48c41f8fe5bb4496a9d218c513fd91fe827c0b5 |
| Proyección pública sin procesar | /cloud-openapi.json |
Contiene 34 operaciones para desarrolladores. Se excluyen las operaciones del panel, de operadores e internas, así como sus esquemas exclusivos.
Cómo se ejecuta el trabajo
El trabajo Cloud no es una llamada directa. Las entradas se convierten en Artifacts inmutables; una solicitud autenticada admite un Job duradero y devuelve respuesta de inmediato. Cada mutación requiere una Idempotency-Key creada por el cliente: la misma clave y cuerpo devuelven el mismo resultado; un cuerpo distinto produce conflicto.
Vista previa no ejecutable. No indica un host de producción:
export VOICESTUDIO_CLOUD_ORIGIN="https://unreleased.invalid"
export VOICESTUDIO_API_KEY="vs_preview_only"
# 1. Ask to upload the exact text bytes.
curl "$VOICESTUDIO_CLOUD_ORIGIN/v1/artifacts/upload-authorizations" \
-H "Authorization: Bearer $VOICESTUDIO_API_KEY" \
-H "Idempotency-Key: 018f-example-upload-key" \
-H "Content-Type: application/json" \
-d '{
"project_id": "replace-with-project-id",
"purpose": "tts_text",
"media_type": "text/plain; charset=utf-8",
"size_bytes": 24,
"sha256": "replace-with-64-lowercase-hex-characters"
}'
# 2. PUT the bytes to the returned short-lived URL, then complete the Artifact.
curl "$VOICESTUDIO_CLOUD_ORIGIN/v1/artifacts/ARTIFACT_ID/complete" \
-H "Authorization: Bearer $VOICESTUDIO_API_KEY" \
-H "Idempotency-Key: 018f-example-complete-key" \
-H "Content-Type: application/json" \
-d '{ "size_bytes": 24, "sha256": "replace-with-64-lowercase-hex-characters" }'
# 3. Admit a Job. Success is 202 Accepted, not audio.
curl "$VOICESTUDIO_CLOUD_ORIGIN/v1/jobs" \
-H "Authorization: Bearer $VOICESTUDIO_API_KEY" \
-H "Idempotency-Key: 018f-example-job-key" \
-H "Content-Type: application/json" \
-d '{
"project_id": "replace-with-project-id",
"workflow": "tts",
"model": { "id": "replace-with-model-id", "version": "replace-with-version" },
"input": { "text_artifact_id": "replace-with-artifact-id" },
"configuration": { "voice_id": "replace-with-voice-id", "output_format": "wav" }
}'El cuerpo 202 Accepted contiene la identidad y el estado del Job. Consulta GET /v1/jobs/{job_id} o reanuda GET /v1/jobs/{job_id}/events y obtiene la salida mediante una autorización de descarga de Artifact. El acceso siempre depende de la credencial y la pertenencia al tenant; un ID en la solicitud nunca lo concede.
Esquemas exactos: referencia de la API Cloud.