---
title: "Create a note"
method: POST
path: "/v1/vault/notes"
tags: ["vault"]
---

# Create a note

`POST /v1/vault/notes`

## Request

- Base URL: `https://api.hyperresearch.ai`
- URL: `https://api.hyperresearch.ai/v1/vault/notes`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `hr_session`

Write a note into the workspace vault. `title` is required; everything else (body, tags, source URL, scores, rights) is optional. Returns the note id; pass `id` to choose it yourself.

## Request body

- object
  - `id` string
  - `title` string, required
  - `body` string
  - `tags` string[]
  - `aliases` string[]
  - `status` string
  - `type` string
  - `tier` string, nullable
  - `content_type` string, nullable
  - `source` string, nullable
  - `summary` string, nullable
  - `doi` string, nullable
  - `parent` string, nullable
  - `raw_r2_key` string, nullable
  - `fetched_at` string, nullable
  - `fetch_provider` string, nullable
  - `utility_score` number, nullable
  - `authority_score` number, nullable
  - `centrality_score` number, nullable
  - `quality_score` number, nullable
  - `independence` number, nullable
  - `is_retracted` boolean
  - `run_id` string, nullable
  - `reused_from_run` string, nullable
  - `rights` NoteRights
    - `license` string, nullable
    - `infer` boolean
    - `excerpt` boolean
    - `external_report` boolean
    - `cache` boolean
    - `embed` boolean
    - `export` boolean
    - `retain` boolean
    - `inference_only` boolean
    - `exportable` boolean
  - `rights_overlay` NoteRights
    - `license` string, nullable
    - `infer` boolean
    - `excerpt` boolean
    - `external_report` boolean
    - `cache` boolean
    - `embed` boolean
    - `export` boolean
    - `retain` boolean
    - `inference_only` boolean
    - `exportable` boolean

## Response `201`

Created

- object
  - `id` string, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `403`: Insufficient scope or plan
- `404`: Not found
- `429`: Rate limited or over quota
- `500`: Internal error

---

[API](https://skmtc.dev/hyperresearch/apis/hyperresearch-cloud-api.md) · [All operations](https://skmtc.dev/hyperresearch/apis/hyperresearch-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperresearch/apis/hyperresearch-cloud-api/revisions/726ef831ebf4?raw)