Opal

Opal Rich Text Documents API

## Overview ### Client libraries and document formats Rich 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 assets Some documents returned by these endpoints may have an `assets` relationship; these documents will not also have an `asset_references` relationship.

GitHub OpenAPI

Operations 7

GET /rich_texts/v3/documents Get Rich Text Documents available to the authenticated user #
POST /rich_texts/v3/documents Create a new Rich Text Document #
GET /rich_texts/v3/documents/{rich_text_document_id} Get a Rich Text Document #
PATCH /rich_texts/v3/documents/{rich_text_document_id} Update an existing Rich Text Document #
DELETE /rich_texts/v3/documents/{rich_text_document_id} Delete a Rich Text Document #
POST /rich_texts/v3/documents/{rich_text_document_id}/duplicate Duplicate a Rich Text Document #
GET /rich_texts/v3/get_collaboration_token Get a JWT for use with the TipTap Collaboration server #

Documentation

📖
Documentation
https://login.ouropal.com/api/documentation/v2
📖
APIReference
https://login.ouropal.com/api/documentation/v2
📖
Documentation
https://login.ouropal.com/api/documentation/v3
📖
APIReference
https://login.ouropal.com/api/documentation/v3
📖
Documentation
https://login.ouropal.com/api/documentation/asgard_bff

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-rich-text-documents-api-openapi.yml

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/opal-rich-text-documents-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

opal-rich-text-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 3.0.0
  title: Opal API (⚠️ WIP) Rich Text Documents API
  license:
    name: Opal API License
    url: https://www.workwithopal.com/api-license
  description: The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
servers:
- url: https://login.ouropal.com
tags:


# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-rich-text-documents-api-openapi.yml