Endpoints

Get All Supported Languages

Retrieve a list of all supported languages for projects.

Method: GET
URL: /languages
What it does: Returns a list of languages with their UUID, code, and name.

Example Request:

curl -X GET "https://api-verify.straker.ai/languages" \
-H "Authorization: Bearer YOUR_API_KEY"

Example Response:

{
  "data": [
    {
      "id": "uuid-1234",
      "code": "en",
      "name": "English"
    }
  ]
}

________________

Get Workflows

Get a list of all the Orchestrate workflows created by your Organisation.

Method: GET
URL: /workflow
What it does: Fetches all the Orchestrate workflow ID's for your Organisation

________________

Create a Project

Create a new translation or verification project by uploading files and specifying target languages.

Method: POST
URL: /project
What it does: Creates a project with the specified files, languages, and a workflow UUID.

Parameters:

files[]- The files to be processed.
languages[]- List of target language UUIDs.
workflow_id- Workflow UUID from the Orchestrate page.

Example Request:

curl -X POST "https://api-verify.straker.ai/project" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "files=@document.txt" \
-F "languages[]=uuid-5678" \
-F "workflow_id=uuid-9876"

Example Response:

{
  "project_id": "uuid-12345",
  "message": "Project created successfully"
}

________________

Get Project Details

Retrieve details about a specific project using its project_id.

Method: GET
URL: /project/{project_id}
What it does: Provides detailed information about the project, including its status, languages, and files.

/project/{project_id}

Example Request:

curl -X GET "https://api-verify.straker.ai/project/uuid-12345" \
-H "Authorization: Bearer YOUR_API_KEY"

Example Response:

{
  "project_id": "uuid-12345",
  "status": "in_progress",
  "created_at": "2023-09-22T13:12:33Z",
  "target_languages": [
    {
      "uuid": "uuid-5678",
      "name": "French"
    }
  ],
  "files": [
    {
      "file_id": "uuid-file-001",
      "filename": "document.txt"
    }
  ]
}

________________

Confirm Project

Finalize a project after it has been reviewed.

Method: POST
URL: /project/confirm
What it does: Confirms a project, finalizing the task if there are enough AI tokens to use.

Example Request:

curl -X POST "https://api-verify.straker.ai/project/confirm" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d "project_id=uuid-12345"
Example Response:
{
  "message": "Project confirmed successfully"
}

________________

Download File from a Project

Download a specific file from a project.

Method: GET
URL: /file/{file_id}
What it does: Retrieves the file associated with a project.

Example Request:

curl -X GET "https://api-verify.straker.ai/file/uuid-file-001" \

-H "Authorization: Bearer YOUR_API_KEY"

Response: A binary stream of the file is returned.

________________

Retrieve Segments of a Specific Project

Get the translated or verified text segments for a specific project, file, and language.

Method: GET
URL: /project/{project_id}/segments/{file_id}/{language_id}
What it does: Retrieves the translation segments for a specific project and language.

Example Request:

curl -X GET "https://api-verify.straker.ai/project/uuid-12345/segments/uuid-file-001/uuid-lang-001" \
-H "Authorization: Bearer YOUR_API_KEY"

Example Response:

{
  "file_id": "uuid-file-001",
  "language_id": "uuid-lang-001",
  "segments": [
    {
      "source_text": "Hello",
      "translation": {
        "target_text": "Bonjour",
        "translation_memory_matched": true,
        "score": 100
      }
    }
  ]
}