Skip to navigation

Read a Machine

View as Markdown

Reads a saved Machine. Needs the scope machines.

Authentication

AuthorizationBearer

An API key (crk_), an exchanged token (crt_) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.

Path parameters

namestringRequired

The Machine name: lowercase letters, digits and hyphens.

Response headers

x-request-idstringOptional

The id of the request: req_ and a ULID. Every answer has it.

server-timingstringOptional
The time of the admission.
x-ratelimit-limit-requestsstringOptional
The size of the request bucket, per minute.
x-ratelimit-remaining-requestsstringOptional
The requests that remain.
x-ratelimit-reset-requestsstringOptional
The time until the request bucket is full.
x-ratelimit-limit-unitsstringOptional
The size of the units bucket, per minute. Absent when no limit applies.
x-ratelimit-remaining-unitsstringOptional
The units that remain.
x-ratelimit-reset-unitsstringOptional
The time until the units bucket is full.

Response

The Machine.
object"machine"
namestring
descriptionstring or null
published_versioninteger or null-9007199254740991-9007199254740991
The published version. Null when no version is published.
latest_versioninteger-9007199254740991-9007199254740991
modelstring
The OpenAI model id of the published version.
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error