api.video PHP API client

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Project description

api.video's PHP API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started


composer require api-video/php-api-client


Due to PHP PSR support, you must initialize the client with 3 to 5 arguments:

  1. Base URI, which can be either https://sandbox.api.video or https://ws.api.video
  2. Your API key, available on your account
  3. HTTP client
  4. (Request factory)
  5. (Stream factory)

Note : If the HTTP client also implements RequestFactoryInterface and StreamFactoryInterface, then it is not necessary to pass this object in 4th and 5th argument.

Symfony HTTP client example

The Symfony HTTP client has the triple advantage of playing the role of HTTP client, but also of request factory and stream factory. It is therefore sufficient to pass it as an argument 3 times.

If the HTTP client isn't yet in your project, you can add it with:

composer require symfony/http-client
composer require nyholm/psr7

Code sample

Client initialization

require __DIR__ . '/vendor/autoload.php';

$httpClient = new \Symfony\Component\HttpClient\Psr18Client();
$client = new \ApiVideo\Client\Client(

Create a video

$payload = (new VideoCreationPayload())
    ->setTitle('Test video creation');

// the `$client` must already be initialized.
$video = $client->videos()->create($payload);

Upload a video

$payload = (new VideoCreationPayload())
    ->setTitle('Test video creation');

$video = $client->videos()->create($payload);

// the `$client` must already be initialized.
    new SplFileObject(__DIR__.'/../earth.mp4')


API Endpoints


Method Description HTTP request
getLiveStreamsPlays() Get play events for live stream GET /analytics/live-streams/plays
getVideosPlays() Get play events for video GET /analytics/videos/plays


Method Description HTTP request
upload() Upload a caption POST /videos/{videoId}/captions/{language}
get() Retrieve a caption GET /videos/{videoId}/captions/{language}
update() Update a caption PATCH /videos/{videoId}/captions/{language}
delete() Delete a caption DELETE /videos/{videoId}/captions/{language}
list() List video captions GET /videos/{videoId}/captions


Method Description HTTP request
upload() Upload a chapter POST /videos/{videoId}/chapters/{language}
get() Retrieve a chapter GET /videos/{videoId}/chapters/{language}
delete() Delete a chapter DELETE /videos/{videoId}/chapters/{language}
list() List video chapters GET /videos/{videoId}/chapters


Method Description HTTP request
create() Create live stream POST /live-streams
get() Retrieve live stream GET /live-streams/{liveStreamId}
update() Update a live stream PATCH /live-streams/{liveStreamId}
delete() Delete a live stream DELETE /live-streams/{liveStreamId}
list() List all live streams GET /live-streams
uploadThumbnail() Upload a thumbnail POST /live-streams/{liveStreamId}/thumbnail
deleteThumbnail() Delete a thumbnail DELETE /live-streams/{liveStreamId}/thumbnail


Method Description HTTP request
create() Create a player POST /players
get() Retrieve a player GET /players/{playerId}
update() Update a player PATCH /players/{playerId}
delete() Delete a player DELETE /players/{playerId}
list() List all player themes GET /players
uploadLogo() Upload a logo POST /players/{playerId}/logo
deleteLogo() Delete logo DELETE /players/{playerId}/logo


Method Description HTTP request
createToken() Generate an upload token POST /upload-tokens
getToken() Retrieve upload token GET /upload-tokens/{uploadToken}
deleteToken() Delete an upload token DELETE /upload-tokens/{uploadToken}
list() List all active upload tokens GET /upload-tokens


Method Description HTTP request
create() Create a video object POST /videos
upload() Upload a video POST /videos/{videoId}/source
uploadWithUploadToken() Upload with an delegated upload token POST /upload
get() Retrieve a video object GET /videos/{videoId}
update() Update a video object PATCH /videos/{videoId}
delete() Delete a video object DELETE /videos/{videoId}
list() List all video objects GET /videos
uploadThumbnail() Upload a thumbnail POST /videos/{videoId}/thumbnail
pickThumbnail() Set a thumbnail PATCH /videos/{videoId}/thumbnail
getStatus() Retrieve video status and details GET /videos/{videoId}/status


Method Description HTTP request
upload() Upload a watermark POST /watermarks
delete() Delete a watermark DELETE /watermarks/{watermarkId}
list() List all watermarks GET /watermarks


Method Description HTTP request
create() Create Webhook POST /webhooks
get() Retrieve Webhook details GET /webhooks/{webhookId}
delete() Delete a Webhook DELETE /webhooks/{webhookId}
list() List all webhooks GET /webhooks



Some endpoints don't require authentication. These one can be called with a Client instantiated with a null API key:

require __DIR__ . '/vendor/autoload.php';

$httpClient = new \Symfony\Component\HttpClient\Psr18Client();
$client = new \ApiVideo\Client\Client(


The video is automatically split into 50 Mb chunks.

To modify the size of the chunks, fill in the last argument $contentRange as follows:

  • bytes 0-{size}/0 where {size} is the size of the chunk.

For example : bytes 0-500000/0 for 500 Kb chunks.

The chunks size value must be between 5 Mb and 128mb.


In order to run the PhpUnit tests, it is necessary to enter two variables in the command line:

  • BASE_URI (for example : https://sandbox.api.video)

These identifiers must belong to a real api.video account.

$ BASE_URI="" API_KEY="..." vendor/bin/phpunit

Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!


Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our client generator. Otherwise, you can also simply open an issue detailing your need on this repository.

Was this page helpful?