Optimization Parameters

Optional parameters for the SALZ optimize endpoint -- tone, formality, target audience, keyword preservation, and output length.

The SALZ optimize endpoint accepts optional parameters that give you more control over how your text is rewritten. The text field is the only required parameter -- everything else fine-tunes the output.

Basic Request (No Parameters)

The simplest request sends only the text:

{
  "text": "Your AI-generated text here."
}

SALZ applies its default optimization: removing AI patterns, improving flow, and making the text sound naturally written.

Available Parameters

tone

Control the emotional tone of the output.

ValueDescription
neutralDefault. Balanced, professional tone.
casualConversational and approachable.
formalPolished and authoritative.
friendlyWarm and personable.
{
  "text": "Our solution leverages cutting-edge AI to optimize workflows.",
  "tone": "casual"
}

Possible output: "Our tool uses AI to make your workflows faster and simpler."

formality

Adjust the formality level independently from tone.

ValueDescription
lowContractions, simple words, short sentences.
mediumDefault. Standard professional writing.
highNo contractions, precise vocabulary, longer sentences.
{
  "text": "The platform enables users to create and manage projects.",
  "formality": "low"
}

Possible output: "You can create and manage projects right from the platform."

audience

Specify who the text is written for. This adjusts vocabulary and complexity.

ValueDescription
generalDefault. Accessible to a broad audience.
technicalDevelopers and technical readers. Preserves jargon where appropriate.
executiveBusiness decision-makers. Focuses on outcomes and value.
consumerEnd users. Simple, benefit-focused language.
{
  "text": "The API utilizes RESTful architecture with JSON payloads.",
  "audience": "executive"
}

Possible output: "The API follows industry-standard web conventions, making it straightforward to integrate."

preserve_keywords

A list of words or phrases that should not be changed in the output. Useful for brand names, product names, and technical terms.

{
  "text": "SuperWidget Pro enables teams to leverage advanced analytics.",
  "preserve_keywords": ["SuperWidget Pro"]
}

The optimization will leave "SuperWidget Pro" exactly as-is while rewriting the surrounding text.

max_length

Set a maximum character count for the output. SALZ will try to stay within this limit while preserving meaning.

{
  "text": "A very long AI-generated paragraph...",
  "max_length": 280
}

This is useful for social media posts, meta descriptions, or any context with character limits.

Combining Parameters

You can use multiple parameters together:

{
  "text": "Our comprehensive platform leverages cutting-edge artificial intelligence to deliver meaningful, actionable insights that drive business outcomes.",
  "tone": "friendly",
  "formality": "low",
  "audience": "consumer",
  "preserve_keywords": ["actionable insights"],
  "max_length": 200
}

Full Request Example

curl -X POST https://add-salz.io/api/v1/optimize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "It is imperative that organizations implement robust data governance frameworks to ensure compliance with regulatory requirements.",
    "tone": "casual",
    "audience": "general"
  }'

Response:

{
  "optimized": "Companies need solid data practices to stay on the right side of regulations.",
  "success": true
}

Parameter Defaults

If you omit all optional parameters, SALZ uses these defaults:

ParameterDefault
toneneutral
formalitymedium
audiencegeneral
preserve_keywords[] (none)
max_lengthNo limit

Tips

  • Start without parameters. The defaults work well for most use cases. Add parameters only when you need specific control.
  • Test with the playground. The SALZ web playground lets you experiment with different parameter combinations before coding them into your application.
  • Preserve brand terms. If your text includes product names or branded phrases, use preserve_keywords to keep them intact.