---
title: Sends API
description: Inspect send configurations and runs, preview changes, confirm writes, pause schedules, and read value-free errors.
species: reference
---
# Sends API

The sends API controls configurations already authored in Supernova. Read operations require an accepted send-read scope; preview, run, pause, and resume require send-write access.

## Read configurations

```endpoint
GET /sends
```

Returns up to 100 configurations with the latest run.

```endpoint
GET /sends/{id}
```

Returns destination, model, object type, match rule, mappings, create policy, schedule, and 5 recent runs.

```endpoint
GET /sends/{id}/runs
```

Returns up to 100 run resources with status, `dry_run`, `needs_confirmation`, timestamps, stats, and top-level error categories.

## Preview and run

```endpoint
POST /sends/{id}/preview
```

Starts a dry run. It never writes and never changes the diff baseline.

```endpoint
POST /sends/{id}/run
```

Starts a write run. Body flags can request `confirm` after reviewing a preview or `full` to clear the prior diff baseline. `409 send_paused` means resume first. `409 send_in_progress` means existing work already owns the configuration.

## Pause and resume

```endpoint
POST /sends/{id}/pause
```

```endpoint
POST /sends/{id}/resume
```

Pause prevents new scheduled runs; it does not claim to roll back destination writes already confirmed.

## Inspect a run

`GET /sends/{id}/runs/{runId}/preview` returns bounded preview samples. `GET /sends/{id}/runs/{runId}/errors` returns at most 500 value-free row errors plus stats. `GET /sends/{id}/stream` follows current progress.

Missing ids and cross-organization ids both return `404 send_not_found`.
