Users API Reference

This section covers all endpoints related to users.

Get User Growth

Endpoint: GET /users/growth

Responses

Status Code	Description
200	Successful Response

---

Admin User Id Lookup

Endpoint: GET /users/user_id_lookup

Parameters

Parameter	Type	Required	Description
username	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.

---

Admin Balance Change

Endpoint: POST /users/admin_balance_change

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

Request Body

Field	Type	Required	Description
user_id	string	Yes
amount	number	Yes
reason	string	Yes

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Admin Quotas Change

Endpoint: POST /users/{user_id}/quotas

Parameters

Parameter	Type	Required	Description
user_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.

---

Admin Discounts Change

Endpoint: POST /users/{user_id}/discounts

Parameters

Parameter	Type	Required	Description
user_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.

---

Admin Enable Invoicing

Endpoint: POST /users/{user_id}/enable_invoicing

Parameters

Parameter	Type	Required	Description
user_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.

---

Me

Get a detailed response for the current user.

Endpoint: GET /users/me

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.

---

Delete My User

Delete account.

Endpoint: DELETE /users/me

Parameters

Parameter	Type	Required	Description
Authorization	string	Yes	Authorization header

Responses

Status Code	Description
200	Successful Response
422	Validation Error

---

My Quotas

Load quotas for the current user.

Endpoint: GET /users/me/quotas

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.

---

My Discounts

Load discounts for the current user.

Endpoint: GET /users/me/discounts

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.

---

Chute Quota Usage

Check the current quota usage for a chute.

Endpoint: GET /users/me/quota_usage/{chute_id}

Parameters

Parameter	Type	Required	Description
chute_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.

---

Set Logo

Get a detailed response for the current user.

Endpoint: GET /users/set_logo

Parameters

Parameter	Type	Required	Description
logo_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.

---

Check Username

Check if a username is valid and available.

Endpoint: GET /users/name_check

Parameters

Parameter	Type	Required	Description
username	string	Yes

Responses

Status Code	Description
200	Successful Response
422	Validation Error

---

Register

Register a user.

Endpoint: POST /users/register

Parameters

Parameter	Type	Required	Description
X-Chutes-Hotkey	string	Yes	The hotkey of the user
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Request Body

Field	Type	Required	Description
username	string	Yes
coldkey	string	Yes
logo_id	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Admin Create User

Create a new user manually from an admin account, no bittensor stuff necessary.

Endpoint: POST /users/create_user

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

Request Body

Field	Type	Required	Description
username	string	Yes
logo_id	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Change Fingerprint

Reset a user's fingerprint using either the hotkey or coldkey.

Endpoint: POST /users/change_fingerprint

Parameters

Parameter	Type	Required	Description
X-Chutes-Hotkey	string | null	No
X-Chutes-Coldkey	string | null	No
X-Chutes-Nonce	string	Yes	Nonce
X-Chutes-Signature	string	Yes	Hotkey signature

Request Body

Field	Type	Required	Description
fingerprint	string	Yes

Responses

Status Code	Description
200	Successful Response
422	Validation Error

---

Fingerprint Login

Exchange the fingerprint for a JWT.

Endpoint: POST /users/login

Responses

Status Code	Description
200	Successful Response

---

Change Bt Auth

Change the bittensor hotkey/coldkey associated with an account via fingerprint auth.

Endpoint: POST /users/change_bt_auth

Parameters

Parameter	Type	Required	Description
Authorization	string	Yes

Responses

Status Code	Description
200	Successful Response
422	Validation Error

---

Update Squad Access

Enable squad access.

Endpoint: PUT /users/squad_access

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 Usage

List usage summary data.

Endpoint: GET /users/me/usage

Parameters

Parameter	Type	Required	Description
page	integer | null	No
limit	integer | null	No
per_chute	boolean | null	No
chute_id	string | null	No
start_date	string | null	No
end_date	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.

---