Images API Reference

This section covers all endpoints related to images.

Stream Build Logs

Endpoint: GET /images/{image_id}/logs

Parameters

Parameter	Type	Required	Description
image_id	string	Yes
offset	string | null	No
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

List Images

List (and optionally filter/paginate) images.

Endpoint: GET /images/

Parameters

Parameter	Type	Required	Description
include_public	boolean | null	No
name	string | null	No
tag	string | null	No
page	integer | null	No
limit	integer | null	No
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Create Image

Create an image; really here we're just storing the metadata in the DB and kicking off the image build asynchronously.

Endpoint: POST /images/

Parameters

Parameter	Type	Required	Description
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
202	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Get Image

Load a single image by ID or name.

Endpoint: GET /images/{image_id_or_name}

Parameters

Parameter	Type	Required	Description
image_id_or_name	string	Yes
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Delete Image

Delete an image by ID or name:tag.

Endpoint: DELETE /images/{image_id_or_name}

Parameters

Parameter	Type	Required	Description
image_id_or_name	string	Yes
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---