Get your balance

GET/v1/credits

#Authentication

#Headers

#Response

200 Success.

• request_idstringrequired
• objectstringrequired

  always "credits"

• planstringrequired

  Your plan.

  One of: free, unlimited

• unlimitedbooleanrequired

  true on the unlimited plan: checks use no credits and available is null.

• availableinteger or nullrequired

  Credits you can use; null on the unlimited plan.

• reservedintegerrequired

  Credits held by checks that are still running.

• price_per_operationintegerrequired

  Credits one completed check uses (0 on the unlimited plan).

#Example response

{
  "request_id": "req_8f14e45fceea167a5a36dedd",
  "object": "credits",
  "plan": "free",
  "unlimited": false,
  "available": 1000,
  "reserved": 0
}

#Errors

Error bodies share one shape with a stable error.code; see Errors for every code and how to fix it.

#Code samples

curl "https://platform.detectif.ai/v1/credits" \
  -H "Authorization: Bearer $DETECTIF_API_KEY"

import os

import requests

resp = requests.get(
    "https://platform.detectif.ai/v1/credits",
    headers={"Authorization": f"Bearer {os.environ['DETECTIF_API_KEY']}"},
    timeout=30,
)
print(resp.status_code, resp.json())

const res = await fetch("https://platform.detectif.ai/v1/credits", {
  headers: {
    Authorization: `Bearer ${process.env.DETECTIF_API_KEY}`,
  },
});
console.log(res.status, await res.json());