> ## Documentation Index
> Fetch the complete documentation index at: https://docs.camb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Image Translation Project

> Retrieves the pages, text regions, and translations for a completed image translation run.

## 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](https://docs.camb.ai/api-reference/endpoint/fine-tune-image-translation.md) to refine that region.

Like the [result endpoint](https://docs.camb.ai/api-reference/endpoint/get-image-translation-result.md), this returns **404** until the translated pages are ready for every target language.

> [!NOTE]
>
> 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:

```json [expandable] theme={null}
{
  "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

```python [expandable] theme={null}
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](https://docs.camb.ai/api-reference/endpoint/fine-tune-image-translation.md).


## OpenAPI

````yaml get /image-translation/project/{run_id}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://client.camb.ai/apis
security: []
paths:
  /image-translation/project/{run_id}:
    get:
      tags:
        - Apis
        - Image Translation
      summary: Get Image Translation Project
      description: >-
        Returns the pages, text regions, and translations for a completed image
        translation run.
      operationId: get_image_translation_project_image_translation_project__run_id__get
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/RunIDParam'
            description: Run ID returned at create time.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageTranslationProject'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    RunIDParam:
      type: integer
      title: Run ID
      description: >-
        The unique identifier for the run, which was generated during the
        creation process and returned upon task completion.
    ImageTranslationProject:
      type: object
      title: ImageTranslationProject
      required:
        - run_id
        - source_language_id
        - target_languages
        - pages
      properties:
        run_id:
          type: integer
          title: Run ID
        source_language_id:
          type: integer
          title: Source Language ID
        target_languages:
          type: array
          items:
            $ref: '#/components/schemas/ImageTranslationTargetLanguageRef'
        pages:
          type: array
          items:
            $ref: '#/components/schemas/ImageTranslationProjectPage'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ImageTranslationTargetLanguageRef:
      type: object
      title: ImageTranslationTargetLanguageRef
      required:
        - target_language_id
      properties:
        target_language_id:
          type: integer
          title: Target Language ID
    ImageTranslationProjectPage:
      type: object
      title: ImageTranslationProjectPage
      required:
        - page_id
        - order_index
        - width
        - height
        - renders
        - regions
      properties:
        page_id:
          type: integer
        order_index:
          type: integer
        width:
          type: integer
        height:
          type: integer
        renders:
          type: array
          items:
            $ref: '#/components/schemas/ImageTranslationPageRender'
        regions:
          type: array
          items:
            $ref: '#/components/schemas/ImageTranslationProjectRegion'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ImageTranslationPageRender:
      type: object
      title: ImageTranslationPageRender
      required:
        - target_language_id
        - is_stale
        - preview_url
      properties:
        target_language_id:
          type: integer
        is_stale:
          type: boolean
        preview_url:
          type: string
          description: Presigned preview of the rendered page.
    ImageTranslationProjectRegion:
      type: object
      title: ImageTranslationProjectRegion
      required:
        - region_id
        - order_index
        - box
        - translations
      properties:
        region_id:
          type: integer
          description: Pass this to fine-tune.
        order_index:
          type: integer
        box:
          $ref: '#/components/schemas/ImageTranslationRegionBox'
        source_text:
          type:
            - string
            - 'null'
        translations:
          type: array
          items:
            $ref: '#/components/schemas/ImageTranslationRegionTranslation'
    ImageTranslationRegionBox:
      type: object
      title: ImageTranslationRegionBox
      required:
        - x
        - 'y'
        - width
        - height
      properties:
        x:
          type: integer
        'y':
          type: integer
        width:
          type: integer
        height:
          type: integer
    ImageTranslationRegionTranslation:
      type: object
      title: ImageTranslationRegionTranslation
      required:
        - target_language_id
        - is_stale
      properties:
        target_language_id:
          type: integer
        text:
          type:
            - string
            - 'null'
        is_stale:
          type: boolean
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.