Developer tools
ByteIt CLI
Run every API operation from your terminal, a script or an AI agent with the byteit command.
pip install byteit also installs the byteit command: every API operation from a shell, a script
or an AI agent.
Install and authenticate
Section titled “Install and authenticate”pip install byteitexport BYTEIT_API_KEY="your-api-key"Parse and extract
Section titled “Parse and extract”byteit create-parse-job --file invoice.pdf # prints the new jobbyteit wait --id JOB_ID # until completed or failedbyteit read-job-result --id JOB_ID --output invoice.mdbyteit create-extract-job --parse-job-id JOB_ID --schema @invoice_schema.jsonCommands
Section titled “Commands”| Command | Does |
|---|---|
create-parse-job, create-extract-job, create-classification-job |
Start a job and print it as JSON. |
wait --id JOB_ID [--timeout 600] |
Poll with backoff (1 s up to 10 s) until the job is done. |
read-job-status, read-job, read-jobs |
Follow and list jobs. |
read-job-result --id JOB_ID [--output FILE] |
Download the result. Use --output for binary formats. |
byteit --help, byteit COMMAND --help |
Every command and its options. |
JSON options take inline JSON or @file.json. Each command is one request; a rate-limited (429)
request is retried up to three times, after the wait the API asks for.
Exit codes
Section titled “Exit codes”| Exit code | Meaning |
|---|---|
0 |
Success. |
1 |
API error, or the job failed. |
2 |
Wrong usage: a missing key, option or file. |
3 |
wait timed out. |