batches

Criar uma tradução

Crie uma tradução usando exatamente uma fonte: conteúdo JSON para texto UTF-8 literal, JSON file_url para um download HTTPS sem redirecionamentos, JSON upload_id para um upload temporário concluído com esta mesma credencial ou multipart/form-data com um campo file para bytes binários locais. Omita filename ao usar upload_id. A sessão já tem o nome do arquivo. Repetir um upload_id retorna o lote existente sem alterar a instrução. Nas demais fontes, envie um cabeçalho Idempotency-Key (de 1 a 255 caracteres imprimíveis. Um UUID serve) para que seja seguro tentar novamente após perder a resposta: uma repetição retorna o lote criado na primeira tentativa, sem buscar nem armazenar o arquivo ou fazer o planejamento novamente. A mesma chave com conteúdo diferente é recusada com 409 idempotency_key_reused. Caso contrário, filename é opcional e, se não for informado, será inferido. Inclua instruction para receber o plano verificado, as contagens calculadas, o custo em créditos e uma prévia da extração. Omita-o para receber suggested_instructions. Confira plan.not_included antes da aprovação. Criar e planejar não custa créditos. Os limites por formato estão em GET /v1/account. A tradução aparece no app da web.

POST/v1/batches

Request

curl --request POST \
  --url 'https://api.ai-glot.com/v1/batches' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "upload_id": "550e8400-e29b-41d4-a716-446655440000",
  "instruction": "Translate all English text into French"
}'

import json
import requests

url = "https://api.ai-glot.com/v1/batches"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"upload_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"instruction\":\"Translate all English text into French\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.ai-glot.com/v1/batches", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "upload_id": "550e8400-e29b-41d4-a716-446655440000",
    "instruction": "Translate all English text into French"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.ai-glot.com/v1/batches");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"upload_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"instruction\":\"Translate all English text into French\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://api.ai-glot.com/v1/batches", bytes.NewBuffer([]byte("{\"upload_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"instruction\":\"Translate all English text into French\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.ai-glot.com/v1/batches"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"upload_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"instruction\":\"Translate all English text into French\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.ai-glot.com/v1/batches")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"upload_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"instruction\":\"Translate all English text into French\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "name": null,
    "file_name": null,
    "status": "analyzing",
    "quality_tier": null,
    "word_count": 123,
    "credit_cost": 123,
    "is_sample": true,
    "archived": true,
    "progress": {
      "phase": null,
      "percent": null,
      "updated_at": null,
      "estimated_seconds_remaining": 123
    },
    "error": {
      "code": "<string>",
      "message": "<string>"
    },
    "created_at": null,
    "completed_at": null,
    "next_action": "provide_instruction",
    "plan": {
      "instruction": "<string>",
      "summary": null,
      "will_translate": null,
      "will_not_touch": null,
      "special_rules": [
        "<string>"
      ],
      "assumptions": [
        "<string>"
      ],
      "not_included": [
        "<string>"
      ],
      "languages": [
        {
          "source": {},
          "target": {},
          "segments": {},
          "words": {}
        }
      ],
      "totals": {
        "segments": 123,
        "words": 123,
        "files": {}
      },
      "credits": {
        "standard": 123,
        "lite": 123
      },
      "preview": [
        {
          "location": {},
          "source_text": {},
          "context": {},
          "languages": {},
          "source_lang": {},
          "target_lang": {}
        }
      ],
      "cached": true
    },
    "plan_revision": "<string>",
    "suggested_instructions": [
      "<string>"
    ]
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>"
  },
  "request_id": "<string>"
}

Requer batches:create. Criar uma tradução não custa nada: os créditos só são reservados quando você aprova um plano.

Escolha como enviar o arquivo

Escolha o método de envio de acordo com onde o documento está e com os recursos do seu cliente.

Método	Use quando	Observações
JSON com `upload_id`	Para um arquivo local enviado por uma sessão de envio temporário	Use a mesma credencial que criou a sessão. Omita `filename`. Se repetir a criação, a tradução existente será retornada sem alteração das instruções.
JSON com `content`	Para qualquer formato de texto	Envie o próprio arquivo como texto UTF-8. É a opção mais simples para um agente que já tem o conteúdo na memória.
JSON com `file_url`	Para um arquivo já hospedado	Somente HTTPS, com busca feita no servidor. Redirecionamentos não são seguidos, então informe a URL final.
`multipart/form-data`	Para arquivos binários locais, incluindo XLSX, DOCX, PPTX, PDF, IDML e ZIP	Envie os bytes originais no campo `file`. Esse é o método de envio de arquivos locais da CLI.

filename é opcional, mas vale a pena informá-lo. A extensão é usada para identificar o formato, então nomes como strings.xml e export.csv levam a analisadores diferentes, mesmo que os bytes sejam idênticos.

Como repetir a solicitação com segurança

Envie um cabeçalho Idempotency-Key (com 1 a 255 caracteres imprimíveis; UUID é uma boa opção) para que, se você repetir a solicitação após perder a resposta, receba a tradução criada na primeira tentativa, em vez de criar uma segunda. Uma solicitação repetida é respondida antes que o arquivo seja buscado ou armazenado e não gera um novo planejamento, portanto não tem custo. A chave fica vinculada ao conteúdo enviado: se você reutilizar a mesma chave com outro arquivo, nome ou instrução, a solicitação será recusada com idempotency_key_reused. Use uma nova chave para cada novo trabalho. Quando não for possível enviar cabeçalhos (ferramentas MCP, Code Mode), informe idempotency_key no corpo da solicitação. Uma criação com instruction retorna plan_revision junto com o plano. Envie esse valor como expected_plan_revision ao aprovar.

Próximas etapas

A resposta inclui um id, usado como batch_id nos caminhos seguintes. A sequência é sempre a mesma:

POST /v1/batches/{batch_id}/plan: descreva com suas próprias palavras o que deve ser traduzido.
POST /v1/batches/{batch_id}/approve: use créditos e inicie o processo.
GET /v1/batches/{batch_id}: consulte o status até a conclusão.
GET /v1/batches/{batch_id}/result: obtenha o resultado. A resposta inclui um link assinado, não o arquivo em si.

Resposta

application/json

Criar tradução a partir de um arquivo

dataobjectrequired

Show child attributes

idstringrequired

namestringnullrequired

file_namestringnullrequired

statusstringrequired

Onde a tradução está. Todos os sete valores: analyzing — a estrutura do arquivo está sendo lida, o que leva segundos; faça polling. awaiting_instructions — o arquivo foi lido, ninguém disse o que traduzir; chame plan. awaiting_approval — um plano aguarda um sim; chame approve, a única chamada que consome créditos. translating — em execução; faça polling. completed — recupere o resultado. failed — a execução não pôde ser concluída; leia error. cancelled — alguém a interrompeu propositalmente; também é terminal e não é uma falha. Os três últimos são terminais: pare o polling.

quality_tierstringnullrequired

word_countinteger | nullrequired

credit_costinteger | nullrequired

is_samplebooleanrequired

archivedbooleanrequired

progressobjectrequired

errorobject | nullrequired

created_atstringnullrequired

completed_atstringnullrequired

next_actionstring

A chamada a ser feita a seguir, para que um cliente nunca precise mapear o status por conta própria. provide_instruction — chame plan com uma instrução. review_plan — o plano precificado está incorporado; verifique plan.not_included e então aprove. wait — faça polling novamente; progress.estimated_seconds_remaining indica quanto tempo resta. download — recupere o resultado. read_error — a execução terminou sem resultado; leia error (e status indica se houve falha ou cancelamento). Ausente apenas em lotes CSV legados anteriores a 2026-08-31, que não possuem um plano vinculado; todas as traduções criadas desde então respondem.

planobject | null

plan_revisionstring | null

suggested_instructionsstring[] | null

request_idstringrequired

Criar uma tradução

Escolha como enviar o arquivo

Como repetir a solicitação com segurança

Próximas etapas

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown