Check API Key Status

GET https://api.neosantara.xyz/v1/auth/key

Check API Key Status

cURL

curl --request GET \
  --url https://api.neosantara.xyz/v1/auth/key \
  --header 'x-api-key: <api-key>'

200

{
  "object": "<string>",
  "id": "<string>",
  "authorized": true,
  "tier": "<string>",
  "permissions": [
    {}
  ],
  "usage_info": {
    "daily": {
      "used": 123,
      "limit": 123,
      "remaining": 123,
      "reset_at": "<string>"
    },
    "monthly": {
      "used": 123,
      "limit": 123,
      "remaining": 123,
      "reset_at": "<string>"
    }
  },
  "organization": "<string>",
  "created": 123,
  "_metadata": {
    "status": true,
    "processing_time": 123,
    "timestamp": "<string>"
  }
}

Verify your access

Use this endpoint to validate your API Key, check your current subscription Tier, and monitor your Daily and Monthly token usage limits.

Returns

object · string

Always “authorization”.

id · string

Unique identifier for this authorization check (format: auth- + 16 hex chars).

authorized · boolean

Indicates if the provided API Key is valid and active.

tier · string

The current tier of the API Key (e.g., “Free”, “Developer”, “Production”).

permissions · array

List of capabilities granted to this key (e.g., chat.completions, embeddings).

usage_info · object

Detailed breakdown of token usage and limits.

Hide usage_info properties

daily · object

Show daily properties

used · integer

Tokens used today.

limit · integer

Daily token limit.

remaining · integer

Remaining tokens for today.

reset_at · string

Next daily reset timestamp.

monthly · object

Show monthly properties

used · integer

Tokens used this month.

limit · integer

Monthly token limit.

remaining · integer

Remaining tokens for this month.

reset_at · string

Next monthly reset timestamp.

organization · string

The organization identifier (default: org-neosantara-ai).

created · integer

Unix timestamp of the check.

_metadata · object

Internal debugging and status information.

Show _metadata properties

status · boolean

System status check.

processing_time · integer

Time taken to process request (ms).

timestamp · string

ISO timestamp of the request.

Return Examples

Response 200

{
  "object": "authorization",
  "organization": "org-neosantara-ai",
  "permissions": [
    "chat.completions",
    "embeddings",
    "moderations"
  ],
  "authorized": true,
  "created": 1741477200,
  "expires": null,
  "id": "auth-a1b2c3d4e5f6g7h8",
  "tier": "Developer",
  "usage_info": {
    "daily": {
      "used": 1500,
      "limit": 50000,
      "remaining": 48500,
      "reset_at": "2025-11-16T00:00:00.000Z"
    },
    "monthly": {
      "used": 45000,
      "limit": 2000000,
      "remaining": 1955000,
      "reset_at": "2025-12-01T00:00:00.000Z"
    }
  },
  "_metadata": {
    "creator": "neosantara.xyz",
    "status": true,
    "processing_time": 45,
    "timestamp": "2025-11-15T10:20:00.123Z"
  }
}