Skip to content

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.

pip install byteit
export BYTEIT_API_KEY="your-api-key"
byteit create-parse-job --file invoice.pdf # prints the new job
byteit wait --id JOB_ID # until completed or failed
byteit read-job-result --id JOB_ID --output invoice.md
byteit create-extract-job --parse-job-id JOB_ID --schema @invoice_schema.json
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 code Meaning
0 Success.
1 API error, or the job failed.
2 Wrong usage: a missing key, option or file.
3 wait timed out.