> ## Documentation Index
> Fetch the complete documentation index at: https://docs.echozero.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate a new API key + secret key pair

> Creates a new API key. The raw key and secret are returned only once and cannot be retrieved later. Store them securely.



## OpenAPI

````yaml https://mcp.echozero.app/api/docs-json post /api/api-keys
openapi: 3.0.0
info:
  title: EchoZero MCP API
  description: >-
    EchoZero MCP Server - Developer API for agent management, trading,
    marketplace, and AI chat.


    **Rate Limiting:** All endpoints enforce per-API-key rate limits. Tiers:
    free (60 req/min), standard (300 req/min), premium (1000 req/min). Every
    response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`,
    `X-RateLimit-Reset` headers. Exceeding the limit returns `429 Too Many
    Requests` with a `Retry-After` header.
  version: '1.0'
  contact: {}
servers:
  - url: https://mcp.echozero.app
    description: Production
security: []
tags:
  - name: MCP Protocol
    description: >-
      Model Context Protocol (Streamable HTTP): `/mcp`, `/mcp/sse` — not under
      `/api`; same API key as REST
  - name: Health
    description: Server health check
  - name: API Keys
    description: API key generation, listing, and revocation
  - name: User
    description: >-
      User profile, sessions, social, onboarding, internal agent subscriptions,
      and bot activations (v1: /v1/users/me)
  - name: Token
    description: Token data and trending
  - name: Trade
    description: Trade execution and history
  - name: Strategy
    description: Strategy (trading bot) configuration and control
  - name: Agent
    description: Agent registration and management
  - name: AI
    description: AI chat, intent, and insights
  - name: Wallet
    description: Wallet operations, deposits, and withdrawals
  - name: Notification
    description: Notification management and settings
  - name: Auth
    description: >-
      Public authentication: signup / login lookup, code verification, Google
      OAuth, refresh, and sign-out. Returns `accessToken` / `refreshToken` in
      the JSON body.
  - name: OAuth
    description: >-
      OAuth 2.1 authorization-code + PKCE for AI assistant clients:
      `/oauth/authorize`, `/oauth/token`, `/oauth/introspect`, `/status`.
  - name: Activity
    description: User trade activity list and search
  - name: Feed
    description: Social activity feed timeline
  - name: Earn
    description: Leaderboard, rewards, and referrals
  - name: Statics
    description: Countries, languages, and static data
  - name: Misc
    description: File uploads and utility endpoints
  - name: Developer
    description: Developer registration and profile
  - name: Developer dashboard
    description: >-
      Per-agent dashboard: subscribers (anonymized), performance detail, signal
      history (v1)
  - name: Developer Agent
    description: Developer agent listings and management
  - name: Developer Agents (Marketplace)
    description: Public browse, search, and subscribe to external developer-listed agents
  - name: Admin
    description: Admin-only endpoints for review, approval, and platform management
  - name: Webhooks
    description: >-
      Inbound provider webhooks (no API key). Telegram signal-bot uses
      `X-Telegram-Bot-Api-Secret-Token` when configured.
paths:
  /api/api-keys:
    post:
      tags:
        - API Keys
      summary: Generate a new API key + secret key pair
      description: >-
        Creates a new API key. The raw key and secret are returned only once and
        cannot be retrieved later. Store them securely.
      operationId: McpApiKeyController_create
      parameters:
        - name: x-signature
          in: header
          required: false
          description: >-
            HMAC-SHA256 signature: HMAC-SHA256(secretKey, timestamp + METHOD +
            path + body). Optional -- when omitted, HMAC verification is
            skipped.
          schema:
            type: string
        - name: x-timestamp
          in: header
          required: false
          description: >-
            Request timestamp in epoch milliseconds. Required when x-signature
            is provided. Rejected if drift exceeds 5 minutes.
          schema:
            type: string
      requestBody:
        required: true
        description: OpenAPI schema **CreateApiKeyDto**.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyDto'
            examples:
              minimal:
                summary: Name only
                description: Uses default type and implicit non-admin scopes when omitted.
                value:
                  name: CI / automation key
              fullAllFields:
                summary: All body fields
                value:
                  name: Trading terminal
                  type: platform
                  scopes:
                    - agents:read
                    - write:strategies
                    - read:trades
                  expiresAt: '2027-01-01T00:00:00.000Z'
      responses:
        '201':
          description: API key created successfully. Raw key and secret returned.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/McpSuccessResponseDto'
                  - properties:
                      data:
                        $ref: '#/components/schemas/ApiKeyCreateResponseDto'
        '400':
          description: Validation error (missing name, name too long, invalid scope).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpErrorResponseDto'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpErrorResponseDto'
        '403':
          description: Key type not allowed (developer/internal).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpErrorResponseDto'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpErrorResponseDto'
      security:
        - bearer-jwt: []
        - api-key: []
components:
  schemas:
    CreateApiKeyDto:
      type: object
      properties:
        name:
          type: string
          description: Human-readable name for the API key
        type:
          type: string
          enum:
            - platform
            - developer
            - internal
          default: platform
          description: >-
            Key type: platform (standard), developer (external agent
            developers), internal (admin only)
        scopes:
          type: array
          description: >-
            Permission scopes. Defaults to all public, non-admin scopes if
            omitted. admin:* cannot be created through this API.
          items:
            type: string
            enum:
              - agents:read
              - agents:write
              - trades:read
              - trades:execute
              - bots:read
              - bots:write
              - marketplace:read
              - ai:chat
              - read:tokens
              - read:trades
              - read:strategies
              - write:strategies
              - read:wallet
              - write:wallet
              - read:agents
              - write:agents
              - read:ai
              - write:ai
              - read:earn
              - read:notifications
              - write:notifications
              - read:analytics
              - admin:*
        expiresAt:
          format: date-time
          type: string
          description: Expiration date for the key
      required:
        - name
    McpSuccessResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          description: Endpoint-specific payload
          additionalProperties: true
      required:
        - success
        - data
    ApiKeyCreateResponseDto:
      type: object
      properties:
        rawKey:
          type: string
        rawSecretKey:
          type: string
        apiKey:
          $ref: '#/components/schemas/ApiKeyItemResponseDto'
      required:
        - rawKey
        - rawSecretKey
        - apiKey
    McpErrorResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          $ref: '#/components/schemas/McpErrorBodyDto'
      required:
        - success
        - error
    ApiKeyItemResponseDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        keyPrefix:
          type: string
        type:
          type: string
          enum:
            - platform
            - developer
            - internal
        rateLimitTier:
          type: string
          enum:
            - free
            - standard
            - premium
        scopes:
          type: array
          items:
            type: string
            enum:
              - agents:read
              - agents:write
              - trades:read
              - trades:execute
              - bots:read
              - bots:write
              - marketplace:read
              - ai:chat
              - read:tokens
              - read:trades
              - read:strategies
              - write:strategies
              - read:wallet
              - write:wallet
              - read:agents
              - write:agents
              - read:ai
              - write:ai
              - read:earn
              - read:notifications
              - write:notifications
              - read:analytics
              - admin:*
        status:
          type: string
          enum:
            - ACTIVE
            - REVOKED
        lastUsedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - keyPrefix
        - type
        - rateLimitTier
        - scopes
        - status
        - createdAt
    McpErrorBodyDto:
      type: object
      properties:
        code:
          type: string
          example: NOT_FOUND
        message:
          type: string
          example: Resource not found
      required:
        - code
        - message
  securitySchemes:
    bearer-jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: >-
        User JWT access token issued by `POST /api/auth/verify` or `POST
        /api/auth/social/verify`. Routes that accept both auth modes declare
        `api-key` *and* `bearer-jwt` security schemes.
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````