> ## Documentation Index
> Fetch the complete documentation index at: https://docs.diversion.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# api

> CLI のサインイン情報を使って Diversion API を呼び出す

`dv api` を使うと、ターミナルから認証済みのリクエストを送信できます。このコマンドは、既存の CLI のサインイン情報とアカウントの権限を使用します。サインインが必要な場合は、[`dv login`](https://docs.diversion.dev/ja/cmd-ref/login) を実行してください。

## リクエストを送信する

`dv help api` を実行して、お使いの CLI にこのコマンドが含まれていることを確認します。次に、アクセスできるリポジトリを一覧表示します。

```bash theme={null}
dv api /repos
```

`/repos` のようなエンドポイントパスを指定します。CLI は `/v0` を含む API のベース URL を付加します。パスにクエリパラメーターが含まれる場合は、パスを引用符で囲みます。[ユーザーのリポジトリを一覧表示](https://docs.diversion.dev/ja/api-reference/repository-management/list-users-repositories.md)。

```bash theme={null}
dv api '/repos?owned=true'
```

1 つのリポジトリを確認するには、`REPO_ID` を一覧の `repo_id` に置き換えます。[リポジトリの詳細を取得](https://docs.diversion.dev/ja/api-reference/repository-manipulation/get-repository-details.md)。

```bash theme={null}
dv api /repos/REPO_ID
```

## メソッドを選択して JSON を送信する

```bash theme={null}
dv api <path> [-X <method>] [-d '<json>']
```

デフォルトのメソッドは `GET` です。別のメソッドを指定するには `-X` を、JSON のリクエストボディを渡すには `-d` を使用します。エンドポイントのメソッドとボディのフィールドは [API リファレンス](https://docs.diversion.dev/ja/api-reference/introduction.md) で確認できます。

## スクリプトでレスポンスを使用する

このコマンドはレスポンスボディを標準出力に書き込みます。HTTP エラーの場合もボディを書き込み、ステータスを標準エラー出力に表示して、0 以外の終了コードで終了します。

Bash では `pipefail` を有効にして、`jq` が成功した場合でもリクエストの失敗によってパイプラインが失敗するようにします。次の例では、リポジトリ名を 1 行に 1 つずつ表示します。

```bash theme={null}
set -o pipefail
dv api /repos | jq -r '.items[].repo_name'
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.