List video translation requests

client.VideoTranslate.Requests.List(ctx, query) (*VideoTranslateRequestListResponse, error)

GET/v1/video-translate/requests

Returns the authenticated account’s requests, newest first (created_at descending, then id descending), always paginated. pagination.total counts every request matching the filters. Responses use the same shape as GET /v1/video-translate/requests/{id}.

ParametersExpand Collapse

query VideoTranslateRequestListParams

CreatedFrom param.Field[Time]Optional

Inclusive lower bound on created_at (RFC 3339). Must not be after created_to.

formatdate-time

CreatedTo param.Field[Time]Optional

Inclusive upper bound on created_at (RFC 3339).

formatdate-time

Limit param.Field[int64]Optional

Page size. Non-integers and values below 1 are rejected with 400; values above 100 are clamped to 100.

minimum1

maximum100

Offset param.Field[int64]Optional

Number of items to skip. Non-integers and negative values are rejected with 400.

minimum0

ReferenceID param.Field[string]Optional

Filter requests by exact reference_id.

SourceLanguage param.Field[string]Optional

Filter by the explicit or detected source language (supported language code).

Status param.Field[VideoTranslateRequestListParamsStatus]Optional

Filter by request status.

const VideoTranslateRequestListParamsStatusQueued VideoTranslateRequestListParamsStatus = "queued"

const VideoTranslateRequestListParamsStatusUploading VideoTranslateRequestListParamsStatus = "uploading"

const VideoTranslateRequestListParamsStatusProcessing VideoTranslateRequestListParamsStatus = "processing"

const VideoTranslateRequestListParamsStatusCompleted VideoTranslateRequestListParamsStatus = "completed"

const VideoTranslateRequestListParamsStatusFailed VideoTranslateRequestListParamsStatus = "failed"

TargetLanguage param.Field[string]Optional

Return requests whose target_languages contain this supported language code.

ReturnsExpand Collapse

type VideoTranslateRequestListResponse struct{…}

Data []VideoTranslateRequestListResponseData

ID string

formatuuid

Config VideoTranslateRequestListResponseDataConfig

The request config as returned by the API. SRT content is replaced by metadata, speaker_voices keys are canonical speaker IDs, and other keys are returned unchanged.

SourceSrt VideoTranslateRequestListResponseDataConfigSourceSrtOptional

Public description of a supplied SRT. The subtitle content is never returned.

Supplied VideoTranslateRequestListResponseDataConfigSourceSrtSupplied

FileName stringOptional

Language stringOptional

SpeakerVoices map[string, string]Optional

TargetSrts map[string, VideoTranslateRequestListResponseDataConfigTargetSrt]Optional

Supplied VideoTranslateRequestListResponseDataConfigTargetSrtsSupplied

FileName stringOptional

Language stringOptional

TtsModel VideoTranslateRequestListResponseDataConfigTtsModelOptional

The explicitly selected text-to-speech model. Omitted when the request used the default.

One of the following:

const VideoTranslateRequestListResponseDataConfigTtsModelElevenV4 VideoTranslateRequestListResponseDataConfigTtsModel = "eleven_v4"

const VideoTranslateRequestListResponseDataConfigTtsModelElevenMultilingualV2 VideoTranslateRequestListResponseDataConfigTtsModel = "eleven_multilingual_v2"

CreatedAt Time

formatdate-time

DisableBackgroundAudio bool

Whether background audio was disabled for this request.

DisableLipSync bool

Whether lip sync was disabled for this request.

Formality bool

Model VideoTranslateRequestListResponseDataModel

Product speech model selected for the request.

One of the following:

const VideoTranslateRequestListResponseDataModelExpressive VideoTranslateRequestListResponseDataModel = "expressive"

const VideoTranslateRequestListResponseDataModelClassic VideoTranslateRequestListResponseDataModel = "classic"

Status VideoTranslateRequestListResponseDataStatus

One of the following:

const VideoTranslateRequestListResponseDataStatusQueued VideoTranslateRequestListResponseDataStatus = "queued"

const VideoTranslateRequestListResponseDataStatusUploading VideoTranslateRequestListResponseDataStatus = "uploading"

const VideoTranslateRequestListResponseDataStatusProcessing VideoTranslateRequestListResponseDataStatus = "processing"

const VideoTranslateRequestListResponseDataStatusCompleted VideoTranslateRequestListResponseDataStatus = "completed"

const VideoTranslateRequestListResponseDataStatusFailed VideoTranslateRequestListResponseDataStatus = "failed"

TargetLanguages []string

ErrorMessage stringOptional

Present only when failed. A safe, bounded description, for example SRT or speaker validation errors found after the video was processed.

maxLength1001

FinishedAt TimeOptional

formatdate-time

Outputs map[string, VideoTranslateRequestListResponseDataOutput]Optional

Present only when completed, keyed by requested target language. URLs are signed on every read.

Audio string

formaturi

Srt string

formaturi

Video string

formaturi

ReferenceID stringOptional

SourceLanguage stringOptional

Explicit source language, or the detected one once processing starts.

StartedAt TimeOptional

formatdate-time

WebhookURL stringOptional

The configured terminal callback URL, when supplied.

formaturi

Pagination VideoTranslateRequestListResponsePagination

Limit int64

Applied page size.

minimum1

Offset int64

Applied result offset.

minimum0

Total int64

Total number of matching records.

minimum0

List video translation requests

package main

import (
  "context"
  "fmt"

  "github.com/chamelaion/chamelaion-go/v2"
  "github.com/chamelaion/chamelaion-go/v2/option"
)

func main() {
  client := githubcomchamelaionchamelaiongo.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  requests, err := client.VideoTranslate.Requests.List(context.TODO(), githubcomchamelaionchamelaiongo.VideoTranslateRequestListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", requests.Data)
}

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config": {
        "source_srt": {
          "supplied": true,
          "file_name": "file_name",
          "language": "language"
        },
        "speaker_voices": {
          "foo": "string"
        },
        "target_srts": {
          "foo": {
            "supplied": true,
            "file_name": "file_name",
            "language": "language"
          }
        },
        "tts_model": "eleven_v4"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "disable_background_audio": true,
      "disable_lip_sync": true,
      "formality": true,
      "model": "expressive",
      "status": "queued",
      "target_languages": [
        "string"
      ],
      "error_message": "error_message",
      "finished_at": "2019-12-27T18:11:19.117Z",
      "outputs": {
        "foo": {
          "audio": "https://example.com",
          "srt": "https://example.com",
          "video": "https://example.com"
        }
      },
      "reference_id": "reference_id",
      "source_language": "source_language",
      "started_at": "2019-12-27T18:11:19.117Z",
      "webhook_url": "https://example.com"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 0,
    "total": 0
  }
}

{
  "error": "limit must be an integer between 1 and 100"
}

{
  "error": "status must be one of queued, uploading, processing, completed, failed"
}

{
  "error": "created_from must not be after created_to"
}

{
  "error": "missing authorization header"
}

{
  "error": "invalid authorization format"
}

{
  "error": "missing token"
}

{
  "error": "invalid token"
}

{
  "error": "unauthorized"
}

{
  "error": "rate limit exceeded"
}

{
  "error": "internal error"
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config": {
        "source_srt": {
          "supplied": true,
          "file_name": "file_name",
          "language": "language"
        },
        "speaker_voices": {
          "foo": "string"
        },
        "target_srts": {
          "foo": {
            "supplied": true,
            "file_name": "file_name",
            "language": "language"
          }
        },
        "tts_model": "eleven_v4"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "disable_background_audio": true,
      "disable_lip_sync": true,
      "formality": true,
      "model": "expressive",
      "status": "queued",
      "target_languages": [
        "string"
      ],
      "error_message": "error_message",
      "finished_at": "2019-12-27T18:11:19.117Z",
      "outputs": {
        "foo": {
          "audio": "https://example.com",
          "srt": "https://example.com",
          "video": "https://example.com"
        }
      },
      "reference_id": "reference_id",
      "source_language": "source_language",
      "started_at": "2019-12-27T18:11:19.117Z",
      "webhook_url": "https://example.com"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 0,
    "total": 0
  }
}

{
  "error": "limit must be an integer between 1 and 100"
}

{
  "error": "status must be one of queued, uploading, processing, completed, failed"
}

{
  "error": "created_from must not be after created_to"
}

{
  "error": "missing authorization header"
}

{
  "error": "invalid authorization format"
}

{
  "error": "missing token"
}

{
  "error": "invalid token"
}

{
  "error": "unauthorized"
}

{
  "error": "rate limit exceeded"
}

{
  "error": "internal error"
}