Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ivory.finance/llms.txt

Use this file to discover all available pages before exploring further.

Authentication

All API key management endpoints require a valid JWT:
Authorization: Bearer <access_token>
API keys generated here are used as the X-API-Key header on gateway-authenticated endpoints.

List API keys

curl https://api.ivory.finance/v1/user/keys \
  -H "Authorization: Bearer $IVORY_JWT"
{
  "keys": [
    {
      "id": "3a2b1c0d-...",
      "key": "ivk_live_abc123xyz789",
      "created_at": "2026-01-10T08:00:00Z",
      "last_used_at": "2026-03-25T14:22:00Z"
    }
  ]
}

Create API key

The number of keys you can create is limited by your tier (Free: 1, Pro: 5, Enterprise: 50).
curl -X POST https://api.ivory.finance/v1/user/keys \
  -H "Authorization: Bearer $IVORY_JWT"
{
  "id": "7f8e9d0c-...",
  "key": "ivk_live_newkey456def",
  "created_at": "2026-03-26T10:00:00Z"
}

Revoke API key

Immediately invalidates the key at the gateway. All requests using this key will receive 401 Unauthorized.
curl -X DELETE https://api.ivory.finance/v1/user/keys/3a2b1c0d-... \
  -H "Authorization: Bearer $IVORY_JWT"
{
  "message": "API key revoked successfully"
}