Batches

Get a batch

One batch.

GET
/v1/batches/{batch}

One batch. With include=failures, the response adds failures, the failed pairs with their last error, at most 100. A batch of another project answers 404. Accepts a token with any of push, pull or manage.

Authorization

deployToken
headerAuthorizationBearer <token>

A project deploy token, minted in the console under Settings, Developer, API tokens. Send the whole value, including the numeric prefix before the |. A token carries a set of abilities (push, pull, manage, read, write) and each operation requires one of them. Tokens do not inherit from each other: a manage token cannot read the glossary unless it also has read.

Path Parameters

batch*integer

The batch id, as returned by POST /v1/translate, GET /v1/batches or a push.

Query Parameters

include?"failures"
Value in"failures"

Response Body

The batch.

application/json
  1. response

A translation run.

id?integer
status?string

pending and processing are active; the other four are final. Only one batch per project is active at a time.

Value in"pending""processing""completed""completed_with_errors""failed""cancelled"
trigger?string

What started the run.

Value in"manual_missing""manual_selected""auto_edit""language_added""retry_failed""push"
total?integer

Key and locale pairs sent for translation.

completed?integer

Pairs the run finished processing.

failed?integer

Pairs that failed.

skipped?integer

Pairs the run covered and will not write. A translation you have edited or reviewed is never overwritten by AI; such pairs are counted here.

skipped_reasons?|

Skipped pairs by reason. human_value_stands: a person's translation is in place. human_value_stale: a person's translation is in place and the source has changed since, so only a person can update it. source_moved: the source changed while the run was in progress; running again fixes it.

tm_served?integer

Pairs answered from translation memory. They are not part of total.

language_breakdown?|

Pairs per target locale.

started_at?|
Formatdate-time
finished_at?|
Formatdate-time
failures?array<>

Failed pairs, ordered by when they were queued, at most 100.

curl -X GET 'https://api.transglot.ai/v1/batches/0'
{  "id": 0,  "status": "pending",  "trigger": "manual_missing",  "total": 0,  "completed": 0,  "failed": 0,  "skipped": 0,  "skipped_reasons": {    "property1": 0,    "property2": 0  },  "tm_served": 0,  "language_breakdown": {    "property1": 0,    "property2": 0  },  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "failures": [    {      "key": "string",      "locale": "string",      "error": "string"    }  ]}