AjudaAPIInício rápido

Início rápido

De uma chave de API a um arquivo baixado em cinco passos.

Cinco passos de uma chave a um arquivo baixado.

A API pública executa um modelo que você já criou no DocTransform sobre um arquivo que você envia a partir de um script — sem nenhuma aba de navegador envolvida.

Os cinco passos

Crie uma chave

Na sua página de conta, Crie uma chave. Copie-a agora — ela é mostrada apenas uma vez.

Defina-a como variável de ambiente

Todo exemplo nessas páginas lê a chave de DOCTRANSFORM_API_KEY, nunca como um literal no comando:

export DOCTRANSFORM_API_KEY=dt_live_...

Liste seus modelos

Encontre o id do modelo que você quer executar.

curl "https://doctransform.xyz/api/v1/templates" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"

Crie uma execução

Envie um arquivo para executar esse modelo sobre ele.

curl -X POST "https://doctransform.xyz/api/v1/templates/tmpl_123/runs" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
  -F "file=@/caminho/para/seu/arquivo.csv"

Só uma execução que devolve um arquivo conta para suas execuções mensais.

Consulte, depois baixe

Uma execução rápida responde 201 na hora, com o resultado já pronto. Uma mais longa responde 202 enquanto continua trabalhando — consulte GET /runs/{id} até o status se resolver, e então baixe:

curl "https://doctransform.xyz/api/v1/runs/run_abc/output" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
  -o resultado.csv

Veja Autenticação, Execuções e Erros e limites para o detalhe completo por trás de cada passo.