GET https://api.copyleaks.com/v3/scans/credits

Get your current credit balance. Each credit allow the scan of up to 250 words.

Authentication Required

You need to login with a user and api key in order to access this method. Add this HTTP header to your request:

Authorization: Bearer < Your-Login-Token >

Need Help?

Not sure how to generate your login token? Read here.

Request

Headers

Authorization: Bearer YOUR_LOGIN_TOKEN

Responses

200

200 OK

The command was executed.

Response Schema

The response contains the following fields:

Amount integer

The number of credits available.

Example Response

A typical response from this endpoint:

{
  "Amount": 100
}

401

401 Unauthorized

Authorization has been denied for this request.

Example Response

A typical response from this endpoint:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.2",
  "title": "Unauthorized",
  "status": 401,
  "traceId": "00-ef0db7690ced98431ac97782051edc77-2c4194d74ae6c08b-00"
}

Examples

HTTP

GET https://api.copyleaks.com/v3/scans/credits
Authorization: Bearer YOUR_LOGIN_TOKEN

cURL

curl --request GET \
  --url https://api.copyleaks.com/v3/scans/credits \
  --header 'Authorization: Bearer YOUR_LOGIN_TOKEN'