RHrhythms
documents

Create a new document

Changed on

Creates a new ordinary document, HTML document, or layout. HTML documents may clone an HTML layout.

post/documents

Request

  • Base URL
    https://api.rhythms.ai
  • URL
    https://api.rhythms.ai/documents
  • Auth
    none required

Request body

namestring required

Document name

content_typestring

Type to create: 'document' (default), 'layout', or an internal HTML document/layout type

html_contentstring

Complete self-contained HTML source for an HTML document or layout (maximum 1 MiB)

layout_uuidstring

UUID of an existing layout to base this document on

copy_layout_contentboolean

When true and layout_uuid is given, the new document starts as a copy of the layout's content (prompt buttons removed). Default false: the document starts blank.

playbook_uuidstring

UUID of the playbook this document was created for

playbook_run_uuidstring

UUID of the playbook run this document was created during

folder_uuidstring

Optional folder UUID to file the new document into. The caller must be able to view the folder; an inaccessible or missing folder is rejected.

Changes