About the Ricos Documents API

The Ricos Documents API provides methods for working with Ricos documents, Wix's standardized format for rich content. Learn more about Rich Content and Ricos documents.

With the Ricos Documents API, you can:

• Validate Ricos documents.
• Convert content from HTML, Markdown, or plain text to Ricos document format.
• Convert Ricos documents to HTML, Markdown, or plain text.
• Generate URLs for uploading files to use in Ricos documents.
• Generate temporary download URLs for files in Ricos documents.
• Generate site media tokens to open Wix media tools, such as Image Studio, from a Ricos editor.

Before you begin

It's important to note the following points before starting to code:

• The API is stateless. It doesn't store Ricos documents, so pass the full document in each call.
• When converting content to a Ricos document, the plugins you specify affect HTML conversion only. Markdown and plain text conversions ignore them.
• File nodes in a Ricos document reference files in the site's Media Manager by ID. Call Generate File Download URL to let site visitors download files from file nodes, including private files. To add a file to a document, call Generate File Upload URL, upload the file, and reference its ID in a file node.
• Only Wix users can generate site media tokens, so call Generate Site Media Token from a dashboard or editor page, not from a live site.

Use cases

• Convert site visitor input between Ricos document and Markdown formats
• Let site visitors add files to a Ricos document
• Let site visitors download files from a Ricos document

Terminology

• Ricos document: An object that defines rich content.
• Plugin: Allows rich content viewers to display specific content types. Learn more about plugins.
• File node: A node of type FILE in a Ricos document. Its fileData.src.id holds the ID of the file in the site's Media Manager.