Heidi API
Documents

Documents

Create a Document

Method: POST

Path: /sessions/{session_id}/documents

Description: Create an empty document for the session.

Request

POST /sessions/1234567890/documents HTTP/1.1
Authorization: Bearer <your_token>
Content-Type: application/json

{
  "document_tab_type": "DOCUMENT",
  "generation_method": "TEMPLATE",
  "template_id": "5eb7cf5a86d9755df3a6c593",
  "voice_style": "GOLDILOCKS",
  "brain": "LEFT",
  "content_type": "MARKDOWN"
}

Parameters

  • template_id: (string) The ID of the template to use for document generation
  • generation_method: (string) The method for generating the document. Can be one of TEMPLATE
  • voice_style: (string) The voice style to use for the generated document. Can be one of GOLDILOCKS, DETAILED, BRIEF, SUPER_DETAILED
  • brain: (string) The brain option to use. Can be one of LEFT, RIGHT

Response

{
  "id": "string",
  "session_id": "string",
  "name": "string",
  "template_id": "string",
  "brain": "string",
  "voice_style": "string",
  "content_type": "string",
  "content": "string"
}

Get List of Documents

Method: GET

Path: /sessions/{session_id}/documents

Description: Retrieve a list of all documents associated with a specific session.

Request

GET /sessions/1234567890/documents HTTP/1.1
Authorization: Bearer <your_token>

Response

{
  "documents": [
    {
      "id": "string",
      "session_id": "string",
      "index": 0,
      "name": "string",
      "template_id": "string",
      "content": "string",
      "generation_type": "TEMPLATE",
      "brain": "LEFT"
    }
  ]
}
Consult notesAsk Heidi