API docs by Redocly

API Documentation (1.0)

Download OpenAPI specification:Download

Miraflow provides a suite of APIs for managing your avatars, video and media as well as generating new videos.

These endpoints require authorization. Include your API key in the request by replacing API_KEY:

curl -H "x-api-key: API_KEY" https://miraflow.ai/api/avatars

List avatars

Lists the available avatars. These include stock avatars as well as avatars created by the account associated with the supplied API key.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
any

Response samples

Content type
application/json
{
  • "avatars": [
    • {
      }
    ]
}

List voices

Lists the available voices. These include stock voices as well as voices created by the account associated with the supplied API key.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
any

Response samples

Content type
application/json
{
  • "avatars": [
    • {
      }
    ]
}

List videos

Lists the videos that have completed generation.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
any

Response samples

Content type
application/json
{
  • "videos": [
    • {
      }
    ]
}

Fetch video metadata

Fetches metadata for a single completed video.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

The ID of the desired video

Responses

Response Schema: application/json
id
string
name
string
sourceAvatarId
string
createdAt
string <date>
downloadUrl
string <url>

Response samples

Content type
application/json
{}

Download video

Downloads a single completed video.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

The ID of the desired video

Responses

Response Schema: video/mp4
string <binary>

Check video generation status

Checks the status of a video generation job. The status will be one of:

  • "inference_started": Job has been queued
  • "inference_working": Job is in progress
  • "inference_complete": Video generation is complete
  • "inference_failed": Job failed
  • "inference_error": Unknown error occurred

Note: The ID parameter should be the jobId that was returned from the video creation endpoint.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

The Job ID returned from the video creation endpoint

Responses

Response Schema: application/json
One of
result
string
Value: "success"
status
string
Enum: "inference_started" "inference_working" "inference_complete" "inference_failed" "inference_error"
progress
string

Progress percentage when status is inference_working

Response samples

Content type
application/json
Example
{
  • "result": "success",
  • "status": "inference_working",
  • "progress": "45%"
}

Create a new video

Starts a new video creation job. The specified avatar will be used, and either a speech can be created using a specified voice and script, or an uploaded audio track can be used.

Authorizations:
ApiKeyAuth
Request Body schema:
required
One of
avatarId
string
name
string
voiceId
string
text
string

Responses

Response Schema: application/json
One of
result
string
Value: "success"
jobId
string

Request samples

Content type
Example
{
  • "avatarId": "cm2yaz9j10008l0qg9npyjgs3",
  • "name": "My new video",
  • "voiceId": "cm1lgilny0005m2lnvv3vgtgv",
  • "text": "This is the text of the script to be generated in the specified voice."
}

Response samples

Content type
application/json
Example
{
  • "result": "success",
  • "jobId": "cm42ab3ou0008aggajj0jy5e2"
}