Skip to main content
GET
/
v1
/
user
/
account
Retrieve account details
curl --request GET \
  --url https://api.example.com/v1/user/account \
  --header 'Authorization: <api-key>'
{
  "status": "<string>",
  "name": "<string>",
  "email": "<string>",
  "statusCode": 123,
  "usage": {
    "remainingCredits": 123
  },
  "requestCompletionTime": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}
Note: This operation does not consume any account credits, but rate limits apply.

​
Retrieve Account Details

This endpoint retrieves the account details of the authenticated user, including their name, email, and the number of remaining credits.

​
Request

  • Endpoint: GET /user/account
  • Authorization: Bearer token required

​
Response

A successful response will return the user’s account details and information about the remaining credits.

​
Example Response

{
   "status": "success",
   "name": "John Doe",
   "email": "john.doe@example.com",
   "statusCode": 200,
   "usage": {
      "remainingCredits": 5
   },
   "requestCompletionTime": "50 ms",
   "timestamp": "2024-09-12T02:44:45.213Z"
}

Authorizations

​
Authorization
string
header
required

Use format Bearer YOUR_API_KEY.

Response

Account details retrieved successfully

​
status
string
​
name
string
​
email
string
​
statusCode
integer
​
usage
object
​
requestCompletionTime
string
​
timestamp
string<date-time>