Account Details

Production server (Plus plan)

https://image-api.photoroom.com

GET

/v1/account

Get current account details, including remaining credits balance and monthly quota

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://image-api.photoroom.com/v1/account' \
--header 'x-api-key;'

响应示例

200 - 示例 1

{
    "credits": {
        "available": 100,
        "subscription": 100
    }
}

请求参数

Header 参数

x-api-key

string

必需

🟢200OK

application/json

Body

credits

object

必需

available

number

Available

必需

The number of credits available

示例值:

100

subscription

number

Subscription

必需

The number of credits available in the subscription

>= 0

示例值:

100

🟠400Bad Request