SALZ
Sign Up

API Reference Overview

Complete reference for the SALZ API -- endpoints, request and response schemas, error codes, and versioning.

This page provides a high-level overview of the SALZ API surface. For detailed schema documentation, see the individual pages linked below.

Endpoints

SALZ currently exposes a single endpoint:

MethodPathDescription
POST/api/v1/optimizeOptimize AI-generated text to sound natural

Request Schema

{
  "text": "string (required, max 10,000 characters)"
}

The text field is the only required parameter. It contains the AI-generated text you want to optimize.

Response Schema

Success (200)

{
  "optimized": "string",
  "success": true
}

Error (4xx / 5xx)

{
  "error": "string",
  "success": false
}

HTTP Status Codes

CodeMeaning
200Success -- optimized text returned
400Bad request -- missing or invalid text field
401Unauthorized -- missing or invalid API key
403Forbidden -- API key does not have access
429Too many requests -- rate limit exceeded
500Internal server error -- retry with backoff

Required Headers

Every request must include:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Rate Limit Headers

Every response includes rate limit information:

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 19

See Rate Limiting for details on limits per tier.

Versioning

The API uses URL-based versioning. The current version is v1:

https://add-salz.io/api/v1/optimize

When new versions are released, v1 will continue to work. Deprecation notices will be communicated at least 6 months in advance via email and the API response headers.

Content Type

SALZ accepts and returns application/json exclusively. Requests with other content types will receive a 400 response.