Skip to main content
POST
List your saved subtitled video results. Use nextCursor as beforeHistoryId to retrieve older results.

Authentication and permissions

string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.
Required permissions: subtitles:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

integer
Integer value.Minimum: 1. Maximum: 100. Default: 30.
string
Text value.Minimum length: 1. Maximum length: 160. Pattern: ^[A-Za-z0-9_-]+$.
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. A paginated object containing actor-owned subtitled video history summaries and nextCursor.

Result fields

Operation notes

  • Requires a paid subscription and the action permission. The actor’s personal tool plan is rechecked at execution; saved tools and upload references belong to that actor, including when the credential is associated with a team.
  • A successful action uses one shared monthly API/MCP call. Beginner allows 500, Starter 5,000 and Creator 25,000 calls/month; Pro, Scale and Enterprise have no monthly ceiling. Per-minute limits still apply: 30, 60, 120, 180, 300 and 600 respectively. Tool generation allowances are separate.
  • limit defaults to 30 and accepts integers from 1 through 100. Results are ordered from newest to oldest. Pass nextCursor as beforeHistoryId for the next page; null means there is no older page.
  • The returned items are personal saved web-tool history summaries. They differ from the durable integration result_list collection; tools can save history only on a best-effort basis.
  • This read does not generate media or consume the daily tool allowance; it uses one successful monthly integration call.
  • sourceType is upload or youtube. The listing does not contain a download URL; call subtitles_burn_history_get or subtitles_burn_download for a refreshed output link.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors