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

# List agents

> Returns a cursor-paginated list of agents belonging to your organization. Results are ordered newest-first.



## OpenAPI

````yaml get /v2/agents
openapi: 3.0.3
info:
  title: OpenMic External API v2
  version: '2.0'
  description: >-
    The OpenMic External API (v2) provides programmatic access to agents, calls,

    phone numbers, tools, contact lists, campaigns, and voices.


    ## Authentication

    All endpoints require an API key passed as a Bearer token in the

    `Authorization` header:

    ```

    Authorization: Bearer <your_api_key>

    ```


    ## Rate Limiting

    Most endpoints are limited to **100 requests per minute** per organization.

    The `POST /create-phone-call` endpoint has a stricter limit of **5 requests
    per minute**.
  contact:
    name: OpenMic Support
servers:
  - url: https://api.openmic.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Verify API key identity.
  - name: Agents
    description: Create and manage voice AI agents.
  - name: Calls
    description: Initiate and track phone calls.
  - name: Phone Numbers
    description: Manage phone numbers and agent assignments.
  - name: Tools
    description: Manage agent tools (API requests, call transfers, etc.).
  - name: Contact Lists
    description: Manage contact lists and individual contacts.
  - name: Campaigns
    description: Create and manage outbound dialing campaigns.
  - name: Voices
    description: Browse available voices for agents.
  - name: SMS
    description: Send SMS messages.
paths:
  /v2/agents:
    get:
      tags:
        - Agents
      summary: List agents
      description: >-
        Returns a cursor-paginated list of agents belonging to your
        organization. Results are ordered newest-first.
      operationId: listAgents
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - name: name
          in: query
          schema:
            type: string
          description: Case-insensitive partial match on the agent name.
        - $ref: '#/components/parameters/CreatedAfter'
        - $ref: '#/components/parameters/CreatedBefore'
      responses:
        '200':
          description: Paginated list of agents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAgentsResponse'
              example:
                agents:
                  - uid: agent_abc123
                    name: Sales Agent
                    prompt: You are a helpful sales agent...
                    voice_provider: ElevenLabs
                    created_at: '2024-01-15T10:30:00Z'
                    updated_at: '2024-01-15T10:30:00Z'
                has_more: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    PageSize:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
      description: Number of records per page (default 50, max 100).
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
      description: Opaque pagination cursor returned by the previous response.
    CreatedAfter:
      name: created_after
      in: query
      schema:
        type: string
        format: date-time
      description: Filter records created on or after this ISO 8601 timestamp.
    CreatedBefore:
      name: created_before
      in: query
      schema:
        type: string
        format: date-time
      description: Filter records created on or before this ISO 8601 timestamp.
  schemas:
    ListAgentsResponse:
      allOf:
        - $ref: '#/components/schemas/PaginationMeta'
        - type: object
          required:
            - agents
            - has_more
          properties:
            agents:
              type: array
              items:
                $ref: '#/components/schemas/AgentResponse'
    PaginationMeta:
      type: object
      properties:
        has_more:
          type: boolean
          description: Whether more records exist after this page.
        next_cursor:
          type: string
          description: Opaque cursor to pass as `cursor` in the next request.
    AgentResponse:
      type: object
      required:
        - uid
        - name
        - prompt
        - created_at
        - updated_at
      properties:
        uid:
          type: string
          description: Unique agent identifier (slug/UUID).
        name:
          type: string
        prompt:
          type: string
        first_message:
          type: string
        auto_first_message:
          type: boolean
        knowledge_base_id:
          type: integer
        voice_provider:
          type: string
          enum:
            - OpenAI
            - ElevenLabs
            - Deepgram
            - Cartesia
        voice:
          type: string
        voice_model:
          type: string
        voice_speed:
          type: number
        llm_model_name:
          type: string
        llm_model_temperature:
          type: number
          minimum: 0
          maximum: 2
        llm_max_tokens:
          type: integer
        stt_provider:
          type: string
          enum:
            - Deepgram
        stt_model:
          type: string
        auto_end_call:
          type: boolean
        call_settings:
          $ref: '#/components/schemas/CallSettings'
        advanced_settings:
          $ref: '#/components/schemas/AdvancedSettings'
        boosted_keywords:
          type: array
          items:
            type: string
          maxItems: 30
        selected_jargons:
          type: array
          items:
            type: string
        post_call_settings:
          $ref: '#/components/schemas/PostCallSettings'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        details:
          type: string
    CallSettings:
      type: object
      properties:
        max_call_duration:
          type: integer
          minimum: 2
          maximum: 30
          description: Maximum call duration in minutes.
        silence_timeout:
          type: integer
          minimum: 5
          maximum: 45
          description: Seconds of silence before timing out.
        silence_timeout_max_retries:
          type: integer
          minimum: 1
          maximum: 5
        silence_timeout_message:
          type: string
        call_recording_enabled:
          type: boolean
        voicemail_detection_enabled:
          type: boolean
        voicemail_action:
          type: string
          enum:
            - hangup
            - leave_message
        voicemail_message_type:
          type: string
          enum:
            - prompt
            - static
        voicemail_message:
          type: string
        voicemail_post_detection_delay:
          type: integer
          minimum: 0
          maximum: 30
        hipaa_compliance_enabled:
          type: boolean
        pci_compliance_enabled:
          type: boolean
    AdvancedSettings:
      type: object
      properties:
        agent_personality:
          type: string
          enum:
            - casual
            - humorous
            - direct
            - formal
            - persuasive
            - friendly
        humanize_conversation:
          type: boolean
        background_noise_reduction:
          type: boolean
        allow_interruptions:
          type: boolean
        min_interruption_duration:
          type: number
          minimum: 0.2
          maximum: 5
        background_sound:
          type: string
        agent_response_length:
          type: string
          enum:
            - normal
            - short
            - concise
            - long
        short_pause:
          type: number
          minimum: 0.2
          maximum: 2
        long_pause:
          type: number
          minimum: 0.5
          maximum: 6
        filter_phrases:
          type: string
    PostCallSettings:
      type: object
      properties:
        summary_prompt:
          type: string
        success_evaluation_prompt:
          type: string
        success_evaluation_rubric_type:
          type: string
          enum:
            - NUMERIC_SCALE
            - DESCRIPTIVE_SCALE
            - PERCENTAGE_SCALE
            - LIKERT_SCALE
            - PASS_FAIL
            - SENTIMENT
        structured_extraction_prompt:
          type: string
        structured_extraction_json_schema:
          type: object
          description: A valid JSON Schema object describing the fields to extract.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              message:
                type: string
              error:
                type: string
              retryAfter:
                type: integer
    InternalServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key obtained from the OpenMic dashboard.

````