⛓️API Overview

AI-as-a-Service for your tools and applications.

Alphakek AI gives developers access to all of our functionalitiesβ€”Alpha Chat, Alpha Alerts, and Alpha Visualsβ€”via open, modular, and composable APIs. Designed for applications such as:

  • Chatbots

  • Image generation

  • Crypto research

  • Community engagement

  • Drafting documents

  • Answering questions about a knowledge base

  • and much more

Modules


Further reading:

Authentification


To start using the API, the user must first obtain the access token. After logging in with Metamask or WalletConnect on alphakek.ai, open the API Keys tab on the user profile page.

Note that the newly created token will never be shown on the screen. Instead, it will be copied to the copy buffer immediately for security reasons.

Account Data


The /account endpoint allows users to see their current balances of:

This API endpoint is free to use.

Get User Info

GET/account
Authorization
Response

Successful Response

Body
address*Address

User's Ethereum address in lowercase

credits*Credits
tokensTokens

User's tokens balance

tokens_usdTokens Usd

User's tokens balance in USD

bonusesBonuses

List of user's bonuses

dialogs*Dialogs

List of user's dialogs' IDs

max_dialogsMax Dialogs

Maximum number of dialogs per user

tierall of

User tier

telegram_idTelegram Id

User's Telegram ID

balance_detailsany of

User's token balance details

Request
const response = await fetch('/account', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();
Response
{
  "address": "text",
  "credits": 0,
  "tokens": 0,
  "tokens_usd": 0,
  "bonuses": [
    {
      "usd_value": 0,
      "description": "text"
    }
  ],
  "tier": {},
  "balance_details": {
    "eth_balance_tokens": 0,
    "eth_balance_usd": 0,
    "base_balance_tokens": 0,
    "base_balance_usd": 0,
    "total_balance_tokens": 0,
    "total_balance_usd": 0
  }
}
πŸ“–API Usage Examples

Last updated