iCallAgent Public API · OpenAPI Overlay 1.0.0

iCallAgent Public API enrichment overlay

4 actions 4 updates update extends ../openapi/icallagent-public-api-openapi.json
Generated by API Evangelist Written by API Evangelist tooling for iCallAgent Public API's API. It is a proposal applied on top of the contract, not a document iCallAgent Public API publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-humanURLx-productionBaseURLx-error-envelopex-paginationx-webhooks

Targets 2

$.info
$

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: iCallAgent Public API enrichment overlay
  version: 1.0.0
extends: ../openapi/icallagent-public-api-openapi.json
x-provenance:
  generated: '2026-09-15'
  method: generated
  source: >-
    Derived from docs.icallagent.com api-reference (authentication, errors, pagination,
    webhooks) captured 2026-09-15. Non-destructive; the original OpenAPI snapshot is
    unmodified.
actions:
  - target: $.info
    description: Record the production base and the human documentation URL.
    update:
      x-humanURL: https://docs.icallagent.com/api-reference/
      x-productionBaseURL: https://api.icallagent.com/api/public/v1/
  - target: $
    description: >-
      Document the flat error envelope shared by every operation ({"detail": "..."}),
      which is not RFC 9457 problem+json.
    update:
      x-error-envelope:
        shape: flat
        fields:
          detail: Human-readable error message.
        rfc9457: false
  - target: $
    description: Document the offset/limit pagination shared by all GET list endpoints.
    update:
      x-pagination:
        style: offset-limit
        params:
          limit:
            default: 100
            max: 200
          offset:
            default: 0
        response_envelope_field: results
        note: Out-of-range values are clamped, not rejected.
  - target: $
    description: Document the outbound call.completed webhook delivered to subscribers.
    update:
      x-webhooks:
        call.completed:
          delivery: at-least-once
          dedupe_key: call_id
          subscribe_operation: subscribeWebhook
          unsubscribe_operation: unsubscribeWebhook