Get Image Translation Project

GET

image-translation

project

{run_id}

Get Image Translation Project

curl --request GET \
  --url https://client.camb.ai/apis/image-translation/project/{run_id} \
  --header 'x-api-key: <api-key>'

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

fetch('https://client.camb.ai/apis/image-translation/project/{run_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/image-translation/project/{run_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,
  "source_language_id": 123,
  "target_languages": [
    {
      "target_language_id": 123
    }
  ],
  "pages": [
    {
      "page_id": 123,
      "order_index": 123,
      "width": 123,
      "height": 123,
      "renders": [
        {
          "target_language_id": 123,
          "is_stale": true,
          "preview_url": "<string>"
        }
      ],
      "regions": [
        {
          "region_id": 123,
          "order_index": 123,
          "box": {
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123
          },
          "translations": [
            {
              "target_language_id": 123,
              "is_stale": true,
              "text": "<string>"
            }
          ],
          "source_text": "<string>"
        }
      ]
    }
  ]
}

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

Inspecting a Translated Project

Use this endpoint when you need more than the downloadable ZIP: per-page previews, the text regions found on each page, their source text, and their translations. Each region includes a region_id, which is what you pass to Fine-Tune Image Translation to refine that region. Like the result endpoint, this returns 404 until the translated pages are ready for every target language.

Preview URLs are time-limited. Call this endpoint again to get fresh links when they expire.

Response Shape

The response lists each page with its preview renders and text regions. Each region has a region_id, its position on the page (box), the source_text, and one translation per target language:

{
  "run_id": 12345,
  "source_language_id": 1,
  "target_languages": [{ "target_language_id": 54 }],
  "pages": [
    {
      "page_id": 1,
      "order_index": 0,
      "width": 1200,
      "height": 1800,
      "renders": [
        {
          "target_language_id": 54,
          "is_stale": false,
          "preview_url": "https://..."
        }
      ],
      "regions": [
        {
          "region_id": 1,
          "order_index": 0,
          "box": { "x": 120, "y": 80, "width": 480, "height": 140 },
          "source_text": "Summer Sale",
          "translations": [
            { "target_language_id": 54, "text": "Rebajas de verano", "is_stale": false }
          ]
        }
      ]
    }
  ]
}

Request Example

import os
import requests

headers = {"x-api-key": os.environ["CAMB_API_KEY"]}
run_id = 12345

response = requests.get(
    f"https://client.camb.ai/apis/image-translation/project/{run_id}",
    headers=headers,
)
response.raise_for_status()
project = response.json()
region = project["pages"][0]["regions"][0]
print(region["region_id"], region.get("source_text"))

Next Steps

To adjust the translation of a specific region, send its region_id to Fine-Tune Image Translation.

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

run_id

integer

required

Run ID returned at create time.

Response

Successful Response

run_id

integer

required

source_language_id

integer

required

target_languages

ImageTranslationTargetLanguageRef · object[]

required

Hide child attributes

target_languages.target_language_id

integer

required

pages

ImageTranslationProjectPage · object[]

required

Hide child attributes

pages.page_id

integer

required

pages.order_index

integer

required

pages.width

integer

required

pages.height

integer

required

pages.renders

ImageTranslationPageRender · object[]

required

Hide child attributes

pages.renders.target_language_id

integer

required

pages.renders.is_stale

boolean

required

pages.renders.preview_url

string

required

Presigned preview of the rendered page.

pages.regions

ImageTranslationProjectRegion · object[]

required

Hide child attributes

pages.regions.region_id

integer

required

Pass this to fine-tune.

pages.regions.order_index

integer

required

pages.regions.box

ImageTranslationRegionBox · object

required

Hide child attributes

pages.regions.box.x

integer

required

pages.regions.box.y

integer

required

pages.regions.box.width

integer

required

pages.regions.box.height

integer

required

pages.regions.translations

ImageTranslationRegionTranslation · object[]

required

Hide child attributes

pages.regions.translations.target_language_id

integer

required

pages.regions.translations.is_stale

boolean

required

pages.regions.translations.text

string | null

pages.regions.source_text

string | null

Last modified on November 11, 2026

Get Image Translation Project

curl --request GET \
  --url https://client.camb.ai/apis/image-translation/project/{run_id} \
  --header 'x-api-key: <api-key>'

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

fetch('https://client.camb.ai/apis/image-translation/project/{run_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/image-translation/project/{run_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,
  "source_language_id": 123,
  "target_languages": [
    {
      "target_language_id": 123
    }
  ],
  "pages": [
    {
      "page_id": 123,
      "order_index": 123,
      "width": 123,
      "height": 123,
      "renders": [
        {
          "target_language_id": 123,
          "is_stale": true,
          "preview_url": "<string>"
        }
      ],
      "regions": [
        {
          "region_id": 123,
          "order_index": 123,
          "box": {
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123
          },
          "translations": [
            {
              "target_language_id": 123,
              "is_stale": true,
              "text": "<string>"
            }
          ],
          "source_text": "<string>"
        }
      ]
    }
  ]
}

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

Getting Started

Models

Tutorials

SDK Guides

Hosting Platforms

Integrations

API Reference

Other Products

Release Logs

Get Image Translation Project

Inspecting a Translated Project

Response Shape

Request Example

Next Steps

Authorizations

Path Parameters

Response

​Inspecting a Translated Project

​Response Shape

​Request Example

​Next Steps

Authorizations

Path Parameters

Response

Inspecting a Translated Project

Response Shape

Request Example

Next Steps