Okareo

Okareo Voice Integrations API

Configure voice provider integrations.

GitHub OpenAPI

Operations 9

POST /v0/voice/integration Create Provider Integration #
GET /v0/voice/integrations List Provider Integrations #
GET /v0/voice/integration/{integration_id} Get Provider Integration #
PATCH /v0/voice/integration/{integration_id} Update Provider Integration #
DELETE /v0/voice/integration/{integration_id} Delete Provider Integration #
POST /v0/voice/integration/test Check Unsaved Integration Connection #
POST /v0/voice/integration/{integration_id}/test Check Integration Connection #
POST /v0/voice/integration/{integration_id}/rotate Rotate Provider Integration Secrets #
POST /v0/voice/integration/{integration_id}/status Update Provider Integration Status #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/openapi/okareo-voice-integrations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/json-schema/okareo-datapoint-list-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/json-schema/okareo-scenario-set-generate-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/json-schema/okareo-datapoint-filter-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/json-schema/okareo-driver-model-schema-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/json-schema/okareo-test-run-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okareo/refs/heads/main/json-schema/okareo-test-run-payload-v2-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/okareo:okareo-voice-integrations-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

okareo-voice-integrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Okareo Voice Integrations API
  version: 0.1.0
  description: Configure voice provider integrations.
servers:
- url: https://api.okareo.com
tags:
- name: Voice Integrations
  description: Configure voice provider integrations.
paths:
  /v0/voice/integration:
    post:
      tags:
      - Voice Integrations
      summary: Create Provider Integration
      operationId: create_provider_integration_v0_voice_integration_post
      parameters:
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProviderIntegrationRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderIntegrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/voice/integrations:
    get:
      tags:
      - Voice Integrations
      summary: List Provider Integrations
      operationId: list_provider_integrations_v0_voice_integrations_get
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Filter by project id
          title: Project Id
        description: Filter by project id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProviderIntegrationResponse'
                title: Response List Provider Integrations V0 Voice Integrations Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/voice/integration/{integration_id}:
    get:
      tags:
      - Voice Integrations
      summary: Get Provider Integration
      operationId: get_provider_integration_v0_voice_integration__integration_id__get
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Integration Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderIntegrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Voice Integrations
      summary: Update Provider Integration
      operationId: update_provider_integration_v0_voice_integration__integration_id__patch
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Integration Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProviderIntegrationRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderIntegrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Voice Integrations
      summary: Delete Provider Integration
      operationId: delete_provider_integration_v0_voice_integration__integration_id__delete
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Integration Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/voice/integration/test:
    post:
      tags:
      - Voice Integrations
      summary: Check Unsaved Integration Connection
      description: Check settings before they are saved. Nothing is stored.
      operationId: check_unsaved_integration_connection_v0_voice_integration_test_post
      parameters:
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionTestRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionTestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/voice/integration/{integration_id}/test:
    post:
      tags:
      - Voice Integrations
      summary: Check Integration Connection
      description: 'Check a saved integration''s credentials against the provider: with its

        saved settings, or with unsaved ones sent while they are being edited

        (nothing is stored). A pass records last_validated_at when the settings

        tested sign in where the saved ones do.'
      operationId: check_integration_connection_v0_voice_integration__integration_id__test_post
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Integration Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/SavedConnectionTestRequest'
              - type: 'null'
              title: Payload
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionTestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/voice/integration/{integration_id}/rotate:
    post:
      tags:
      - Voice Integrations
      summary: Rotate Provider Integration Secrets
      operationId: rotate_provider_integration_secrets_v0_voice_integration__integration_id__rotate_post
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Integration Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RotateProviderIntegrationSecretsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderIntegrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/voice/integration/{integration_id}/status:
    post:
      tags:
      - Voice Integrations
      summary: Update Provider Integration Status
      operationId: update_provider_integration_status_v0_voice_integration__integration_id__status_post
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Integration Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProviderIntegrationStatusRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderIntegrationStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SavedConnectionTestRequest:
      properties:
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
      additionalProperties: false
      type: object
      title: SavedConnectionTestRequest
      description: 'Optional unsaved settings to check with a saved integration''s secrets,

        e.g. while its settings are being edited. Nothing is stored.'
    ConnectionTestResponse:
      properties:
        ok:
          type: boolean
          title: Ok
        checks:
          items:
            $ref: '#/components/schemas/ConnectionCheck'
          type: array
          title: Checks
        agents:
          anyOf:
          - items:
              $ref: '#/components/schemas/ConnectionTestAgent'
            type: array
          - type: 'null'
          title: Agents
          description: 'Agentforce only: the org''s agents, when signing in worked and they could be listed.'
      additionalProperties: false
      type: object
      required:
      - ok
      - checks
      title: ConnectionTestResponse
    ProviderIntegrationResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        project_id:
          type: string
          format: uuid
          title: Project Id
        provider:
          type: string
          enum:
          - twilio
          - retell
          - livekit
          - agentforce
          title: Provider
        public_id:
          type: string
          title: Public Id
        status:
          type: string
          title: Status
        webhook_auth_type:
          type: string
          enum:
          - twilio_signature
          - retell_signature
          - livekit_jwt
          - oauth_client_credentials
          title: Webhook Auth Type
        delivery:
          type: string
          enum:
          - webhook
          - pull
          title: Delivery
          description: 'webhook: the provider calls Okareo. pull: Okareo calls the provider.'
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        last_validated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Validated At
        last_used_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Used At
        secret_summary:
          $ref: '#/components/schemas/SecretSummaryResponse'
      additionalProperties: false
      type: object
      required:
      - id
      - project_id
      - provider
      - public_id
      - status
      - webhook_auth_type
      - delivery
      - metadata
      - secret_summary
      title: ProviderIntegrationResponse
    ConnectionTestAgent:
      properties:
        id:
          type: string
          title: Id
          description: The Agent ID (Salesforce BotDefinition record id, 0Xx...).
        name:
          type: string
          title: Name
          description: The agent's API name.
        label:
          type: string
          title: Label
          description: The agent's display name.
        recent_sessions:
          anyOf:
          - type: integer
          - type: 'null'
          title: Recent Sessions
          description: How many traced sessions this agent took part in that started in the last 30 days; null when Data 360 couldn't say.
        last_session_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Session At
          description: When the latest of those sessions started (UTC).
      additionalProperties: false
      type: object
      required:
      - id
      - name
      - label
      title: ConnectionTestAgent
      description: An agent in the provider's org, offered for an integration's agent filter.
    ProviderIntegrationStatusResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        status:
          type: string
          enum:
          - active
          - disabled
          title: Status
      additionalProperties: false
      type: object
      required:
      - id
      - status
      title: ProviderIntegrationStatusResponse
    RotateProviderIntegrationSecretsRequest:
      properties:
        secrets:
          additionalProperties:
            type: string
          type: object
          title: Secrets
      additionalProperties: false
      type: object
      required:
      - secrets
      title: RotateProviderIntegrationSecretsRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ConnectionCheck:
      properties:
        name:
          type: string
          title: Name
        ok:
          type: boolean
          title: Ok
        detail:
          type: string
          title: Detail
      additionalProperties: false
      type: object
      required:
      - name
      - ok
      - detail
      title: ConnectionCheck
    UpdateProviderIntegrationStatusRequest:
      properties:
        status:
          type: string
          enum:
          - active
          - disabled
          title: Status
      additionalProperties: false
      type: object
      required:
      - status
      title: UpdateProviderIntegrationStatusRequest
    CreateProviderIntegrationRequest:
      properties:
        project_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
        provider:
          type: string
          enum:
          - twilio
          - retell
          - livekit
          - agentforce
          title: Provider
        webhook_auth_type:
          anyOf:
          - type: string
            enum:
            - twilio_signature
            - retell_signature
            - livekit_jwt
            - oauth_client_credentials
          - type: 'null'
          title: Webhook Auth Type
          description: Defaults to the provider's auth type.
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        secrets:
          additionalProperties:
            type: string
          type: object
          title: Secrets
      additionalProperties: false
      type: object
      required:
      - provider
      - secrets
      title: CreateProviderIntegrationRequest
    UpdateProviderIntegrationRequest:
      properties:
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      additionalProperties: false
      type: object
      required:
      - metadata
      title: UpdateProviderIntegrationRequest
    ConnectionTestRequest:
      properties:
        project_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
        provider:
          type: string
          enum:
          - twilio
          - retell
          - livekit
          - agentforce
          title: Provider
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        secrets:
          additionalProperties:
            type: string
          type: object
          title: Secrets
      additionalProperties: false
      type: object
      required:
      - provider
      - secrets
      title: ConnectionTestRequest
      description: Unsaved settings to check before creating an integration. Nothing is stored.
    SecretSummaryResponse:
      properties:
        secret_names:
          items:
            type: string
          type: array
          title: Secret Names
        statuses:
          additionalProperties:
            type: string
          type: object
          title: Statuses
      additionalProperties: false
      type: object
      required:
      - secret_names
      - statuses
      title: SecretSummaryResponse