---
title: "Create a highlight"
method: POST
path: "/highlights"
tags: ["Highlights"]
---

# Create a highlight

`POST /highlights`

## Request

- Base URL: `https://api.screvi.com/api/v1`
- URL: `https://api.screvi.com/api/v1/highlights`
- Auth: API key in header `X-API-Key`

Creates a highlight. Attach it to an existing source with `source_id`, or to a saved article with `article_id` (not both). Omit both to create a standalone highlight. `tags` takes tag names (matched case-insensitively, created when new) or tag ids. Requires an API key with the `write` scope.

## Request body

- object
  - `content` string, required
  - `note` string
  - `favorite` boolean
  - `url` string, uri
  - `location` integer
  - `date` string, date-time
  - `source_id` string, uuid
  - `article_id` string, uuid
  - `tags` string[]: Tag names or ids
  - `metadata` object

## Response `201`

The created highlight

## Other responses

- `403`: Key lacks the write scope
- `422`: Validation failed

---

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