# Amazon Interactive Video Service API

> Amazon Interactive Video Service API on Apizie: 30 endpoints (Performs GetChannel on multiple ARNs simultaneously., Performs GetStreamKey on multiple ARNs simultaneously., Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously., Creates a new channel and an associated stream key to start streaming., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-ivs`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-ivs
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-ivs/openapi.json

Introduction The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses,…

## Endpoints

### Performs GetChannel on multiple ARNs simultaneously.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/batch-get-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Performs GetStreamKey on multiple ARNs simultaneously.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/batch-get-stream-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/batch-start-viewer-session-revocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new channel and an associated stream key to start streaming.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/create-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/create-recording-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/create-stream-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Deletes the specified channel and its associated stream keys. If you try to delete a live channel, you will…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/delete-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/delete-playback-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/delete-recording-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Deletes the stream key for the specified ARN, so it can no longer be used to stream.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/delete-stream-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets the channel configuration for the specified channel ARN. See also BatchGetChannel .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/get-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets a specified playback authorization key pair and returns the arn and fingerprint . The privateKey held…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/get-playback-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets the recording configuration for the specified ARN.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/get-recording-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets information about the active (live) stream on a specified channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/get-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets stream-key information for a specified ARN.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/get-stream-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets metadata on a specified stream.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/get-stream-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Imports the public portion of a new key pair and returns its arn and fingerprint . The privateKey can then…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/import-playback-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets summary information about all channels in your account, in the Amazon Web Services region where the API…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-playback-key-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets summary information about all recording configurations in your account, in the Amazon Web Services…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-recording-configurations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets summary information about stream keys for the specified channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-stream-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets a summary of current and previous streams for a specified channel in your account, in the AWS region…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-stream-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets summary information about live streams in your account, in the Amazon Web Services region where the API…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-streams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets information about Amazon Web Services tags for the specified ARN.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource to be retrieved. The ARN must be URL-encoded. |

### Adds or updates tags for the Amazon Web Services resource with the specified ARN.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded. |
| body | object | yes | JSON request body |

### Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/put-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/start-viewer-session-revocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/stop-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Removes tags from the resource with the specified ARN.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | ARN of the resource for which tags are to be removed. The ARN must be URL-encoded. |
| tagKeys | array | yes | Array of tags to be removed. Array of maps, each of the form s tring:string (key:value) . See Tagging Amazon Web Services Resources for… |

### Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/update-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/batch-get-channel" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Interactive Video Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-ivs/batch-get-channel with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Interactive Video Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Interactive Video Service itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Interactive Video Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-ivs.

### What is the status of the Amazon Interactive Video Service API?
Needs your own provider key (bring your own key)