Summarize

<Warning> This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](https://docs.cohere.com/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API. </Warning> Generates a summary in English for a given text.
post/v1/summarize

Request

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

Headers

X-Client-Namestring

The name of the project that is making the request.

Request body

textstring required

The text to generate a summary for. Can be up to 100,000 characters long. Currently the only supported language is English.

length'short' | 'medium' | 'long'

One of short, medium, long, or auto defaults to auto. Indicates the approximate length of the summary. If auto is selected, the best option will be picked based on the input text.

format'paragraph' | 'bullets'

One of paragraph, bullets, or auto, defaults to auto. Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points. If auto is selected, the best option will be picked based on the input text.

modelstring

The identifier of the model to generate the summary with. Currently available models are command (default), command-nightly (experimental), command-light, and command-light-nightly (experimental). Smaller, "light" models are faster, while larger models will perform better.

extractiveness'low' | 'medium' | 'high'

One of low, medium, high, or auto, defaults to auto. Controls how close to the original text the summary is. high extractiveness summaries will lean towards reusing sentences verbatim, while low extractiveness summaries will tend to paraphrase more. If auto is selected, the best option will be picked based on the input text.

temperaturenumber double

Ranges from 0 to 5. Controls the randomness of the output. Lower values tend to generate more “predictable” output, while higher values tend to generate more “creative” output. The sweet spot is typically between 0 and 1.

additional_commandstring

A free-form instruction for modifying how the summaries get generated. Should complete the sentence "Generate a summary _". Eg. "focusing on the next steps" or "written by Yoda"

Response

OK

idstring

Generated ID for the summary

summarystring

Generated summary for the text

Changes

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