API Reference
API v2 (Current Version)
Account & System
Account Summary

Account Summary

Retrieve your account summary including credits information and usage statistics.

Endpoint

GET /v2/account/summary

Description

Retrieve your account summary including credits information and usage statistics.

Headers

X-API-KEY string (required) : Your API key for authentication

Example Request

curl https://api.translateplus.io/v2/account/summary \
  -H "X-API-KEY: your_api_key"

Success Response (200 OK)

{
  "email": "user@example.com",
  "full_name": "John Doe",
  "total_credits": 1000,
  "credits_used": 250,
  "credits_remaining": 750,
  "credits_percentage": 25.0,
  "summary": {
    "total_requests": 1000,
    "successful_requests": 950,
    "failed_requests": 50,
    "success_rate": 95.0
  }
}

Response Fields

FieldTypeDescription
emailstringUser's email address
full_namestringUser's full name
total_creditsintegerTotal credits allocated to the account
credits_usedintegerNumber of credits used
credits_remainingintegerNumber of credits remaining
credits_percentagefloatPercentage of credits used
summaryobjectUsage statistics
summary.total_requestsintegerTotal number of API requests made
summary.successful_requestsintegerNumber of successful requests
summary.failed_requestsintegerNumber of failed requests
summary.success_ratefloatSuccess rate percentage

Error Responses

401 Unauthorized

Invalid or missing API key:

{
  "detail": "API key is required. Please provide X-API-KEY header."
}