Highlights

Create a highlight

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.

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

Request body

contentstring required
notestring
favoriteboolean
urlstring uri
locationinteger
datestring date-time
source_idstring uuid
article_idstring uuid
tagsstring[]

Tag names or ids

metadataobject

Response

The created highlight

Changes

No recorded changes to this operation across all 1 revision of this API.