> ## 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.

# Get an agent connection

> One connection, with its settings and latest sync. Credentials are never returned.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/connections/agent/{connectionId}
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/{connectionId}:
    get:
      tags:
        - Agent Connection
      summary: Get an agent connection
      description: >-
        One connection, with its settings and latest sync. Credentials are never
        returned.
      operationId: getV1ConnectionsAgentByConnectionId
      parameters:
        - in: path
          name: connectionId
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: The connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConnectionSingleResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      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.getByID('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');


            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.get_by_id(
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(response.data)
components:
  schemas:
    AgentConnectionSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AgentConnectionIntegration'
      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
    AgentConnectionIntegration:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        provider:
          $ref: '#/components/schemas/AgentConnectionProvider'
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: INACTIVE pauses syncing and call import without deleting anything.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/AgentConnectionCapability'
        agentScope:
          type:
            - string
            - 'null'
          enum:
            - ALL
            - SELECTED
          description: Null for platforms that do not scope by agent.
        agentIds:
          type: array
          items:
            type: string
          description: The platform's ids of the SELECTED agents.
        agentNames:
          type: array
          items:
            type: string
          description: Agents created by name.
        autoSetUpAgents:
          type: boolean
          description: >-
            When true, every agent this connection brings in is set up for
            testing as it arrives: Roark drafts its customer flows and metrics,
            the same as setting the agent up by hand. Defaults to false.
        samplingRate:
          type: number
        livekit:
          type:
            - object
            - 'null'
          properties:
            url:
              type: string
            metadataFilteringEnabled:
              type: boolean
            metadataEgressStrategy:
              type: string
              enum:
                - EAGER
                - DEFERRED
          required:
            - url
            - metadataFilteringEnabled
            - metadataEgressStrategy
          description: Set for LIVEKIT only.
        vapi:
          type:
            - object
            - 'null'
          properties:
            outboundRequestBodyTemplate:
              type:
                - object
                - 'null'
              additionalProperties: {}
          required:
            - outboundRequestBodyTemplate
          description: Set for VAPI only.
        pipecat:
          type:
            - object
            - 'null'
          properties:
            baseSignalingUrl:
              type:
                - string
                - 'null'
            appendAgentId:
              type: boolean
            hasAuthToken:
              type: boolean
            hasPccPublicKey:
              type: boolean
            pccStartBody:
              type:
                - object
                - 'null'
              additionalProperties: {}
            pccRoomProperties:
              type:
                - object
                - 'null'
              additionalProperties: {}
          required:
            - baseSignalingUrl
            - appendAgentId
            - hasAuthToken
            - hasPccPublicKey
            - pccStartBody
            - pccRoomProperties
          description: >-
            Set for the Pipecat providers only. Secrets are reported only as
            present or absent.
        kore:
          type:
            - object
            - 'null'
          properties:
            appId:
              type: string
            envName:
              type: string
            baseUrl:
              type:
                - string
                - 'null'
          required:
            - appId
            - envName
            - baseUrl
          description: Set for KORE only.
        googleCes:
          type:
            - object
            - 'null'
          properties:
            gcpProjectId:
              type: string
            serviceAccountEmail:
              type: string
            location:
              type: string
            appId:
              type: string
            deploymentId:
              type: string
            versionId:
              type:
                - string
                - 'null'
          required:
            - gcpProjectId
            - serviceAccountEmail
            - location
            - appId
            - deploymentId
            - versionId
          description: Set for GOOGLE_CES only.
        sync:
          oneOf:
            - $ref: '#/components/schemas/AgentConnectionSyncStatus'
            - type: 'null'
        syncProblems:
          type: array
          items:
            $ref: '#/components/schemas/AgentConnectionSyncProblem'
          description: >-
            Agents the latest sync could not bring in, and why. Empty when the
            sync is healthy.
        createdAt:
          type: string
          description: ISO 8601
          example: '2026-11-16T12:00:00.000Z'
        updatedAt:
          type:
            - string
            - 'null'
          description: ISO 8601
          example: '2026-11-16T12:00:00.000Z'
      required:
        - id
        - name
        - provider
        - status
        - capabilities
        - agentScope
        - agentIds
        - agentNames
        - autoSetUpAgents
        - samplingRate
        - livekit
        - vapi
        - pipecat
        - kore
        - googleCes
        - sync
        - syncProblems
        - createdAt
        - updatedAt
      description: >-
        A connection to the platform a project’s agents run on. Credentials are
        never returned; the API key Roark mints for an SDK-driven platform is
        returned once, on create.
    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.
    AgentConnectionSyncStatus:
      type: object
      properties:
        status:
          type:
            - string
            - 'null'
          enum:
            - IN_PROGRESS
            - COMPLETED
            - FAILED
          description: How the latest sync run went.
        startedAt:
          type:
            - string
            - 'null'
          description: ISO 8601
          example: '2026-11-16T12:00:00.000Z'
        endedAt:
          type:
            - string
            - 'null'
          description: ISO 8601
          example: '2026-11-16T12:00:00.000Z'
        intervalMinutes:
          type:
            - integer
            - 'null'
          description: How often the connection syncs.
        isUpToDate:
          type:
            - boolean
            - 'null'
        createdAgentCount:
          type:
            - integer
            - 'null'
          description: Agents the latest run brought in.
      required:
        - status
        - startedAt
        - endedAt
        - intervalMinutes
        - isUpToDate
        - createdAgentCount
      description: >-
        The latest scheduled sync. Null for platforms that report calls
        themselves rather than being pulled.
    AgentConnectionSyncProblem:
      type: object
      properties:
        agentId:
          type:
            - string
            - 'null'
          description: The platform's id of the agent the problem is with
        agentName:
          type:
            - string
            - 'null'
        reason:
          type:
            - string
            - 'null'
          description: >-
            Why the sync failed for it, such as INVALID_API_KEY or
            AGENT_NOT_FOUND.
          example: INVALID_API_KEY
        at:
          type: string
          description: ISO 8601
          example: '2026-11-16T12:00:00.000Z'
      required:
        - agentId
        - agentName
        - reason
        - at
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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