Models
OpenAI's list shape with one entry per catalog id the key may name, one per pinned id being served, and one per deployment of the key's workspace; owned_by is hips for the catalog and the workspace's ws_ id for a deployment.
/v1/modelspreviewThe models and deployments the key may name, with the hips extensions.
/v1/models/{id}previewOne entry of the list, by catalog id, pinned id or dep_ id.
taskThe task type:
chat,classification,embedding,image_generation,transcription,speech,video_generation, and the others the catalog defines.modality{"input": ["text", "image", ...], "output": ["text", ...]}.family, version, aliases, pinned_idsThe catalog entry's names;
pinned_idsthe versions currently served.billing_unitinput_output_tokens,per_1000_classifications,per_image,per_second, and the others of the pricing document.featuresThe features the model advertises, per pool:
{"approved": [...], "personal": [...]}.poolsThe supply state per pool under no requirements:
available,limited,unavailableorunknown. A snapshot, never a reservation; stale becomesunknown.lanesshared,always_onor both.context_length, max_output_tokens, limitsThe model's limits;
limitsholds the task-specific ones (inputs per request, input bytes, duration).licenseThe model's license identifier and conditions URL.
deprecates_atFor a pinned id with a retirement date; absent otherwise.
deploymentOn a
dep_entry:{"state", "model", "lane", "pool", "since"}.available_on_planfalseon a model the plan does not allow, so a client can tell unknown from not on my plan before sending a request.
Both routes answer with the key's view: a model the plan does not allow is listed with hips.available_on_plan: false, so a client can tell unknown from not on my plan before sending a request. The catalog is the only source of names; it lists every model HIPS has published, each with its status.
| Status | Type | Code | Situation | Retry |
|---|---|---|---|---|
| 403 | permission_error | key_scope_denied | The key's kind excludes the route | No |
| 404 | not_found_error | model_not_found | Unknown catalog id, alias, pinned id or dep_; another workspace's dep_ | No |
- Status
- 403
- Type
permission_error- Code
key_scope_denied- Situation
- The key's kind excludes the route
- Retry
- No
- Status
- 404
- Type
not_found_error- Code
model_not_found- Situation
- Unknown catalog id, alias, pinned id or
dep_; another workspace'sdep_ - Retry
- No
Related sheets
- Sheet
- 11 of 13
- Detail
- D
- Updated
- 2026-10-21
- Status
- Preview