Documents

Create a document, optionally seeding it with tabs and filing it in a team and/or folder. An invalid placement refuses the whole create by name (placement_invalid, team_forbidden, folder_not_found, folder_scope_mismatch) or a malformed intent (intent_invalid); nothing is written.

post/documents

Request

  • Base URL: https://www.livediagram.app/api
  • URL: https://www.livediagram.app/api/documents
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Owner-Id

Request body

idstring required
namestring required

At most 60 characters; a longer name is stored shortened at a word boundary with an ellipsis, and whitespace runs collapse to one space.

source'ai' | 'mcp' | 'cli'
teamIdstring nullable

The team library to file into; absent or null = the caller's My documents. Requires a signed-in caller (or API token) who has joined the team.

folderIdstring nullable

A folder of the chosen space. null, present, is that space's root chosen on purpose; absent with no teamId is no choice, where a default folder may answer.

createdAtinteger
savedAtinteger
markUsedboolean

Whether making the document counts as a use of it for the caller, so it joins their Jump back in at once. Default true; send false when making many documents in one go (the editor does for an import of more than one), so they wait until opened. Not a boolean: 400 invalid markUsed.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.