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

# List agent connection providers

> Every platform a project can connect, with the fields its create body needs, how its calls reach Roark, and which settings apply. Read this before connecting one.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/connections/agent/providers
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/connections/agent/providers:
    get:
      tags:
        - Agent Connection
      summary: List agent connection providers
      description: >-
        Every platform a project can connect, with the fields its create body
        needs, how its calls reach Roark, and which settings apply. Read this
        before connecting one.
      operationId: getV1ConnectionsAgentProviders
      responses:
        '200':
          description: The providers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConnectionProvidersResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const response = await client.agentConnection.listProviders();

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.agent_connection.list_providers()
            print(response.data)
components:
  schemas:
    AgentConnectionProvidersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AgentConnectionProviderInfo'
      required:
        - data
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    AgentConnectionProviderInfo:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/AgentConnectionProvider'
        label:
          type: string
          example: Retell
        ingestion:
          type: string
          enum:
            - SYNC
            - WEBHOOK
            - SDK
            - NONE
          description: >-
            How calls reach Roark. SYNC: Roark pulls them on a schedule.
            WEBHOOK: the platform sends them as rooms end. SDK: your code
            reports them with the returned `observerApiKey`. NONE: the
            connection is for testing only.
        requiredFields:
          type: array
          items:
            type: string
          description: Create-body fields this provider requires.
        supportsAgentDiscovery:
          type: boolean
          description: >-
            Whether `discover` can list its agents, so a connection can be
            scoped by id.
        supportedCapabilities:
          type: array
          items:
            $ref: '#/components/schemas/AgentConnectionCapability'
        defaultCapabilities:
          type: array
          items:
            $ref: '#/components/schemas/AgentConnectionCapability'
        supportsAutoSetUp:
          type: boolean
          description: Whether `autoSetUpAgents` applies.
        supportsBackfill:
          type: boolean
          description: Whether past calls can be imported with a backfill.
        multipleConnections:
          type: boolean
          description: >-
            Whether a project may connect more than one account. Otherwise a
            second create returns 409.
      required:
        - provider
        - label
        - ingestion
        - requiredFields
        - supportsAgentDiscovery
        - supportedCapabilities
        - defaultCapabilities
        - supportsAutoSetUp
        - supportsBackfill
        - multipleConnections
    AgentConnectionProvider:
      type: string
      enum:
        - RETELL
        - VAPI
        - ELEVEN_LABS
        - BLAND
        - LEAPING
        - LIVEKIT
        - LIVEKIT_SELF_HOSTED
        - PIPECAT_CLOUD_INTEGRATION
        - PIPECAT_SELF_HOSTED_INTEGRATION
        - KORE
        - GOOGLE_CES
      description: >-
        The platform the agents run on. LIVEKIT is LiveKit Cloud;
        LIVEKIT_SELF_HOSTED is the LiveKit Agents SDK reporting through the
        Roark plugin. PIPECAT_CLOUD_INTEGRATION and
        PIPECAT_SELF_HOSTED_INTEGRATION are Pipecat Cloud and a self-hosted
        Pipecat bot. `GET /v1/connections/agent/providers` describes what each
        one needs.
    AgentConnectionCapability:
      type: string
      enum:
        - PULL_AGENTS
        - PULL_CALLS
        - PUSH_AGENT_CONFIG
      description: >-
        PULL_AGENTS imports the agents (and their prompts and tools) into Roark.
        PULL_CALLS imports production calls for analysis, and needs PULL_AGENTS
        on platforms that pull agents. PUSH_AGENT_CONFIG lets Roark write a
        verified fix back to the agent, only ever after a person applies it.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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