Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Text API

Conversational AI text processing APIs

RingCentral Text API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Text. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

2 operations 2 paths 14 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Text API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Text 2

Conversational AI text processing APIs

POST
/ai/text/v1/async/summarize
Conversational Summarization
caiSummarize 1 param body → 202400
POST
/ai/text/v1/async/punctuate
Smart Punctuation
caiPunctuate 1 param body → 202400

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SummaryTimingsUnit (4 properties), SummaryUnit (4 properties), CaiErrorCodeResponse (3 properties), SummaryApiOutput (2 properties). Each schema is shown below with its type and property counts.

SummaryApiOutput
object
2 properties
SummaryApiResponse
CaiErrorCodeResponse
object
3 properties 2 required
CaiAsyncApiResponse
object
1 property
SummaryUnit
object
4 properties 4 required
CaiErrorResponse
object
1 property
SummaryOutputUnit
object
2 properties
PunctuateApiResponse
PunctuateInput
object
1 property 1 required
SummaryTimingsUnit
object
4 properties 1 required
PunctuateApiOutput
object
2 properties
PunctuateOutput
object
1 property 1 required
SummaryOutput
object
1 property
SummaryInput
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-text-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API