Skip to main content
GET
Get a model

Authorizations

Authorization
string
header
required

A Voyager API key from https://voyager.so/dashboard/api.

Headers

X-Voyager-Cast-Version
string | null

1: each operation's input_schema takes Cast v1 (saved cards, selections, inline packages) and states cast_capabilities.

Path Parameters

model_id
string
required

Response

Successful Response

id
string
required

Pass as model to POST /v1/jobs.

name
string
required

The model's display name.

type
enum<string>
required

The kind of output it makes.

Available options:
image,
video,
speech,
music,
sound_effect,
3d,
segment
default
boolean
required

Whether this is Voyager's recommended model for its type (a suggestion only: model is always required).

status
string
required

active, preview or retired.

operations
enum<string>[]
required

Operations this model runs, e.g. text-to-image, edit.

Available options:
text-to-image,
edit,
text-to-video,
image-to-video,
reference-to-video,
tts,
music,
sound-effects,
text-to-3d,
image-to-3d,
image-to-3d-body,
align-3d,
segment-image,
segment-image-data,
segment-video,
segment-video-data,
segment-everything,
image-embedding
price
PriceDetail · object | null
required

Expected charge; null when not known.

operation_details
ModelOperation · object[]
required

Each operation's input schema, defaults and an example request.

object
string
default:model

Always "model".

Allowed value: "model"
summary
string | null

One line on what the model is.

best_for
string | null

What the model is good for.

available
boolean | null

Whether this workspace can run it now; null when not known (decided when the job is accepted).

unavailable_reason
enum<string> | null

Why not, when available is false.

Available options:
plan_locked,
access_required,
access_pending,
access_denied,
update_required,
unavailable,
retired
required_plan
string | null

The lowest Voyager plan that runs it, when known.