---
title: 送信 API
description: 送信の設定と実行を確認し、変更をプレビューし、書き込みを承認し、スケジュールを一時停止して、値を含まないエラーを読み取ります。
species: reference
---
# 送信 API

送信 API は、Supernova で作成済みの設定を制御します。読み取り操作には、受け付けられる送信読み取りスコープが必要です。プレビュー、実行、一時停止、再開には、送信の書き込み権限が必要です。

## 設定を読み取り

```endpoint
GET /sends
```

最新の実行とともに、最大 100 件の設定を返します。

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

送信先、モデル、オブジェクトの種類、照合ルール、マッピング、作成ポリシー、スケジュール、最近の 5 件の実行を返します。

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

ステータス、`dry_run`、`needs_confirmation`、タイムスタンプ、統計、最上位のエラー分類を含む実行リソースを、最大 100 件返します。

## プレビューと実行

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

ドライランを開始します。書き込みは行わず、差分の基準も変更しません。

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

書き込みを伴う実行を開始します。本文のフラグで、プレビューの確認後に `confirm` を要求したり、`full` を指定して以前の差分の基準をクリアしたりできます。`409 send_paused` は、先に再開が必要であることを示します。`409 send_in_progress` は、既存の処理がその設定をすでに使用中であることを示します。

## 一時停止と再開

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

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

一時停止すると、新たなスケジュール実行を防ぎます。確認済みの送信先への書き込みをロールバックするものではありません。

## 実行を確認

`GET /sends/{id}/runs/{runId}/preview` は、件数を限定したプレビューのサンプルを返します。`GET /sends/{id}/runs/{runId}/errors` は、値を含まない行エラーを最大 500 件と統計を返します。`GET /sends/{id}/stream` は、現在の進捗を追跡します。

存在しない ID と別の組織の ID は、どちらも `404 send_not_found` を返します。