Get Translated Story Status

GET

translated-story

{task_id}

Get Translated Story Status

curl --request GET \
  --url https://client.camb.ai/apis/translated-story/{task_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://client.camb.ai/apis/translated-story/{task_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client.camb.ai/apis/translated-story/{task_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client.camb.ai/apis/translated-story/{task_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "run_id": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Monitor the progress of your story translation tasks with our dedicated status tracking endpoint. This essential companion to our translation service lets you check on your story’s transformation journey in real-time, providing detailed information about which stage of the process your content has reached. By polling this endpoint, you can keep track of your translation progress and detect any issues that might arise during processing. This endpoint works in conjunction with the /translated-story/{run_id} endpoint, which initiates the translation process and provides the task_id needed for status checks.

Understanding the Translation Pipeline

When you request a story translation, your content moves through several processing stages before completion. The status endpoint provides visibility into this journey, allowing you to:

Confirm your translation request was successfully received and is being processed
Monitor the progress as your story moves through different translation stages
Identify when the translation is complete and ready for use
Quickly detect and respond to any issues that might occur during processing

Having this level of insight helps you integrate story translations into your applications more effectively, allowing you to provide accurate progress updates to your users and plan subsequent workflows accordingly.

Implementing Status Checking

Here’s how to implement status checking in your application using Python:

import requests
import json
import time

# Your API authentication
headers = {
    "x-api-key": "your-api-key",  # Replace with your actual API key
    "Content-Type": "application/json"
}

def check_translation_status(task_id):
    """
    Polls the status endpoint to track a story translation task's progress.
    Continues checking until the task reaches a terminal state.

    Parameters:
    - task_id: The unique identifier returned when the translation request was submitted

    Returns:
    - The final status data when a terminal state is reached, or None if an error occurs
    """
    if not task_id:
        print("Error: No task ID provided")
        return None

    # Define the possible final states of a translation task
    terminal_states = ["SUCCESS", "ERROR", "TIMEOUT", "PAYMENT_REQUIRED"]
    current_status = None

    while current_status not in terminal_states:
        try:
            # Make the status request
            response = requests.get(
                f"https://client.camb.ai/apis/translated-story/{task_id}",
                headers=headers
            )

            # Verify the request was successful
            response.raise_for_status()

            # Extract the status information
            status_data = response.json()
            current_status = status_data.get("status")

            # Display current progress information
            print(f"Status: {current_status}")

            # Handle different status states
            if current_status == "SUCCESS":
                print("Translation completed successfully!")
                print(f"Translated story URL: {status_data.get('story_url')}")
                return status_data

            elif current_status == "ERROR":
                print(f"Translation failed: {status_data.get('error_message')}")
                return status_data

            elif current_status == "TIMEOUT":
                print("Translation process timed out")
                return status_data

            elif current_status == "PAYMENT_REQUIRED":
                print("Additional payment is required to complete this translation")
                return status_data

            elif current_status == "PENDING":
                # Task is still in progress, wait before checking again
                print("Translation in progress...")
                if status_data.get('progress'):
                    print(f"Progress: {status_data.get('progress')}%")
                if status_data.get('current_stage'):
                    print(f"Current stage: {status_data.get('current_stage')}")

                # Wait before next check to avoid excessive requests
                time.sleep(30)  # Poll every 30 seconds

            else:
                # Unexpected status, wait and try again
                print(f"Received status: {current_status}")
                time.sleep(30)

        except requests.exceptions.RequestException as e:
            print(f"Error checking translation status: {e}")
            if hasattr(e, 'response') and e.response is not None:
                print(f"Response content: {e.response.text}")
            return None

    return status_data

# Example usage with a task_id from a previous translation request
task_id = "your_task_id"  # Replace with your actual task ID
final_status = check_translation_status(task_id)

Best Practices for Status Monitoring

To efficiently track your translation tasks, consider these professional recommendations:

Implement Exponential Backoff: Start with frequent checks that gradually increase in interval to avoid overloading the API. For example, begin with a 5-second interval, then double it each time until you reach a maximum of 2 minutes between checks.
Handle All Possible States: Ensure your code properly handles each possible status response, including unexpected values. This makes your integration robust against future API enhancements.
Set Reasonable Timeouts: For longer stories, translation may take significant time. Implement appropriate overall timeout periods based on the typical length of your content.
Persist Task IDs: Store task IDs securely in your database so you can resume status checking even if your application restarts or a user returns later.
Provide Meaningful Feedback: Translate technical status information into user-friendly messages that set appropriate expectations about completion time and next steps.

Troubleshooting Common Issues

If you encounter difficulties while checking translation status, consider these common solutions:

Invalid Task ID: Verify the task ID was correctly stored and passed to the status endpoint. Task IDs are case-sensitive and must be used exactly as provided.
Authentication Problems: Ensure your API key is valid and correctly included in the request headers.
Network Connectivity: Implement proper error handling for network issues that might interrupt status checking, including automatic retry logic.
Unexpected Terminal States: If a translation ends with an error status, examine the error message for specific issues that might be addressed in subsequent translation attempts.

By properly integrating status checking into your application, you can create a seamless translation experience that keeps your users informed throughout the entire process, building confidence in your service and ensuring the timely delivery of translated content.

Authorizations

x-api-key

string

header

required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

task_id

string

required

A unique identifier for the task. This is used to query the status of the translated story task that is running. It is returned when a create request is made for a translated story.

Response

Successful Response

status

enum<string>

Available options:

SUCCESS,

PENDING,

TIMEOUT,

ERROR,

PAYMENT_REQUIRED

run_id

integer | null

Get Translated Story ResultRetrieves detailed results about a specific translated story using the provided `run_id` and `target_language` parameters.

Get Translated Story Status

curl --request GET \
  --url https://client.camb.ai/apis/translated-story/{task_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://client.camb.ai/apis/translated-story/{task_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client.camb.ai/apis/translated-story/{task_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client.camb.ai/apis/translated-story/{task_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "run_id": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Getting Started

Models

Tutorials

SDK Guides

Hosting Platforms

Integrations

API Reference

Other Products

Release Logs

Get Translated Story Status

Understanding the Translation Pipeline

Implementing Status Checking

Best Practices for Status Monitoring

Troubleshooting Common Issues

Authorizations

Path Parameters

Response

​Understanding the Translation Pipeline

​Implementing Status Checking

​Best Practices for Status Monitoring

​Troubleshooting Common Issues

Authorizations

Path Parameters

Response

Understanding the Translation Pipeline

Implementing Status Checking

Best Practices for Status Monitoring

Troubleshooting Common Issues