API Reference

Generate a summary for the provided context

post
https://{workspaceId}.clinia.cloud/ai/v1/summarize

Generate a summary for the provided context. This is similar to the Complete endpoint, but is designed for summarization tasks. it does not require a conversation ID and does not store the conversation history.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The summarization task to perform (e.g. "knowledge-answer").

params
object
required

Key/value inputs for that task, must conform to the JSON-Schema of the chosen task.

retriever
object

When provided, instructs the service how to fetch dynamic parameters from a vector store.

string

A param name (e.g. "hits") that will be used to store the results of the retriever. Only necessary if retriever is specified.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 10 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/event-stream

Updated 10 months ago