find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/roark:roark-agent-endpoint-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Roark Analytics Agent Endpoint 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: Agent Endpoint
paths:
  /v1/agent/endpoint:
    get:
      responses:
        '200':
          description: List of agent endpoints
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AgentEndpointDetailResponse'
                  pagination:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total number of items
                      hasMore:
                        type: boolean
                        description: Whether there are more items to fetch
                      nextCursor:
                        type:
                        - string
                        - 'null'
                        description: Cursor for the next page of items
                    required:
                    - total
                    - hasMore
                    - nextCursor
                required:
                - data
                - pagination
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '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
      operationId: getV1AgentEndpoint
      tags:
      - Agent Endpoint
      summary: List agent endpoints
      description: Returns a paginated list of agent endpoints for the authenticated project.
      parameters:
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 20
          description: 'Maximum number of endpoints to return (default: 20, max: 50)'
      - in: query
        name: after
        schema:
          type: string
          description: Cursor for pagination - endpoint ID to start after
      - in: query
        name: agentId
        schema:
          type: string
          format: uuid
          description: Filter by agent ID
      - in: query
        name: searchText
        schema:
          type: string
          description: Search text to filter endpoints
    post:
      responses:
        '201':
          description: The created agent endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AgentEndpointDetailResponse'
                required:
                - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '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
      operationId: postV1AgentEndpoint
      tags:
      - Agent Endpoint
      summary: Create a new agent endpoint
      description: Creates a new agent endpoint for the authenticated project.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentEndpointInput'
  /v1/agent/endpoint/{endpointId}:
    get:
      responses:
        '200':
          description: The requested agent endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AgentEndpointDetailResponse'
                required:
                - data
        '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
      operationId: getV1AgentEndpointByEndpointId
      tags:
      - Agent Endpoint
      summary: Get agent endpoint by ID
      description: Returns a specific agent endpoint by its ID.
      parameters:
      - name: endpointId
        in: path
        required: true
        description: The ID of the agent endpoint to retrieve
        schema:
          type: string
    put:
      responses:
        '200':
          description: The updated agent endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AgentEndpointDetailResponse'
                required:
                - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '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
      operationId: putV1AgentEndpointByEndpointId
      tags:
      - Agent Endpoint
      summary: Update an agent endpoint
      description: Updates an existing agent endpoint by its ID. Only environment and outboundDialType can be modified.
      parameters:
      - name: endpointId
        in: path
        required: true
        description: The ID of the agent endpoint to update
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentEndpointInput'
components:
  schemas:
    CreateAgentEndpointInput:
      type: object
      properties:
        agentId:
          type: string
          format: uuid
          description: Agent ID to associate this endpoint with
        value:
          type: string
          description: Phone number in E.164 format (e.g., +12345678900)
        environment:
          type: string
          default: production
          description: 'Environment name (default: production)'
        direction:
          type: string
          enum:
          - INCOMING
          - OUTGOING
          - INCOMING_AND_OUTGOING
          description: 'Call direction: INCOMING, OUTGOING, or INCOMING_AND_OUTGOING'
        outboundDialType:
          type: string
          enum:
          - NONE
          - HTTP_REQUEST
          default: NONE
          description: 'Outbound dial type: NONE or HTTP_REQUEST (default: NONE)'
        outboundDialHttpRequestDefinitionId:
          type:
          - string
          - 'null'
          format: uuid
          description: ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST)
      required:
      - agentId
      - value
      - direction
      description: Input for creating an agent endpoint
    UpdateAgentEndpointInput:
      type: object
      properties:
        environment:
          type: string
          description: Environment name
        outboundDialType:
          type: string
          enum:
          - NONE
          - HTTP_REQUEST
          description: 'Outbound dial type: NONE or HTTP_REQUEST'
        outboundDialHttpRequestDefinitionId:
          type:
          - string
          - 'null'
          format: uuid
          description: ID of the HTTP request definition for outbound dialing
      description: Input for updating an agent endpoint
    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
    AgentEndpointDetailResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Agent endpoint ID
        agentId:
          type: string
          format: uuid
          description: Agent ID this endpoint belongs to
        type:
          type: string
          enum:
          - PHONE
          - WEBSOCKET
          - LIVEKIT
          - SMALL_WEBRTC
          - ELEVENLABS_WS
          - KORE
          - GOOGLE_CES
          - DAILY
          description: Agent endpoint type (PHONE, WEBSOCKET, LIVEKIT, SMALL_WEBRTC, or ELEVENLABS_WS)
        value:
          type: string
          description: Agent endpoint value (phone number, URL, etc.)
        environment:
          type: string
          description: Agent endpoint environment
        direction:
          type: string
          enum:
          - INCOMING
          - OUTGOING
          - INCOMING_AND_OUTGOING
          description: Agent endpoint direction (INCOMING, OUTGOING, INCOMING_AND_OUTGOING)
        outboundDialType:
          type: string
          enum:
          - NONE
          - HTTP_REQUEST
          description: Outbound dial type (NONE or HTTP_REQUEST)
        outboundDialHttpRequestDefinitionId:
          type:
          - string
          - 'null'
          format: uuid
          description: ID of the linked HTTP request definition for outbound dialing
        createdAt:
          type: string
          description: Creation timestamp
        updatedAt:
          type: string
          description: Last update timestamp
      required:
      - id
      - agentId
      - type
      - value
      - environment
      - direction
      - outboundDialType
      - outboundDialHttpRequestDefinitionId
      - createdAt
      - updatedAt
      description: Detailed agent endpoint response
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT