---
title: "Chapters of the note with timestamps"
method: GET
path: "/v1/notes/{id}/outline"
tags: ["content"]
---

# Chapters of the note with timestamps

`GET /v1/notes/{id}/outline`

## Request

- Base URL: `https://api.audiomap.ai`
- URL: `https://api.audiomap.ai/v1/notes/{id}/outline`
- Auth: HTTP bearer

Reading is free. `?generate=1` on a note that has no outline generates one and charges credits.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `generate` '0' | '1'

## Response `200`

The outline; empty array when there is none

- Outline
  - `noteId` string, uuid
  - `outline` Chapter[]
    - `startMs` integer
    - `endMs` integer
    - `headline` string
  - `attemptedAt` string, date-time, nullable
  - `generated` boolean

## Other responses

- `401`: Missing or invalid API key
- `402`: Not enough credits to generate it
- `403`: Your plan does not include the REST API
- `404`: No note with that id belongs to you
- `409`: The note is not ready
- `429`: Too many requests for this API key

---

[API](https://skmtc.dev/audiomap/apis/audiomap-api.md) · [All operations](https://skmtc.dev/audiomap/apis/audiomap-api/llms.txt) · [OpenAPI document](https://skmtc.dev/audiomap/apis/audiomap-api/revisions/0bc0c0fc6cbb?raw)
