# Opal Rich Text Documents API

**Canonical:** https://apis.io/apis/opal/opal-rich-text-documents-api/  
**Provider:** Opal — https://apis.io/providers/opal/  
**Base URL:** https://login.ouropal.com  
**Documentation:** https://login.ouropal.com/api/documentation/v2

Opal Rich Text Documents API is one of 79 APIs that [Opal](https://apis.io/providers/opal/) publishes on the [APIs.io](https://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.

## 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.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-rich-text-documents-api-openapi.yml
- **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

## Other Opal APIs (12)

- [Opal Accounts API](https://apis.io/apis/opal/opal-accounts-api/)
- [Opal Activities API](https://apis.io/apis/opal/opal-activities-api/)
- [Opal Annotations API](https://apis.io/apis/opal/opal-annotations-api/)
- [Opal Asset Reference Options API](https://apis.io/apis/opal/opal-asset-reference-options-api/)
- [Opal Asset Reference Usage Rights Options API](https://apis.io/apis/opal/opal-asset-reference-usage-rights-options-api/)
- [Opal Asset References API](https://apis.io/apis/opal/opal-asset-references-api/)
- [Opal Assets API](https://apis.io/apis/opal/opal-assets-api/)
- [Opal Block Connectors API](https://apis.io/apis/opal/opal-block-connectors-api/)
- [Opal Block Custom Field Values API](https://apis.io/apis/opal/opal-block-custom-field-values-api/)
- [Opal Block Duplication API](https://apis.io/apis/opal/opal-block-duplication-api/)
- [Opal Blocks API](https://apis.io/apis/opal/opal-blocks-api/)
- [Opal Board Collaborators API](https://apis.io/apis/opal/opal-board-collaborators-api/)

## Tags

Rich Text Documents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/opal/opal-rich-text-documents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/opal/.