Developers

Chutes API Reference

This section covers all endpoints related to chutes.

Share Chute

Share a chute with another user.

Endpoint:

Parameters

ParameterTypeRequiredDescription
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Request Body

FieldTypeRequiredDescription
chute_id_or_namestringYes
user_id_or_namestringYes

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Unshare Chute

Unshare a chute with another user.

Endpoint:

Parameters

ParameterTypeRequiredDescription
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Request Body

FieldTypeRequiredDescription
chute_id_or_namestringYes
user_id_or_namestringYes

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


List Boosted Chutes

Get a list of chutes that have a boost.

Endpoint:

Responses

Status CodeDescription
200Successful Response

List Available Affine Chutes

Get a list of affine chutes where the creator/user has a non-zero balance.

Endpoint:

Responses

Status CodeDescription
200Successful Response

List Chutes

List (and optionally filter/paginate) chutes.

Endpoint:

Parameters

ParameterTypeRequiredDescription
include_publicboolean | nullNo
templatestring | nullNo
namestring | nullNo
excludestring | nullNo
imagestring | nullNo
slugstring | nullNo
pageintegerNo
limitintegerNo
offsetintegerNo
include_schemasboolean | nullNo
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Deploy Chute

Standard deploy from the CDK.

Endpoint:

Parameters

ParameterTypeRequiredDescription
accept_feeboolean | nullNo
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Request Body

FieldTypeRequiredDescription
namestringYes
taglinestring | nullNo
readmestring | nullNo
tool_descriptionstring | nullNo
logo_idstring | nullNo
imagestringYes
publicbooleanYes
codestringYes
filenamestringYes
ref_strstringYes
standard_templatestring | nullNo
node_selectorNodeSelectorYes
cordsCord[] | nullNo
jobsJob[] | nullNo
concurrencyinteger | nullNo
revisionstring | nullNo
max_instancesinteger | nullNo
scaling_thresholdnumber | nullNo
shutdown_after_secondsinteger | nullNo
allow_external_egressboolean | nullNo
encrypted_fsboolean | nullNo
teeboolean | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


List Rolling Updates

Endpoint:

Responses

Status CodeDescription
200Successful Response

Get Gpu Count History

Endpoint:

Responses

Status CodeDescription
200Successful Response

Get Chute Miner Mean Index

Endpoint:

Responses

Status CodeDescription
200Successful Response

Get Chute Miner Means

Load a chute's mean TPS and output token count by miner ID.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_idstringYes
extstring | nullYes

Responses

Status CodeDescription
200Successful Response
422Validation Error

Get Chute Miner Means

Load a chute's mean TPS and output token count by miner ID.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_idstringYes
extstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Get Chute Code

Load a chute's code by ID or name.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_idstringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Warm Up Chute

Warm up a chute.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_id_or_namestringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Get Chute Utilization

Get chute utilization data from the most recent capacity log.

Endpoint:

Responses

Status CodeDescription
200Successful Response

Get Chute

Load a chute by ID or name.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_id_or_namestringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Update Common Attributes

Update readme, tagline, etc. (but not code, image, etc.).

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_id_or_namestringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Request Body

FieldTypeRequiredDescription
taglinestring | nullNo
readmestring | nullNo
tool_descriptionstring | nullNo
logo_idstring | nullNo
max_instancesinteger | nullNo
scaling_thresholdnumber | nullNo
shutdown_after_secondsinteger | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Delete Chute

Delete a chute by ID.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_idstringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Easy Deploy Vllm Chute

Easy/templated vLLM deployment.

Endpoint:

Parameters

ParameterTypeRequiredDescription
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Request Body

FieldTypeRequiredDescription
modelstringYes
logo_idstring | nullNo
taglinestring | nullNo
tool_descriptionstring | nullNo
readmestring | nullNo
publicboolean | nullNo
node_selectorNodeSelector | nullNo
engine_argsVLLMEngineArgs | nullNo
revisionstring | nullNo
concurrencyinteger | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Easy Deploy Diffusion Chute

Easy/templated diffusion deployment.

Endpoint:

Parameters

ParameterTypeRequiredDescription
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Request Body

FieldTypeRequiredDescription
modelstringYes
namestringYes
logo_idstring | nullNo
taglinestring | nullNo
tool_descriptionstring | nullNo
readmestring | nullNo
publicboolean | nullNo
node_selectorNodeSelector | nullNo
concurrencyinteger | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Get Bounty List

List available bounties, if any.

Endpoint:

Responses

Status CodeDescription
200Successful Response