---
title: "Start File Note Generation"
method: POST
path: "/v1/matters/{matter_id}/file-notes/runs"
tags: ["file-notes"]
---

# Start File Note Generation

`POST /v1/matters/{matter_id}/file-notes/runs`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/file-notes/runs`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Headers

- `Idempotency-Key` string, required

## Request body

- StartFileNoteGeneration
  - `prompt` string, required
  - `title` string, nullable
  - `template_key` 'auto' | 'capture' | 'solvency_analysis' | 'insolvent_trading' | 'ato_compliance_history' | 'director_asset_search' | 'books_and_records' | 'causes_of_failure' | 'voidable_summary'
  - `note_date` string, date, nullable
  - `evidence_scope` 'matter_memory' | 'selected_documents'
  - `document_ids` string[]

## Response `202`

Successful Response

- FileNoteGenerationRun
  - `id` string, uuid, required
  - `matter_id` string, uuid, required
  - `prompt` string, required
  - `requested_title` string, nullable, required
  - `requested_template_key` 'auto' | 'capture' | 'solvency_analysis' | 'insolvent_trading' | 'ato_compliance_history' | 'director_asset_search' | 'books_and_records' | 'causes_of_failure' | 'voidable_summary', required
  - `workflow_key` 'capture' | 'solvency_analysis' | 'insolvent_trading' | 'ato_compliance_history' | 'director_asset_search' | 'books_and_records' | 'causes_of_failure' | 'voidable_summary', nullable, required
  - `note_date` string, date, nullable, required
  - `evidence_scope` 'matter_memory' | 'selected_documents', required
  - `document_ids` string[], required
  - `state` 'queued' | 'running' | 'completed' | 'needs_input' | 'failed' | 'cancelled', required
  - `stage` 'routing' | 'retrieving' | 'drafting' | 'finalising', nullable, required
  - `version` integer, required
  - `result` FileNoteGenerationResult, required
    - `note_id` string, uuid, required
    - `version_id` string, uuid, required
    - `workflow_key` string, required
  - `issue` FileNoteGenerationIssue, required
    - `code` string, required
    - `message` string, required
    - `retryable` boolean, required
  - `retryable` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `started_at` string, date-time, nullable, required
  - `terminal_at` string, date-time, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)