VoiceStudioDocs
Cloud reference

Artifacts

POST
/v1/artifacts/upload-authorizations

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string
Length16 <= length <= 128

Request Body

application/json

project_id*OpaqueId

Exactly 16 cryptographically random Base62 characters.

Match^[A-Za-z0-9]{16}$
Length16 <= length <= 16
purpose*string

Value in

  • "tts_text"
  • "job_input"
  • "reference_audio"
  • "source_media"
  • "subtitle"
  • "cover_image"
  • "document_import"
media_type*string
Lengthlength <= 128
size_bytes*integer
Range1 <= value
sha256*string
Match^[a-f0-9]{64}$
declared_duration_seconds?integer

Required for audio when the server cannot measure a trustworthy container duration, and for Dubbing source_media video so audio-second work can reserve against its bounded timeline.

Range1 <= value <= 14400
retention_policy?string
Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X POST "https://example.com/v1/artifacts/upload-authorizations" \
  -H "Idempotency-Key: stringstringstri" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "stringstringstri",
    "purpose": "tts_text",
    "media_type": "string",
    "size_bytes": 1,
    "sha256": "string"
  }'
json
{
  "artifact_id": "stringstringstri",
  "method": "PUT",
  "url": "http://example.com",
  "required_headers": {
    "property1": "string",
    "property2": "string"
  },
  "expires_at": "2019-08-24T14:15:22Z"
}
POST
/v1/artifacts/{artifact_id}/complete

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Path Parameters

artifact_id*string

Exactly 16 cryptographically random Base62 characters.

Match^[A-Za-z0-9]{16}$
Length16 <= length <= 16

Header Parameters

Idempotency-Key*string
Length16 <= length <= 128

Request Body

application/json

size_bytes*integer
Range1 <= value
sha256*string
Match^[a-f0-9]{64}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X POST "https://example.com/v1/artifacts/stringstringstri/complete" \
  -H "Idempotency-Key: stringstringstri" \
  -H "Content-Type: application/json" \
  -d '{
    "size_bytes": 1,
    "sha256": "string"
  }'
json
{
  "id": "stringstringstri",
  "project_id": "stringstringstri",
  "purpose": "string",
  "state": "pending",
  "media_type": "string",
  "size_bytes": 0,
  "sha256": "string",
  "duration_ms": 0,
  "created_at": "2019-08-24T14:15:22Z"
}
POST
/v1/artifacts/{artifact_id}/download-authorization

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Path Parameters

artifact_id*string

Exactly 16 cryptographically random Base62 characters.

Match^[A-Za-z0-9]{16}$
Length16 <= length <= 16

Header Parameters

Idempotency-Key*string
Length16 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

bash
curl -X POST "https://example.com/v1/artifacts/stringstringstri/download-authorization" \
  -H "Idempotency-Key: stringstringstri"
json
{
  "method": "GET",
  "url": "http://example.com",
  "expires_at": "2019-08-24T14:15:22Z"
}