Cohere Summarize API
The Summarize API from Cohere — 1 operation(s) for summarize.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cohere:cohere-summarize-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Cohere Summarize API
version: 1.0.0
servers:
- url: https://api.cohere.com
description: production
tags:
- name: Summarize
paths:
/v1/summarize:
post:
operationId: summarize
summary: Summarize
description: 'This API is marked as "Legacy" and is no longer maintained. Follow the migration guide to start using the Chat API.
Generates a summary in English for a given text.'
parameters:
- name: X-Client-Name
in: header
description: 'The name of the project that is making the request.
'
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/summarize_Response_200'
'400':
description: "This error is returned when the request is not well formed. This could be because:\n - JSON is invalid\n - The request is missing required fields\n - The request contains an invalid combination of fields\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestBadRequestError'
'401':
description: "This error indicates that the operation attempted to be performed is not allowed. This could be because:\n - The api token is invalid\n - The user does not have the necessary permissions\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestUnauthorizedError'
'403':
description: "This error indicates that the operation attempted to be performed is not allowed. This could be because:\n - The api token is invalid\n - The user does not have the necessary permissions\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestForbiddenError'
'404':
description: "This error is returned when a resource is not found. This could be because:\n - The endpoint does not exist\n - The resource does not exist eg model id, dataset id\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestNotFoundError'
'422':
description: "This error is returned when the request is not well formed. This could be because:\n - JSON is invalid\n - The request is missing required fields\n - The request contains an invalid combination of fields\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestUnprocessableEntityError'
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestTooManyRequestsError'
'498':
description: 'This error is returned when a request or response contains a deny-listed token.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestInvalidTokenError'
'499':
description: 'This error is returned when a request is cancelled by the user.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestClientClosedRequestError'
'500':
description: 'This error is returned when an uncategorised internal server error occurs.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestInternalServerError'
'501':
description: 'This error is returned when the requested feature is not implemented.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestNotImplementedError'
'503':
description: "This error is returned when the service is unavailable. This could be due to:\n - Too many users trying to access the service at the same time\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestServiceUnavailableError'
'504':
description: "This error is returned when a request to the server times out. This could be due to:\n - An internal services taking too long to respond\n"
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeRequestGatewayTimeoutError'
deprecated: true
requestBody:
description: ''
content:
application/json:
schema:
type: object
properties:
text:
type: string
minLength: 250
maxLength: 50000
description: The text to generate a summary for. Can be up to 100,000 characters long. Currently the only supported language is English.
length:
$ref: '#/components/schemas/V1SummarizePostRequestBodyContentApplicationJsonSchemaLength'
default: medium
description: 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:
$ref: '#/components/schemas/V1SummarizePostRequestBodyContentApplicationJsonSchemaFormat'
default: paragraph
description: 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.
model:
type: string
description: 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:
$ref: '#/components/schemas/V1SummarizePostRequestBodyContentApplicationJsonSchemaExtractiveness'
default: low
description: 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.
temperature:
type: number
format: double
minimum: 0
maximum: 5
default: 0.3
description: 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_command:
type: string
description: 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"
required:
- text
security:
- bearerAuth: []
tags:
- Summarize
components:
schemas:
summarize_Response_200:
type: object
properties:
id:
type: string
description: Generated ID for the summary
summary:
type: string
description: Generated summary for the text
meta:
$ref: '#/components/schemas/ApiMeta'
title: summarize_Response_200
V1SummarizePostRequestBodyContentApplicationJsonSchemaExtractiveness:
type: string
enum:
- low
- medium
- high
default: low
description: 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.
title: V1SummarizePostRequestBodyContentApplicationJsonSchemaExtractiveness
V1SummarizePostRequestBodyContentApplicationJsonSchemaFormat:
type: string
enum:
- paragraph
- bullets
default: paragraph
description: 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.
title: V1SummarizePostRequestBodyContentApplicationJsonSchemaFormat
SummarizeRequestForbiddenError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestForbiddenError
SummarizeRequestInternalServerError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestInternalServerError
SummarizeRequestClientClosedRequestError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestClientClosedRequestError
SummarizeRequestBadRequestError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestBadRequestError
SummarizeRequestNotImplementedError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestNotImplementedError
V1SummarizePostRequestBodyContentApplicationJsonSchemaLength:
type: string
enum:
- short
- medium
- long
default: medium
description: 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.
title: V1SummarizePostRequestBodyContentApplicationJsonSchemaLength
ApiMetaApiVersion:
type: object
properties:
version:
type: string
is_deprecated:
type: boolean
is_experimental:
type: boolean
required:
- version
title: ApiMetaApiVersion
SummarizeRequestInvalidTokenError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestInvalidTokenError
SummarizeRequestTooManyRequestsError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestTooManyRequestsError
SummarizeRequestUnauthorizedError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestUnauthorizedError
ApiMetaTokens:
type: object
properties:
input_tokens:
type: number
format: double
description: 'The number of tokens used as input to the model.
'
output_tokens:
type: number
format: double
description: 'The number of tokens produced by the model.
'
title: ApiMetaTokens
SummarizeRequestServiceUnavailableError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestServiceUnavailableError
SummarizeRequestNotFoundError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestNotFoundError
SummarizeRequestUnprocessableEntityError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestUnprocessableEntityError
SummarizeRequestGatewayTimeoutError:
type: object
properties:
message:
type: string
id:
type: string
title: SummarizeRequestGatewayTimeoutError
ApiMetaBilledUnits:
type: object
properties:
images:
type: number
format: double
description: 'The number of billed images.
'
input_tokens:
type: number
format: double
description: 'The number of billed input tokens.
'
image_tokens:
type: number
format: double
description: 'The number of billed image tokens.
'
output_tokens:
type: number
format: double
description: 'The number of billed output tokens.
'
search_units:
type: number
format: double
description: 'The number of billed search units.
'
classifications:
type: number
format: double
description: 'The number of billed classifications units.
'
pages:
type: number
format: double
description: 'The number of billed pages parsed.
'
title: ApiMetaBilledUnits
ApiMeta:
type: object
properties:
api_version:
$ref: '#/components/schemas/ApiMetaApiVersion'
billed_units:
$ref: '#/components/schemas/ApiMetaBilledUnits'
tokens:
$ref: '#/components/schemas/ApiMetaTokens'
cached_tokens:
type: number
format: double
description: 'The number of prompt tokens that hit the inference cache.
'
warnings:
type: array
items:
type: string
title: ApiMeta
securitySchemes:
bearerAuth:
type: http
scheme: bearer