Skip to main content
POST
/
ai
/
tools
/
documents
/
summarize
Summarize documents.
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/tools/documents/summarize \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --data '
{
  "items": [
    {
      "id": 123
    }
  ],
  "ignoreUnknownIds": false,
  "language": "English"
}
'
{
  "items": [
    {
      "id": 123,
      "summary": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Headers

content-type
string
required

Body

application/json
items
(DocumentInternalId · object | DocumentExternalId · object | DocumentInstanceId · object)[]
required

A list of documents to summarize.

Required array length: 1 element
ignoreUnknownIds
boolean
default:false

If true, the API will not fail if any documents are missing, but summaries for the missing documents will be excluded from the response.

language
enum<string>
default:English

The language in which the answer should be provided.

Available options:
Chinese,
Dutch,
English,
French,
German,
Italian,
Japanese,
Korean,
Latvian,
Norwegian,
Portuguese,
Spanish,
Swedish

Response

Successful Response

items
(DocumentSummarizationResponseItemInternalId · object | DocumentSummarizationResponseItemExternalId · object | DocumentSummarizationResponseItemInstanceId · object)[]
required

A list of documents with summaries.

Last modified on April 23, 2026