> This page is for Gateway.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# Create compression

POST https://api-gateway.merge.dev/v1/compressions
Content-Type: application/json

Shorten a context and prompt into one prompt to send to another model.

Reference: https://docs.merge.dev/merge-gateway/api-overview/compressions/create

## Authentication

- `Authorization` header (bearer token, required) — Your production key sent as a bearer token.

## Request

### Body (application/json)

This endpoint expects a CompressionRequestSchema.

- `model` (string, required) — Compression model ID, for example `scaledown/compress`.
- `context` (string, required) — Background text to compress. Can't be blank.
- `prompt` (string, required) — The question or instruction the context should be shortened for. Can't be blank.
- `rate` (CompressionRequestSchemaRate, optional, default: auto) — `auto`, or the share of tokens to remove, between 0 and 1.
- `vendor` (string, optional, nullable) — Optional execution vendor pin.
- `customer` (string, optional, nullable) — Optional customer UUID to scope the key, budget, and usage to.

## Response

### 200

Successful Response

- `model` (string, required) — Model that answered.
- `vendor` (string, required) — Vendor that served the request.
- `compressed_prompt` (string, required) — The context, shortened to what's relevant to `prompt`. Send it with your prompt to the next model.
- `usage` (CompressionUsage, required) — Token usage for a compression request. Input is the original tokens.
- `object` ("compression", optional, default: compression)
- `original_tokens` (integer, optional, nullable) — Tokens before compression.
- `compressed_tokens` (integer, optional, nullable) — Tokens in `compressed_prompt`.
- `compression_ratio` (double, optional, nullable) — `compressed_tokens` divided by `original_tokens`.

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### CompressionRequestSchemaRate

`auto`, or the share of tokens to remove, between 0 and 1.

- "auto"
- double

### CompressionUsage

Token usage for a compression request. Input is the original tokens.

- `input_tokens` (integer, required)
- `output_tokens` (integer, required)
- `total_tokens` (integer, required)
- `cost` (double, optional, nullable) — Cost of the request in USD.

### ValidationError

Single field-level validation error. `loc` is the JSON path to the offending field, `msg` is a human-readable explanation, and `type` is a stable machine-readable error code.

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (ValidationErrorCtx, optional)

### ValidationErrorLocItems

- string
- integer

### ValidationErrorCtx

## Examples

**Request**

```json
{
  "model": "string",
  "context": "string",
  "prompt": "string"
}
```

**Response**

```json
{
  "model": "string",
  "vendor": "string",
  "compressed_prompt": "string",
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1,
    "total_tokens": 1,
    "cost": 1.1
  },
  "object": "compression",
  "original_tokens": 1,
  "compressed_tokens": 1,
  "compression_ratio": 1.1
}
```

**SDK Code**

```python
import requests

url = "https://api-gateway.merge.dev/v1/compressions"

payload = {
    "model": "string",
    "context": "string",
    "prompt": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-gateway.merge.dev/v1/compressions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"model":"string","context":"string","prompt":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gateway.merge.dev/v1/compressions"

	payload := strings.NewReader("{\n  \"model\": \"string\",\n  \"context\": \"string\",\n  \"prompt\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-gateway.merge.dev/v1/compressions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"string\",\n  \"context\": \"string\",\n  \"prompt\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-gateway.merge.dev/v1/compressions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"string\",\n  \"context\": \"string\",\n  \"prompt\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway.merge.dev/v1/compressions', [
  'body' => '{
  "model": "string",
  "context": "string",
  "prompt": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-gateway.merge.dev/v1/compressions");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"model\": \"string\",\n  \"context\": \"string\",\n  \"prompt\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "model": "string",
  "context": "string",
  "prompt": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway.merge.dev/v1/compressions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```