Miner API Reference
This section covers all endpoints related to miner.
List Chutes
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 |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
List Images
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 |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
List Nodes
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 |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
List Instances
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| explicit_null | boolean | 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 Available Jobs
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 |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
Release Job
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| job_id | 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.
Get Full Inventory
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| X-Chutes-Hotkey | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Metrics
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 |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
Get Chute
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| chute_id | string | Yes | |
| version | 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.
Get Stats
Get invocation status over different intervals.
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| miner_hotkey | string | null | No | |
| per_chute | boolean | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Get Scores
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| hotkey | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Unique Chute History
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| hotkey | string | Yes | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Endpoint:
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
Get Utilization
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| hotkey | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Get Utilization Instances
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| hotkey | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |