docs

Update Doc Header

Changed on

Rename and move in one write (folder_id null = root).

put/api/v1/docs/{doc_id}/header

Request

  • Base URL
    https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.getanana.com/api/v1/docs/{doc_id}/header
  • Auth
    none declared

Path parameters

doc_idstring uuid required

Request body

titlestring required
folder_idstring uuid nullable

Response

Successful Response

idstring uuid required
titlestring required
state'streaming' | 'draft' | 'edited' | 'approved' | 'sent' | 'archived' required
kind'report' | 'document' | 'table' | 'spreadsheet' | 'visualization' required

What a document IS, derived from its body — never declared by an author.

Orthogonal to :class:ArtifactType, which says which product surface owns the row. For a document the kind says whether it reads as a written report, plain prose, a single table or a single chart, and :func:app.artifacts.public.doc_body.classify_doc_kind is the only thing that decides.

spreadsheet is reserved for a real spreadsheet artifact (sheets, cells, formulas — PLAN-spreadsheet-artifact.md). A Doc that is one table is a table: two different things must not share one name in the gallery.

folder_idstring uuid nullable required
conversation_idstring uuid nullable required
version_numberinteger required
last_author'agent' | 'user' required
last_author_user_idstring uuid nullable required
created_by_user_idstring uuid nullable required
published_versioninteger nullable required
preview_textstring required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 5ebfe310b84cRevision changes
    • info

      added the required property to the response with the status

  • 7a2140816370Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status