# コネクション API


## RequestKeyFrame

*バージョン 2024.2.0 で追加。*

**x-sora-target**: Sora_20241218.RequestKeyFrame

指定したチャネルで配信している接続に対してキーフレームを要求します。

この API は `role` が `sendrecv` または `sendonly` の接続にのみ有効です。

キーフレーム要求を送ってからキーフレームが送られてくるまでは、
1 秒間隔で最大 5 回までリクエストを送信します。

`channel_id` や `connection_id` が存在しない場合はエラーとなります。

| キー | 型 |
| --- | --- |
| channel_id | string |
| connection_id | string |

```console
$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20241218.RequestKeyFrame" \
    --json '{"channel_id":"sora","connection_id":"KDBN2YD1A919V5BA2JX6TG2RP8"}' \
    | jq .
{
    "channel_id": "sora",
    "connection_id": "KP8VZZ321D0A90RSVJC4RMGJ08"
}
```