GET /v1/me/credits

Summary

Returns the total remaining credit balance for the authenticated user. Credits are consumed when you create runs. Use this endpoint to check your balance before executing prompts or to monitor usage.

HTTP Request

GET /v1/me/credits

Response

Success (200 OK)

Returns a JSON object whose status is "SUCCESS" and a data object containing:

Field	Type	Description
credits	integer	Total active credits remaining on the account.

Example response

{
  "status": "SUCCESS",
  "data": {
    "credits": 4250
  }
}

Error responses

HTTP status	status code	Description
401	UNAUTHORIZED_ERROR	Missing or invalid API key.

See also

• User info: GET /v1/me
• Create a run: POST /v1/runs — credits are deducted when a run is created.