Docs
Images API Reference
This section covers all endpoints related to images.
Stream Build Logs
GET/images/{image_id}/logs
API
Code Examples
curl -X GET "https://api.chutes.ai/images/{image_id}/logs"
-H "Content-Type: application/json"Request Configuration
Authorization
Endpoint:
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.
GET/images/
API
Code Examples
curl -X GET "https://api.chutes.ai/images/"
-H "Content-Type: application/json"Request Configuration
Authorization
Endpoint:
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.
POST/images/
API
Code Examples
curl -X POST "https://api.chutes.ai/images/"
-H "Content-Type: application/json"Request Configuration
Authorization
Endpoint:
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.
GET/images/{image_id_or_name}
API
Code Examples
curl -X GET "https://api.chutes.ai/images/{image_id_or_name}"
-H "Content-Type: application/json"Request Configuration
Authorization
Endpoint:
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.
DELETE/images/{image_id_or_name}
API
Code Examples
curl -X DELETE "https://api.chutes.ai/images/{image_id_or_name}"
-H "Content-Type: application/json"Request Configuration
Authorization
Endpoint:
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.