AWS Amazon Interactive Video Service
Browse all Amazonaws APIs61
AI ReadinessAI-Aware (B-)61/100
Agent-ready OpenAPI document · curated by JenticMediaVideo Processinghmac28 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Provision live streaming channels, manage stream keys and recordings, and authorise playback for low-latency interactive video applications.
Use for: I need to spin up a new live streaming channel, Get the playback URL for a channel, Rotate the stream key for a creator's channel, List all live streams happening in us-east-1 right now
Not supported: Does not handle video-on-demand transcoding, ad insertion, or chat - use for low-latency live streaming channel and recording management only.
Jentic publishes the only available OpenAPI specification for Amazon Interactive Video Service, keeping it validated and agent-ready. Amazon IVS is a managed live streaming service that ingests RTMPS broadcasts and delivers low-latency HLS playback to viewers worldwide. The 28-endpoint API covers channel creation, stream key rotation, recording configurations that archive sessions to S3, playback authorization keys for private streams, and EventBridge integration for real-time stream lifecycle signals. It is built for interactive applications such as live shopping, esports, and audience-driven shows where sub-five-second glass-to-glass latency matters.
Install Jentic One Beta
Connect the Amazon Interactive Video Service to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Amazon Interactive Video Service, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Fivs" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Fivs" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Amazon Interactive Video Service API.
Provision low-latency live streaming channels via /CreateChannel
Generate and rotate broadcast stream keys with /CreateStreamKey
Configure session recording to S3 through /CreateRecordingConfiguration
Authorise private playback via signed JWT with playback key pairs
List active live streams in a region using /ListStreams
Stop in-progress streams server-side with /StopStream
Tag channels and resources for billing and inventory tracking
Use Cases
Patterns agents use Amazon Interactive Video Service API for, with concrete tasks.
★ Live Shopping Streams
Power live shopping experiences where presenters demo products and viewers buy in real time. Amazon IVS provides sub-five-second latency, channel-per-creator provisioning, and EventBridge signals when streams start or stop so the storefront can flip product availability immediately. The /CreateChannel and /CreateStreamKey endpoints let teams onboard a new presenter in seconds rather than minutes.
Create a new IVS channel named 'spring-collection-live' with STANDARD type, generate a stream key, and return the ingest endpoint and playback URL
Creator Platform Channel Lifecycle
Run a creator economy platform where each user gets their own channel and stream key. The IVS API supports per-creator resource provisioning, stream key rotation when creators are compromised, and tag-based filtering so platform analytics can group streams by tier or vertical. Recording configurations let creators automatically archive every broadcast to S3 for VOD playback later.
Create a recording configuration that writes to bucket 'creator-archives' with thumbnail interval 60 and attach it to channel arn:aws:ivs:us-east-1:123:channel/abc
Private and Token-Gated Playback
Restrict live streams to authenticated viewers using IVS playback authorization. The /ImportPlaybackKeyPair endpoint imports an ECDSA public key, and the application backend signs short-lived JWTs that the player exchanges for stream access. This pattern fits paid events, internal town halls, and any context where playback URLs cannot be public.
Import a playback key pair named 'paid-event-key' with the supplied PEM public key for use signing playback JWTs
AI Agent Live Stream Operations
AI agents call Amazon IVS through Jentic to provision channels on demand, rotate compromised stream keys, and stop streams that violate policy. The agent searches Jentic for the right operation, loads the input schema, and executes with credentials kept in your Jentic One instance. This is faster than embedding SigV4 signing into every agent runtime and keeps AWS keys out of the LLM context.
Search Jentic for 'stop a live stream', load the StopStream schema, and execute against channel arn:aws:ivs:us-east-1:123:channel/abc
Key Endpoints
28 endpoints — jentic publishes the only available openapi specification for amazon interactive video service, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/CreateChannel
Create a live streaming channel
POST
/CreateStreamKey
Generate a broadcast stream key
POST
/CreateRecordingConfiguration
Configure S3 recording for a channel
POST
/ListStreams
List active live streams
POST
/StopStream
Stop an in-progress live stream
POST
/GetStream
Get details of a live stream session
POST
/BatchGetChannel
Batch fetch channel metadata
POST
/CreateChannel
Create a live streaming channel
POST
/CreateStreamKey
Generate a broadcast stream key
POST
/CreateRecordingConfiguration
Configure S3 recording for a channel
POST
/ListStreams
List active live streams
POST
/StopStream
Stop an in-progress live stream
POST
/GetStream
Get details of a live stream session
POST
/BatchGetChannel
Batch fetch channel metadata
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
Amazon Interactive Video Service
- AI-Aware (B-)61/100
99
Foundational Compliance62
Developer Experience & Jentic Compatibility38
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
62
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
48%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
38
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
52%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Amazon IVS API by hand means building AWS Signature Version 4 signing, selecting the right regional host from ivs.{region}.amazonaws.com, wiring IAM permissions, and handling AWS throttling and retries yourself. Through Jentic you install once, import Amazon Interactive Video Service from the API Directory, store the AWS access key and secret once, and your agent calls it.
Permission scoping
IVS operations are RPC-style calls such as CreateChannel and StopStream that carry the channel ARN in the request body, so limit the agent to the operations it needs, such as CreateChannel or ListStreams. You choose the operations it may call, so destructive ones like StopStream or DeleteChannel are not included unless you add them.
Credential isolation
Your AWS access key and secret for IVS are stored once, encrypted, by your own Jentic One instance and signed with SigV4 at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a low-latency live streaming channel' or 'stop a live stream', and Jentic returns the matching IVS operation with its input schema so the agent calls the right endpoint without reading the AWS reference.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Amazon Interactive Video Service API through Jentic.
Why is there no official OpenAPI spec for Amazon Interactive Video Service?
AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon Interactive Video Service via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Amazon IVS API use?
Amazon IVS uses AWS Signature Version 4 (SigV4) HMAC request signing. Each call must be signed with an access key, secret key, and optional session token scoped to the IVS IAM permissions. Through Jentic, these credentials sit in the encrypted vault and signing happens at execution time so the agent never sees the raw secret.
Can I create a private live stream with the Amazon IVS API?
Yes. Import an ECDSA public key with POST /ImportPlaybackKeyPair, then sign short-lived JWTs server-side with the matching private key. Configure the channel for authorized playback so the player must present a valid JWT to start playback.
What are the rate limits for the Amazon IVS API?
Per-region quotas apply, including limits on channels per account, concurrent live viewers, and TPS for control plane operations such as CreateChannel and CreateStreamKey. Check the IVS service quotas in the AWS console for the current limits in your account.
How do I provision a new creator channel through Jentic?
Search Jentic for 'create live streaming channel', load the schema for POST /CreateChannel, submit the channel name and type, then call POST /CreateStreamKey for the same channel ARN. Jentic handles SigV4 signing on both calls.
Can I record live streams to S3 using the Amazon IVS API?
Yes. POST /CreateRecordingConfiguration creates a configuration pointing at an S3 bucket with optional thumbnail intervals, and channels created or updated with that configuration ARN automatically archive every broadcast session to S3.
Can I stop a live stream remotely with the Amazon IVS API?
Yes. POST /StopStream takes a channel ARN and ends the active broadcast session. This is useful for moderation flows where the platform needs to terminate a stream that violates terms of service without waiting for the broadcaster to disconnect.
Can I limit what my agent is allowed to do with the Amazon IVS API?
Yes. Because you run your own self-hosted Jentic One instance, your rules decide which IVS operations and AWS credentials the agent may use. You can grant only the calls it needs, such as CreateChannel, CreateStreamKey, or ListStreams, and leave out destructive operations like StopStream and DeleteChannel unless you explicitly add them. Since each RPC-style call carries the channel ARN in its request body, you control exactly which operations the agent can invoke.
GET STARTED