# Brief (`brief-1`): Summarization

A few sentences that say what a long text says.

Brief condenses an article, report, thread or transcript into a short summary written in full sentences. Pick `short` for a one-line gist, `medium` for a paragraph, `long` for more detail.

It rewrites from the text itself and works best on English news-style and business writing.

- **Price:** $0.30 per 1,000 summaries. One unit per started 3,000 characters of input.
- **Languages:** English
- **Input:** A string or array of up to 8 (up to 6,000 characters each; longer texts are cut).
- **Batch:** yes, up to 8 inputs per call
- **Status:** live
- **Built on:** [sshleifer/distilbart-cnn-6-6](https://huggingface.co/sshleifer/distilbart-cnn-6-6), Apache-2.0, 230M (DistilBART)

## Request

```bash
curl https://labs.greatwork.company/v1/run \
  -H "Authorization: Bearer $GWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"brief-1","input":"City officials approved a plan on Tuesday to convert three downtown parking garages into mixed-use buildings with apartments, shops and a public library branch. The project, expected to take four years, will add about 900 homes, a third of them priced for lower-income residents. Supporters said the garages sit half-empty since more people started working from home, while some business owners worried about losing parking for customers. The council added a requirement that each building keep at least 150 public parking spaces on its ground floors. Construction on the first garage is set to begin next spring.","length":"short"}'
```

## Options

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `input` | string or string[] | yes | | A string or array of up to 8 (up to 6,000 characters each; longer texts are cut). |
| `length` | string (short \| medium \| long) | no | `"medium"` | Summary length: short (one sentence), medium (a paragraph) or long. |

## Output

| Field | Type | Description |
|---|---|---|
| `summary` | string | The summary. |

The response envelope is always `{"id", "object": "run", "model", "created", "output", "usage": {"units", "unit", "cost_usd", "cost_micros"}, "latency_ms"}`. With an array input, `output` is an array in the same order.

## Examples (real outputs from our servers)

### News article

```json
{
  "model": "brief-1",
  "input": "City officials approved a plan on Tuesday to convert three downtown parking garages into mixed-use buildings with apartments, shops and a public library branch. The project, expected to take four years, will add about 900 homes, a third of them priced for lower-income residents. Supporters said the garages sit half-empty since more people started working from home, while some business owners worried about losing parking for customers. The council added a requirement that each building keep at least 150 public parking spaces on its ground floors. Construction on the first garage is set to begin next spring.",
  "length": "short"
}
```

```json
{
  "summary": "City officials approve plan to convert three downtown parking garages into mixed-use buildings. The project will add about 900 homes, a third of them priced for lower-income residents. Supporters say the garages sit half-empty since more people started working from home."
}
```

3238 ms, $0.0003.

## Good for

- Summaries for article cards and newsletters
- TL;DR for long support threads
- Digest daily reports
- Preview long emails

## Limits and caveats

- English only.
- It can copy a sentence from the text word for word; that's normal for this style of model.
- For summaries that must be checked against the source, run Ground on the result.
