GET
/
project-setup-result
/
{run_id}
curl --request GET \
  --url https://client.camb.ai/apis/project-setup-result/{run_id} \
  --header 'x-api-key: <api-key>'
{
  "run_id": 1,
  "run_details": {
    "name": "<string>",
    "desc": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "primary_source_language": 1,
    "target_languages": [
      1
    ],
    "duration": 123,
    "team_id": 1,
    "folder_id": 1
  }
}

Access the complete details of your finished project setup with this essential endpoint. Once your project setup task has completed its preparation process, this API call delivers comprehensive information about your newly configured project, including all the analysis results, configuration details, and metadata that make your content ready for creative editing in CAMB.AI Studio. Think of this as receiving your project’s complete preparation report, telling you everything the system discovered and configured during the setup process.

Understanding Project Setup Results

When you request the results of a completed project setup task, the system returns a comprehensive package that serves multiple important purposes in your content workflow. The response contains detailed information about your project’s current state, the analysis results that informed the setup process, and the configuration parameters that will guide editing work in CAMB.AI Studio.

The run details section provides the foundational information that helps teams coordinate their work effectively. This includes the descriptive information you provided during setup, such as the project name and description that help identify and contextualize the work. You’ll also find timing information that tracks when the project was created, which proves valuable for project management and workflow coordination. The language configuration details confirm exactly which source and target languages were configured, ensuring that everyone understands the scope of the localization work ahead.

Accessing Your Project Setup Results

To retrieve your project setup results, you’ll need the run_id that becomes available once your project setup task has completed successfully. This identifier serves as your unique key to access all the detailed information about your prepared project. Think of the run_id as your project’s passport, providing access to everything the system learned and configured during the preparation process.

Example Request with Python

Here’s how to retrieve your completed project setup results using Python, with detailed explanations of what each part of the process accomplishes:

import requests
import json
from datetime import datetime

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


def get_project_setup_result(run_id):
    """
    Retrieves the comprehensive results of a finished project setup task.
    This function accesses all the detailed information about your prepared project,
    including analysis results and configuration details that inform Studio editing.

    The returned data provides everything your creative team needs to understand
    the project structure and begin effective editing work.
    """
    try:
        # Make the API request to retrieve setup results
        response = requests.get(
            f"https://client.camb.ai/apis/project-setup-result/{run_id}",
            headers=headers,
        )

        # Verify that the request completed successfully
        response.raise_for_status()

        # Parse the comprehensive project setup results
        result_data = response.json()

        # Extract key project information for workflow coordination
        run_details = result_data.get("run_details")

        return run_details

    except requests.exceptions.RequestException as e:
        print(f"Error retrieving project setup results: {e}")
        if hasattr(e, "response") and e.response is not None:
            print(f"Response content: {e.response.text}")
        return None


# Replace with your actual run_id from the completed setup task
run_id = 12345
project_results = get_project_setup_result(run_id)

# Process and display detailed project information if results were retrieved successfully
if project_results:
    project_name = project_results.get("name", "Unnamed Project")
    description = project_results.get("desc")
    creation_time = project_results.get("created_at")
    duration = project_results.get("duration")
    team_id = project_results.get("team_id")
    source_language = project_results.get("primary_source_language")
    target_languages = project_results.get("target_languages", [])

    print("\n--- Detailed Project Analysis ---")

    print(f"Run ID: {run_id}")

    print(f"Successfully retrieved setup results for: {project_name}")

    # Show project description for context understanding
    if description:
        print(f"Project description: {description}")

    # Display timing information for project management
    if creation_time:
        # Convert ISO timestamp to readable format for team coordination
        created = datetime.fromisoformat(creation_time.replace("Z", "+00:00"))
        print(f"Project created: {created.strftime('%Y-%m-%d %H:%M:%S UTC')}")

    # Display duration information for resource planning
    if duration:
        # Convert seconds to minutes and seconds for easier understanding
        minutes = int(duration // 60)
        seconds = int(duration % 60)
        print(f"Media duration: {minutes}m {seconds}s ({duration:.1f} seconds)")

    # Display organizational information for team coordination
    if team_id:
        print(f"Team ID: {team_id}")

    # Show language configuration that determines dubbing scope
    print(f"Source language ID: {source_language}")

    # Show target language details for localization planning
    print(f"Target languages: {len(target_languages)} configured")
    print("This project will create dubbed versions in each configured language")

    print("\nProject is ready for creative editing in CAMB.AI Studio")
    print("Your team can now access this project to begin detailed dubbing work")

Planning Your Next Steps

Understanding your project setup results helps you make informed decisions about the creative editing phase that follows. The information provides essential context for planning editing time, coordinating team resources, and setting realistic expectations for project completion.

The duration and complexity information helps you estimate how much creative editing time will be required to achieve your quality goals. Projects with longer duration or more complex audio structures typically require more detailed attention during the editing process, while simpler projects might progress more quickly through creative refinement.

The language configuration details help you plan resource allocation across different target languages, particularly when working with languages that have different characteristics or when your team has varying expertise across different languages. Understanding the full scope of language work ahead enables better planning for review processes and quality assurance approaches.

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

The unique identifier for the run, which was generated during the project setup process and returned upon task completion.

Response

200
application/json

Successful Response

The response is of type object.