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

# Create an API key

> Create a new API key for the authenticated user's tenant.



## OpenAPI

````yaml /openapi.json post /api/v1/keys
openapi: 3.1.0
info:
  title: Eclatira API
  description: >-
    Programmatically create calls and batches, manage agents/tools/knowledge,
    and retrieve conversation analytics.
  contact:
    name: Eclatira Support
    email: contact@eclatira.com
  version: 1.0.0
servers:
  - url: https://app.eclatira.com
    description: API Server
security: []
tags:
  - name: developer-api
    description: >-
      The API-key-authenticated developer surface: calls, batches, and agents.
      Authenticate with `Authorization: Bearer ek_...`.
  - name: Calls
    description: Place outbound calls with an agent, check status, list history.
  - name: Batches
    description: 'Outbound call campaigns: create, list, inspect, cancel, retry.'
  - name: Agents
    description: Create and manage the agents that place and receive calls.
  - name: Tools
    description: Custom actions an agent can call mid-call, attached per-agent.
  - name: MCP Servers
    description: >-
      Connect an agent to an external MCP (Model Context Protocol) server so it
      can call that server's tools, with static or OAuth auth.
  - name: Knowledge Base
    description: Upload files and index them into an agent's knowledge base.
  - name: Realtime
    description: >-
      Mint a short-lived session token to open a live voice/video WebSocket
      connection: the only supported way for an API-key holder to authenticate
      into /ws/{user_id}.
  - name: Webhooks
    description: >-
      Register a durable callback URL to receive call.completed and
      batch.completed events for every matching workspace event, and fetch the
      tenant signing secret used to verify X-Webhook-Signature.
  - name: developer-api-keys
    description: >-
      Account-management routes (create/list/revoke API keys), authenticated via
      dashboard login, not an API key, since they mint the credentials the rest
      of the developer API uses.
paths:
  /api/v1/keys:
    post:
      tags:
        - developer-api-keys
      summary: Create an API key
      description: Create a new API key for the authenticated user's tenant.
      operationId: createApiKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreateApiKeyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ApiKeyCreatedResponse'
        '401':
          description: >-
            Missing or invalid dashboard session credentials (these routes use a
            dashboard session token, not an API key; see Authentication).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '403':
          description: >-
            No active workspace selected, no access to it, or the caller's role
            is below Developer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
          description: Unprocessable Content
      security:
        - DashboardSessionAuth: []
components:
  schemas:
    V1CreateApiKeyRequest:
      properties:
        name:
          type: string
          title: Name
          default: Default
      type: object
      title: V1CreateApiKeyRequest
    V1ApiKeyCreatedResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        key_prefix:
          type: string
          title: Key Prefix
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        last_used_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Used At
        revoked:
          type: boolean
          title: Revoked
        key:
          type: string
          title: Key
      type: object
      required:
        - id
        - name
        - key_prefix
        - revoked
        - key
      title: V1ApiKeyCreatedResponse
    V1ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/V1ErrorDetail'
      type: object
      required:
        - error
      title: V1ErrorResponse
      description: |-
        The error envelope every `developer-api`-tagged route returns for
        non-2xx responses, including `422`; this overrides FastAPI's default
        validation-error shape.
    V1ErrorDetail:
      properties:
        type:
          type: string
          title: Type
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
      type: object
      required:
        - type
        - code
        - message
      title: V1ErrorDetail
  securitySchemes:
    DashboardSessionAuth:
      type: http
      scheme: bearer
      description: >-
        A short-lived token tied to an authenticated dashboard user session, not
        an API key. Required only by the account-management routes for
        creating/listing/revoking API keys; obtaining one requires signing in
        through the dashboard, not something a third-party integration mints on
        its own.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.