Cloud genel API önizlemesi
Girdi olarak Artifact'ler ve çıktı olarak kalıcı Job'lar kullanan, henüz yayımlanmamış Cloud geliştirici API'si.
Cloud API yayımlanmadı
Bu bir sözleşme önizlemesidir, üretim trafiği gönderilecek bir yer değildir. OpenAPI belgesinde sunucu yoktur ve örneklerde $VOICESTUDIO_CLOUD_ORIGIN yer tutucusu kullanılır.
| Kaynak bilgisi | Değer |
|---|---|
| Ürün | VoiceStudio Cloud genel geliştirici API'si |
| Hedef kitle | Yalnızca genel geliştirici kimlik bilgileri |
| Sözleşme sürümü | 1.0.0 |
| Oluşturulan sözleşme sürümü | 1.0.0 |
| Kaynak deposu | debpalash/vssaas |
| Kaynak commit’i | c48c41f8fe5bb4496a9d218c513fd91fe827c0b5 |
| Ham genel projeksiyon | /cloud-openapi.json |
34 geliştirici işlemi içerir. Pano, operatör ve dahili işlemler ile yalnızca onların kullandığı şemalar hariçtir.
İş nasıl çalışır
Cloud işi doğrudan çağrı değildir. Girdiler değişmez Artifact'lere dönüşür, ardından kimliği doğrulanmış istek kalıcı bir Job kabul eder ve hemen döner. Her değişiklik çağıranın oluşturduğu bir Idempotency-Key alır: aynı anahtar ve gövde aynı sonucu verir, değiştirilmiş gövde çakışma oluşturur.
Çalıştırılamayan önizleme. Üretim sunucusu belirtmez:
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" }
}'202 Accepted gövdesi Job kimliğini ve durumunu taşır. GET /v1/jobs/{job_id} sorgulayın veya GET /v1/jobs/{job_id}/events akışını sürdürün, ardından Artifact indirme yetkisiyle çıktıyı alın. Erişim her zaman kimlik bilgisi ve tenant üyeliğinden gelir; istekteki bir ID asla erişim vermez.
Kesin şemalar: Cloud API başvurusu.