Skip to content

Overview

Outbound call orders (Gesprächsaufträge) for Pace’s AI voice agents, with structured, asynchronously delivered results.

Every request carries Authorization: Bearer <token> from the OAuth2 client-credentials flow. The tenant is derived from the token alone - there is no tenant header. Errors use application/problem+json (RFC 9457); branch on code, never on title or detail.

Open registries are marked x-extensible-enum: they grow within v1, and a client MUST accept unknown values and fall back as documented. Closed enums are contracts and do not change within a major version.

Information

  • OpenAPI version: 3.1.0

OAuth2 client credentials. The tenant is derived from the token alone - there is no tenant header, ever. Tokens are short-lived (30 minutes); there are no refresh tokens. Multiple client registrations per tenant, one per integrating system, each with its own scopes and secret.

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://auth.pacepayments.ai/oauth2/token

Scopes:

  • orders:write - Submit and control work: create, modify and cancel call orders, emit signals, control enrollments.
  • orders:read - Read orders, calls, enrollments and signals - the metadata of what happened. Does NOT include conversation content.
  • events:read - Poll the event feed.
  • config:write - Manage order types, sequences and webhook endpoints, including secret rotation and replay.
  • config:read - Read order types, sequences, webhook endpoints, the delivery log, the suppression list and your own tenant configuration.
  • suppressions:write - Add or remove do-not-call entries. Deliberately separate from config:write - this is the highest-liability write in the API.
  • transcripts:read - Read transcript artifacts (conversation content).
  • recordings:read - Obtain recording URLs. Recording is switched off platform-wide.