Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wideo Batch API

Batch video rendering from a template and a set of variable objects

Wideo Batch API is one of 2 APIs that Wideo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Batch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://automationapi.wideo.co.

2 operations 2 paths 5 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://automationapi.wideo.co
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Wideo Batch API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key in UUID form, scoped to a specific account and permission set. Generated assets are isolated by account.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Batch 2

Batch video rendering from a template and a set of variable objects

POST
/batch
Create a rendering batch
createBatch body → 200401
GET
/batch/{batchId}
Check batch status
getBatch 1 param → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CreateBatchRequest (3 properties), BatchStatus (3 properties), RenderedVideo (2 properties), CreateBatchResponse (1 property). Each schema is shown below with its type and property counts.

VideoVariables
object
Free-form map of template variable names to values. Keys correspond to the variable content areas defined in the template.
RenderedVideo
object
2 properties
BatchStatus
object
3 properties
CreateBatchResponse
object
1 property
CreateBatchRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wideo-batch-api-openapi.yml Raw ↑

Other APIs Wideo publishes across the network.

Wideo Automation API