Authentication

All API requests require a Bearer token in the Authorization header.

API keys

Create API keys at /api-keys. Keys are shown once on creation and cannot be retrieved later.

Include the key in the Authorization header:

CopyAuthorization: Bearer aug_your_api_key_here

Examples

Copyfrom auggie import AuggieClient

client = AuggieClient("aug_your_api_key_here")
ping = client.ping()
print(ping["status"])  # "ok"

Copycurl https://auggie.tools/v1/ping \
  -H "Authorization: Bearer aug_your_api_key_here"

Copyconst resp = await fetch("https://auggie.tools/v1/ping", {
  headers: { "Authorization": "Bearer aug_your_api_key_here" }
});
const data = await resp.json();
console.log(data.status);  // "ok"

Verify your key

Use the GET /v1/ping endpoint to verify your API key is valid:

Copy// Response
{
  "object": "ping",
  "status": "ok",
  "user_id": 42
}

Account info

Use GET /v1/account to check credits, subscription, and usage:

Copy// Response
{
  "object": "account",
  "user_id": 42,
  "email": "[email protected]",
  "credits": 150.0,
  "subscription": "pro",
  "org": "Acme Corp"
}