Opal Rich Text Documents API
## Overview### Client libraries and document formatsRich Text Document endpoints can accept documents in arbitrary formats. The `client_library` attribute identifies the framework or library that generated the document.Currently, the following formats are recognized, though other formats are allowed. When creating or updating documents in these formats, ensure that the `client_library` attribute is consistent with the value provided here:| Format | Client Library ID || --------------------------------------- | ------------------ || [Tiptap 2](https://tiptap.dev) JSON | `tiptap/2.0` |### Document assetsSome documents returned by these endpoints may have an `assets` relationship; these documents will not also have an `asset_references` relationship.
Opal Rich Text Documents API is one of 79 APIs that Opal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Rich Text Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 7 operations across 4 paths. It is described by OpenAPI 3.2.0, at version 3.0.0.
Requests are made against a single base URL, https://login.ouropal.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Opal Rich Text Documents API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope.
It supports OAuth 2.0 (anonymous_oauth) using the clientCredentials flow, exposing 1 scope.
An API key is passed in the header as Session-Token (api_key).
An API key is passed in the cookie as share_token (presentation_share_cookie).
oauth2— This API uses OAuth 2.0 with the authorization code grant flow. You can find more detailed authentication instructions in the [Authentication Strategies](/api/…anonymous_oauth— The OAuth 2.0 client credentials flow is used for secure server-server requests when Opal does not need to associate a request with a particular Opal user. The…api_key— (Deprecated) This API also supports authentication via an API or session token set in the request headers.presentation_share_cookie— A cookie set and read by the Monolith service that authorizes a non-opal user to view a presentation and the resources within it. Other services can rely on th…
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Overview Client libraries and document formats Rich Text Document endpoints can accept documents in arbitrary formats. The clientlibrary attribute identifies the framework or libr…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Opal 12
Other APIs Opal publishes across the network.
This is an independent, third-party profile of Opal Rich Text Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.