Summarize

POST/v1/summarizeSummarize

<Warning> This API is marked as "Legacy" and is no longer maintained. Follow the migration guide to start using the Chat API. </Warning> Generates a summary in English for a given text.

Parameters

X-Client-Namestringheader

The name of the project that is making the request.

Request body

application/json

object

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"

extractivenessstring

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.

one of "low", "medium", "high" · default "low"

formatstring

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.

one of "paragraph", "bullets" · default "paragraph"

lengthstring

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.

one of "short", "medium", "long" · default "medium"

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.

temperaturenumber

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.

default 0.3 · maximum 5 · minimum 0

textstringrequired

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

maxLength 50000 · minLength 250

Example request

{
  "additional_command": "string",
  "extractiveness": "low",
  "format": "paragraph",
  "length": "medium",
  "model": "string",
  "temperature": 0.3,
  "text": "string"
}

Responses

Headers

X-API-Warning

The name of the project that is making the request.

object

idstring

Generated ID for the summary

metaobject

Show child attributes

api_versionobject

Show child attributes

is_deprecatedboolean

is_experimentalboolean

versionstringrequired

billed_unitsobject

Show child attributes

classificationsnumber

The number of billed classifications units.

image_tokensnumber

The number of billed image tokens.

imagesnumber

The number of billed images.

input_tokensnumber

The number of billed input tokens.

output_tokensnumber

The number of billed output tokens.

pagesnumber

The number of billed pages parsed.

search_unitsnumber

The number of billed search units.

cached_tokensnumber

The number of prompt tokens that hit the inference cache.

tokensobject

Show child attributes

input_tokensnumber

The number of tokens used as input to the model.

output_tokensnumber

The number of tokens produced by the model.

warningsarray of string

Show child attributes

summarystring

Generated summary for the text

Example response

{
  "id": "string",
  "meta": {
    "api_version": {
      "is_deprecated": true,
      "is_experimental": true,
      "version": "string"
    },
    "billed_units": {
      "classifications": 0,
      "image_tokens": 0,
      "images": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "pages": 0,
      "search_units": 0
    },
    "cached_tokens": 0,
    "tokens": {
      "input_tokens": 0,
      "output_tokens": 0
    },
    "warnings": [
      "string"
    ]
  },
  "summary": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

Examples

X-Client-Nameheader parameter

curl -X POST 'https://api.cohere.com/v1/summarize' \
  -H 'Content-Type: application/json' \
  -d '{"additional_command":"string","extractiveness":"low","format":"paragraph","length":"medium","model":"string","temperature":0.3,"text":"string"}'

const response = await fetch('https://api.cohere.com/v1/summarize', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"additional_command":"string","extractiveness":"low","format":"paragraph","length":"medium","model":"string","temperature":0.3,"text":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.cohere.com/v1/summarize', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"additional_command\":\"string\",\"extractiveness\":\"low\",\"format\":\"paragraph\",\"length\":\"medium\",\"model\":\"string\",\"temperature\":0.3,\"text\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.cohere.com/v1/summarize",
    headers={"Content-Type": "application/json"},
    data='{"additional_command":"string","extractiveness":"low","format":"paragraph","length":"medium","model":"string","temperature":0.3,"text":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"additional_command":"string","extractiveness":"low","format":"paragraph","length":"medium","model":"string","temperature":0.3,"text":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.cohere.com/v1/summarize", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.cohere.com/v1/summarize");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"additional_command\":\"string\",\"extractiveness\":\"low\",\"format\":\"paragraph\",\"length\":\"medium\",\"model\":\"string\",\"temperature\":0.3,\"text\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.cohere.com/v1/summarize"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"additional_command\":\"string\",\"extractiveness\":\"low\",\"format\":\"paragraph\",\"length\":\"medium\",\"model\":\"string\",\"temperature\":0.3,\"text\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.cohere.com/v1/summarize")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"additional_command\":\"string\",\"extractiveness\":\"low\",\"format\":\"paragraph\",\"length\":\"medium\",\"model\":\"string\",\"temperature\":0.3,\"text\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cohere.com/v1/summarize");
request.Content = new StringContent("{\"additional_command\":\"string\",\"extractiveness\":\"low\",\"format\":\"paragraph\",\"length\":\"medium\",\"model\":\"string\",\"temperature\":0.3,\"text\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "string",
  "meta": {
    "api_version": {
      "is_deprecated": true,
      "is_experimental": true,
      "version": "string"
    },
    "billed_units": {
      "classifications": 0,
      "image_tokens": 0,
      "images": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "pages": 0,
      "search_units": 0
    },
    "cached_tokens": 0,
    "tokens": {
      "input_tokens": 0,
      "output_tokens": 0
    },
    "warnings": [
      "string"
    ]
  },
  "summary": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

Search documentation

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations

Parameters

Request body

Responses

Headers

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations