Skip to main content
POST
/
api
/
ai
/
v1
/
text
/
summarize
curl --request POST \
  --url https://example.com/v1/api/ai/v1/text/summarize \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "input": "San Francisco, officially the City and County of San Francisco, is a commercial, financial, and cultural center..."
}
'
{
  "output": "Vibrant, densely populated commercial and cultural hub in Northern California.",
  "modelId": "domo.domo_ai.domogpt-summarize-v1:anthropic"
}

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Domo Developer Token for authentication.

Body

application/json
​
input
string
required

The input text to send to the model.

​
outputStyle
enum<string>

The formatting of the summarized output.

Available options:
BULLETED,
NUMBERED,
PARAGRAPH
​
outputWordLength
object
Example:
{ "min": 5, "max": 10 }
​
model
string

The ID of the model to use.

​
modelConfiguration
object

Additional model-specific configuration key-value pairs (e.g., temperature).

Example:
{ "temperature": 0.7, "max_tokens": 1024 }
​
promptTemplate
object

A prompt template object. The 'template' string should contain placeholders.

​
parameters
object

Custom parameters to inject into the prompt template.

Example:
{ "language": "Japanese" }
​
system
string

The system message to use.

Response

The generated text summary.

Standard successful AI response.

​
output
string
​
modelId
string