Compress text

Compress text with a preset or a custom operation chain. Every request returns a job, always the same shape. Small inline inputs are processed inline and the job comes back already completed (HTTP 200, result included); everything else is queued (HTTP 202) and finishes asynchronously. Fast-path eligibility: inline text of at most 50 KB (UTF-8) with no webhookUrl. Everything else is queued.

Request

Authorization

string

required

Bearer sk_live_...

Idempotency-Key

string

Optional, 1–255 characters. Returns the existing job if a job with this key was already created. Applies to queued jobs only; fast-path jobs complete inline and are not deduplicated.

text

string

Inline text to process, up to 5,000,000 characters. Provide exactly one of text or fileId.

fileId

string

Id of an upload, .pdf or .txt only.

preset

string

One of chill, medium, aggressive. Either preset or operations is required.

operations

array

1–10 custom operations, applied in order. See below.

webhookUrl

string

URL to receive job.completed / job.failed events for this job. Forces the queued path. Requires a plan with webhooks.

Presets

Preset	Operations
`chill`	`trim` (intensity 30): light whitespace cleanup
`medium`	`trim` (intensity 70): full whitespace, punctuation, and unicode normalization
`aggressive`	`trim` (intensity 80) + `json-to-toon`

Operations

Type	Params	Description
`trim`	`intensity` (0–100, default 50)	Whitespace, punctuation and unicode cleanup, lossless for meaning
`json-to-toon`	None	Convert large JSON blocks to TOON tabular notation (skips blocks too small to benefit)

GET /v1/text/presets and GET /v1/text/operations return these definitions as JSON.

Examples

Fast path (inline text)

curl -s https://api.robinzip.app/v1/text \
  -H "Authorization: Bearer $ROBIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello   world...", "preset": "medium"}'

Queued (uploaded PDF)

curl -s https://api.robinzip.app/v1/text \
  -H "Authorization: Bearer $ROBIN_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: report-2026-07" \
  -d '{"fileId": "665f1c2ab8d4e91a2c3d4e5f", "operations": [{"type": "trim", "params": {"intensity": 80}}, {"type": "json-to-toon"}]}'

{
  "success": true,
  "data": {
    "id": "665f1d00b8d4e91a2c3d4e60",
    "status": "completed",
    "result": {
      "outputText": "Hello world...",
      "metrics": {
        "inputSize": 18,
        "outputSize": 15,
        "compressionRatio": 0.8333,
        "processingMs": 2,
        "operationsApplied": ["trim"]
      }
    }
  }
}

{
  "success": true,
  "data": {
    "id": "665f1d00b8d4e91a2c3d4e60",
    "status": "created"
  }
}

Results

One code path handles both: check status. If it’s completed, the result is already in the response. Otherwise poll GET /v1/jobs/:id (ideally with ?wait=25 to long-poll) or wait for the webhook. Jobs created from inline text return result.outputText; jobs created from a fileId return result.outputUrl pointing to a .txt file. PDFs have their text extracted before processing.

Credits

1 credit per started 100 KB of input, reserved up front and refunded if the job ultimately fails. See Credits.

Getting Started

Core Concepts

API Reference

Compress text

Request

Presets

Operations

Examples

Results

Credits

​Request

​Presets

​Operations

​Examples

​Results

​Credits

Request

Presets

Operations

Examples

Results

Credits