Retrieve endpoint status - Cerebras Inference

Authorizations

Authorization

string

header

required

Management API key generated from the Management API keys section on the API keys page at https://cloud.cerebras.ai. Use the format: Bearer <MANAGEMENT_API_KEY>

Path Parameters

endpoint_id

string

required

Unique identifier for the endpoint. It is used as the model field when making an inference request.

Example: my-org-gpt-oss-120b

curl --location 'https://api.cerebras.ai/v1/chat/completions' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${CEREBRAS_API_KEY}" \
--data '{
  "model": "my-org-gpt-oss-120b",
  "messages": [{"content": "Hello!", "role": "user"}]
}'

Response

200 - application/json

Successful Response

name

string

required

Endpoint name (e.g. my-org-gpt-oss-120b).

model_arch_id

string

required

Name of the model architecture (e.g. llama3.1-8b, gpt-oss-120b).

deployed_models

DeployedModel · object[]

required

List of deployed models.

Hide child attributes

deployed_models.id

string

required

Deployment ID corresponding to this instance of deployed model. This is the UUID generated during deployment.

deployed_models.model

string

required

Model Version ID in the format of orgs/<org_name>/models/<model_arch_id>/versions/<version_id>.

deployed_models.created

integer

required

Unix timestamp (in seconds) when the deployment was created.

deployed_models.state

enum<string>

required

Rollout status reported for the deployment.

Available options:

not_started,

in_progress,

rolling_back,

rolled_back,

done,

error,

cancelled

deployed_models.version_alias

string | null

Original version reference from deploy request (alias or integer version ID as specified by user).

deployed_models.max_unavailable_replicas

integer | null

Maximum number of replicas that can be unavailable during rollout.

deployed_models.rollout_replicas_updated

integer | null

Number of replicas that have been updated in the rollout.

deployed_models.rollout_total_replicas

integer | null

Total number of replicas in the deployment.

deployed_models.rollout_error_message

string | null

Error message from the rollout, if any.

created

integer

required

Unix timestamp (in seconds) when the endpoint was created.

updated

integer

required

Unix timestamp (in seconds) when the endpoint was last updated.

managing_org_name

string | null

Organization that has management access to this endpoint.