transfer credit

Transfers specified amount of credits from the authenticated user’s account to another user’s account.

The recipient can be specified by either email address or user ID.

CLI Usage: vastai transfer credit <recipient_email> <amount>

PUT /api/v0/commands/transfer_credit

transfer credit

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/commands/transfer_credit/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": "[e-mail]",
  "amount": 100,
  "client_id": "me",
  "apikey_id": "<string>"
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

recipient · string · required

Email address or user ID of the recipient

Example:

"[e-mail]"

amount · number<float> · required

Amount of credits to transfer (must be positive)

Required range: x >= 0.01

Example:

100

client_id · string

Client identifier (usually "me")

Example:

"me"

apikey_id · string

Optional API key identifier for audit logging

Response

200

application/json

Transfer completed successfully

success · boolean

Example:

true