DOdovetail
Summarize

Magic Summarize

Changed on

Generate an AI-powered summary from a collection of highlights, data entries (notes), insights, themes, and/or tags. Provide one or more arrays of IDs and Dovetail will synthesize the content into a concise summary.

At least one of highlight_ids, note_ids, insight_ids, theme_ids, or tag_ids must contain at least one item. The note_ids field accepts data entry IDs (the product now calls these "data" rather than "notes").

Set with_citations to true (default) to include citation references in the summary. Each citation links back to the specific source item (highlight, data entry, insight, theme, or tag) that contributed to that part of the summary.

Returns a summary string and an array of citations with their source IDs and types.

Required scope: note:write

post/v1/summarize

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/summarize
  • Auth
    HTTP bearer

Request body

highlight_idsstring[]

A list of unique highlightIds that you wish to summarize.

note_idsstring[]

A list of unique noteIds that you wish to summarize.

insight_idsstring[]

A list of unique insightIds that you wish to summarize.

theme_idsstring[]

A list of unique themeIds that you wish to summarize.

tag_idsstring[]

A list of unique tagIds that you wish to summarize.

with_citationsboolean

An optional flag whether to show citations or not, true by default.

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status