Execute Comparison

curl -X POST "https://YOUR_BASE_URL/comparisons/eeeeeeee-0000-0000-0000-000000000005/execute" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

import requests

comparison_id = "eeeeeeee-0000-0000-0000-000000000005"
url = f"https://YOUR_BASE_URL/comparisons/{comparison_id}/execute"
headers = {
    "Authorization": "Bearer <api-key>",
    "Workspace-Id": "<workspace-id>",
}

response = requests.post(url, headers=headers)
print(response.json())

const comparisonId = "eeeeeeee-0000-0000-0000-000000000005";
const response = await fetch(
  `https://YOUR_BASE_URL/comparisons/${comparisonId}/execute`,
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer <api-key>",
      "Workspace-Id": "<workspace-id>",
    },
  }
);
const data = await response.json();
console.log(data);

{
  "message": "Comparison execution started",
  "run_id": 1042,
  "celery_task_id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
}

POST

comparisons

{comparison_id}

execute

curl -X POST "https://YOUR_BASE_URL/comparisons/eeeeeeee-0000-0000-0000-000000000005/execute" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

import requests

comparison_id = "eeeeeeee-0000-0000-0000-000000000005"
url = f"https://YOUR_BASE_URL/comparisons/{comparison_id}/execute"
headers = {
    "Authorization": "Bearer <api-key>",
    "Workspace-Id": "<workspace-id>",
}

response = requests.post(url, headers=headers)
print(response.json())

const comparisonId = "eeeeeeee-0000-0000-0000-000000000005";
const response = await fetch(
  `https://YOUR_BASE_URL/comparisons/${comparisonId}/execute`,
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer <api-key>",
      "Workspace-Id": "<workspace-id>",
    },
  }
);
const data = await response.json();
console.log(data);

{
  "message": "Comparison execution started",
  "run_id": 1042,
  "celery_task_id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
}

Authorization

string

required

Bearer token. Format: Bearer <api-key>

Workspace-Id

string

required

Your workspace UUID.

comparison_id

string

required

UUID of the comparison to execute.

celery_task_id

string

If provided, the running job with this task ID is terminated before a new execution starts.

enable_priority

boolean

default:"false"

If true, the job is placed at the front of the execution queue.

translation_iteration_no

integer

Translation iteration number. Used when executing as part of a translation workflow.

translation_run_id

string

Translation run ID. Used when executing as part of a translation workflow.

current_event_key

string

Event key for tracking the execution in an agent workflow.

Response

message

string

Status message.

run_id

integer

The job ID. Use this to monitor progress via the Jobs API.

celery_task_id

string

The background task ID assigned to this execution.

curl -X POST "https://YOUR_BASE_URL/comparisons/eeeeeeee-0000-0000-0000-000000000005/execute" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

import requests

comparison_id = "eeeeeeee-0000-0000-0000-000000000005"
url = f"https://YOUR_BASE_URL/comparisons/{comparison_id}/execute"
headers = {
    "Authorization": "Bearer <api-key>",
    "Workspace-Id": "<workspace-id>",
}

response = requests.post(url, headers=headers)
print(response.json())

const comparisonId = "eeeeeeee-0000-0000-0000-000000000005";
const response = await fetch(
  `https://YOUR_BASE_URL/comparisons/${comparisonId}/execute`,
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer <api-key>",
      "Workspace-Id": "<workspace-id>",
    },
  }
);
const data = await response.json();
console.log(data);

{
  "message": "Comparison execution started",
  "run_id": 1042,
  "celery_task_id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
}

Create Comparison Execute Multiple Comparisons

Overview

Data Sources

Comparisons

Jobs

Response

​Response

Response