CLI

orc creative

orc creative calls the Creative API (/v1/creative) from the terminal. Generate images, video and speech, then check each job's status and artifacts. CI and scripts run the same commands.

Install

terminal
curl -fsSL https://orchestor.io/install | sh

For Windows and npm, see Installation.

Quickstart

Sign in:

terminal
orc auth login

Generate an image, wait for it to finish, and print the artifacts:

terminal
orc creative image generate --model gpt-image-2 --prompt "A red cube on a white background" --wait

In CI and scripts, set an API key in ORCHESTOR_API_KEY. The API key takes precedence over a stored sign-in. Browser dashboard sessions are not accepted on /v1/creative.

terminal
export ORCHESTOR_API_KEY="<API key>"

How generation works

Generation is an asynchronous job.

  1. Pick a model, for example with orc creative image models list.
  2. Create the job with image generate, video generate, tts generate or voice change. Add --idempotency-key to resend the same input safely.
  3. With --wait, the CLI waits until the job is COMPLETED, FAILED or CANCELED, then prints the artifacts. Tune it with --timeout and --poll-interval.
  4. Without --wait, read the state with orc creative jobs status <id> and the artifacts with orc creative jobs result <id>. You can also receive completion at --webhook-url.

To use a local file as input, issue an upload URL with orc creative files upload-url create and pass the returned public URL to the input.

Commands

CommandWhat it does
orc creative imageList image models and generate images
orc creative videoList video models and generate videos
orc creative ttsList speech models and voices and generate speech
orc creative voiceConvert the voice in audio or video
orc creative jobsCheck job status, artifacts and history, and cancel jobs
orc creative filesIssue upload URLs for input files
orc creative webhooksGet and rotate the webhook signing secret

Every command accepts global options such as --json and --workspace.

Models

Available models and prices depend on the Workspace. Check them with models list before generating.

terminal
orc creative image models list
orc creative video models list
orc creative tts models list

Per-model input parameters and pricing shapes are in Models.

Pricing

You pay for the jobs you generate. See Models for per-model pricing shapes and Billing and retention for failed and canceled jobs.