Simple AI

Simple AI External Calls API

The External Calls API from Simple AI — 3 operation(s) for external calls.

GitHub OpenAPI

Operations 4

POST /external_calls/upload_url Request External Call Upload URL #
GET /external_calls List External Calls #
POST /external_calls Create External Call #
GET /external_calls/{uuid} Get External Call #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/simple-ai/openapi/simple-ai-external-calls-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/simple-ai/json-schema/simple-ai-call-details-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/simple-ai/json-schema/simple-ai-interaction-details-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/simple-ai/json-schema/simple-ai-call-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/simple-ai/json-schema/simple-ai-utterance-feedback-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/simple-ai/json-schema/simple-ai-upsert-synced-contact-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/simple-ai/json-schema/simple-ai-journey-enroll-request-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/simple-ai:simple-ai-external-calls-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

simple-ai-external-calls-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Public API v1 External Calls API
  description: 'Public API v1 requiring API keys.


    **Timestamps:** All datetime fields in API responses are returned in UTC using ISO 8601 format (e.g., `2024-01-15T14:30:00Z`). When filtering by date parameters, provide timestamps in ISO 8601 format.'
  version: 0.1.0
servers:
- url: https://api.usesimple.ai/api/v1
  description: Production API Server
tags:
- name: External Calls
paths:
  /external_calls/upload_url:
    post:
      tags:
      - External Calls
      summary: Request External Call Upload URL
      description: Create a short-lived, organization-scoped presigned URL for uploading an external call recording. Upload the audio with an HTTP PUT using the same Content-Type, then pass the returned object_key to POST /external_calls.
      operationId: request_external_call_upload_url
      security:
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalCallUploadRequest'
      responses:
        '200':
          description: Upload URL created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCallUploadResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /external_calls:
    get:
      tags:
      - External Calls
      summary: List External Calls
      description: List external calls associated with the API key's account. Each result represents one call session and may contain one or more recording legs.
      operationId: list_external_calls
      security:
      - APIKeyHeader: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: source_id
        in: query
        required: false
        schema:
          type: string
          format: uuid
      - name: status
        in: query
        required: false
        schema:
          type: string
          enum:
          - processing
          - transcribed
          - error
      - name: created_at_gte
        in: query
        required: false
        description: Return calls that started at or after this ISO 8601 timestamp.
        schema:
          type: string
          format: date-time
      - name: created_at_lte
        in: query
        required: false
        description: Return calls that started at or before this ISO 8601 timestamp.
        schema:
          type: string
          format: date-time
      - name: updated_at_gte
        in: query
        required: false
        description: Return calls last updated at or after this ISO 8601 timestamp (inclusive).
        schema:
          type: string
          format: date-time
      - name: updated_at_lte
        in: query
        required: false
        description: Return calls last updated at or before this ISO 8601 timestamp (inclusive).
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: External calls returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCallListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - External Calls
      summary: Create External Call
      description: Confirm a recording uploaded with the external-call upload URL and create a new external call. Transcription and analysis continue asynchronously.
      operationId: create_external_call
      security:
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExternalCallRequest'
      responses:
        '201':
          description: External call created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCallCreateResponse'
        '404':
          description: Uploaded object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /external_calls/{uuid}:
    get:
      tags:
      - External Calls
      summary: Get External Call
      description: Fetch one external call and its visible recording legs, transcripts, and summaries.
      operationId: get_external_call
      security:
      - APIKeyHeader: []
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: External call returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCallDetails'
        '404':
          description: External call not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExternalCallUploadRequest:
      type: object
      required:
      - file_name
      - file_size_bytes
      - content_type
      properties:
        file_name:
          type: string
          minLength: 1
          maxLength: 512
        file_size_bytes:
          type: integer
          minimum: 1
          maximum: 524288000
        content_type:
          type: string
          minLength: 1
          maxLength: 255
      title: External Call Upload Request
    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
    CreateExternalCallRequest:
      type: object
      required:
      - object_key
      - file_name
      properties:
        object_key:
          type: string
          description: The object_key returned by POST /external_calls/upload_url.
        file_name:
          type: string
          minLength: 1
          maxLength: 512
      title: Create External Call Request
    ExternalCallSource:
      type: object
      required:
      - id
      - name
      - provider
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        provider:
          type: string
      title: External Call Source
    ExternalCallRecording:
      type: object
      required:
      - id
      - file_name
      - status
      - started_at
      - transcript
      - summary
      - created_at
      - updated_at
      properties:
        id:
          type: string
          format: uuid
        file_name:
          type: string
        status:
          type: string
          enum:
          - pending
          - transcribing
          - transcribed
          - error
        started_at:
          type: string
          format: date-time
        transcript:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/ExternalCallTranscriptUtterance'
          - type: 'null'
        summary:
          anyOf:
          - type: string
          - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      title: External Call Recording
    ExternalCallDetails:
      allOf:
      - $ref: '#/components/schemas/ExternalCallSummary'
      - type: object
        required:
        - recordings
        properties:
          recordings:
            type: array
            items:
              $ref: '#/components/schemas/ExternalCallRecording'
      title: External Call Details
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalCallCreateResponse:
      type: object
      required:
      - success
      - external_call
      properties:
        success:
          type: boolean
          const: true
        external_call:
          $ref: '#/components/schemas/ExternalCallDetails'
      title: External Call Create Response
    ExternalCallTranscriptUtterance:
      type: object
      required:
      - speaker
      - text
      - start
      - end
      - confidence
      - channel
      properties:
        speaker:
          type: string
        text:
          type: string
        start:
          type: number
          description: Start time in milliseconds.
        end:
          type: number
          description: End time in milliseconds.
        confidence:
          type: number
        channel:
          anyOf:
          - type: string
          - type: 'null'
      title: External Call Transcript Utterance
    ExternalCallListResponse:
      type: object
      required:
      - external_calls
      - total_count
      - page
      - page_size
      - total_pages
      properties:
        external_calls:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCallSummary'
        total_count:
          type: integer
          minimum: 0
        page:
          type: integer
          minimum: 1
        page_size:
          type: integer
          minimum: 1
          maximum: 100
        total_pages:
          type: integer
          minimum: 0
      title: External Call List Response
    ExternalCallSummary:
      type: object
      required:
      - id
      - external_call_id
      - title
      - direction
      - from_number
      - to_number
      - duration_seconds
      - started_at
      - status
      - recording_count
      - source
      - created_at
      - updated_at
      - recording_presigned_urls
      properties:
        id:
          type: string
          format: uuid
        external_call_id:
          type: string
        title:
          anyOf:
          - type: string
          - type: 'null'
        direction:
          anyOf:
          - type: string
            enum:
            - inbound
            - outbound
          - type: 'null'
        from_number:
          anyOf:
          - type: string
          - type: 'null'
        to_number:
          anyOf:
          - type: string
          - type: 'null'
        duration_seconds:
          anyOf:
          - type: integer
          - type: 'null'
        started_at:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - processing
          - transcribed
          - error
        recording_count:
          type: integer
          minimum: 0
        source:
          anyOf:
          - $ref: '#/components/schemas/ExternalCallSource'
          - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        recording_presigned_urls:
          type: array
          items:
            type: string
            format: uri
          description: Presigned URLs for all playable recordings in chronological order. External calls can have multiple recordings per session. URLs expire after one hour. Deleted, excluded, and recordings awaiting required audio redaction are omitted; an empty array means no recordings are currently playable. If URL signing fails for a recording, its URL is omitted and the call data is still returned.
      title: External Call Summary
    ErrorResponse:
      type: object
      required:
      - status
      - success
      - error
      - errors
      properties:
        status:
          type: string
          default: error
        success:
          type: boolean
          default: false
        error:
          type: string
          title: Error
        errors:
          type: array
          items:
            type: string
          title: Errors
      title: Error Response
    ExternalCallUploadResponse:
      type: object
      required:
      - upload_url
      - object_key
      - expires_in
      properties:
        upload_url:
          type: string
          format: uri
        object_key:
          type: string
        expires_in:
          type: integer
          description: Seconds until the upload URL expires.
      title: External Call Upload Response
  securitySchemes:
    APIKeyHeader:
      type: http
      scheme: bearer
      description: 'Your API key, sent as `Authorization: Bearer YOUR_API_KEY`'