Beamr Cloud API (1.1.0)

Download OpenAPI specification:Download

/heartbeat

Responses
200

heartbeat

get/heartbeat
Response samples
application/json
{
  • "timestamp": 0
}

/v1/jobs/{job_id}

SecurityApiKeyAuth
Request
path Parameters
job_id
required
string <uuid>

Job identifier

Responses
200

Get job details

get/v1/jobs/{job_id}
Response samples
application/json
{
  • "job": {
    }
}

/v1/jobs/{job_id}/download

SecurityApiKeyAuth
Request
path Parameters
job_id
required
string <uuid>

Job identifier

Responses
303

Redirect to processed resource

get/v1/jobs/{job_id}/download
Response samples
application/json
{
  • "location": "string"
}

/v1/jobs

SecurityApiKeyAuth
Request
Request Body schema: application/json
source
required
string <url>

Source file url

output
string <url>

Optional output file url (s3://...), requires prior s3 setup

codec
string
Default: "preserve"

Output codec

Enum: "h264" "h265" "avc" "hevc" "preserve"
height
integer

Optional output height (must be an even number). Supports only downscaling. Only supported with Beamr encoders.

width
integer

Optional output width (must be an even number).Supports only downscaling. Only supported with Beamr encoders.

encoder
string
Default: "nvenc"

Encoder engine

Enum: "beamr" "nvnenc"
Responses
201

Job details

post/v1/jobs
Request samples
application/json
{
  • "source": "string",
  • "output": "string",
  • "codec": "h264",
  • "height": 0,
  • "width": 0,
  • "encoder": "beamr"
}
Response samples
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "location": "string",
  • "source": "string",
  • "timestamp": 0,
  • "timestampHuman": "2019-08-24T14:15:22Z"
}

/v1/jobs

SecurityApiKeyAuth
Responses
200

Job details

get/v1/jobs
Response samples
application/json
{
  • "jobs": [
    ]
}

/v1/iam/role

SecurityApiKeyAuth
Request
Request Body schema: application/json
roleArn
required
string

Role ARN to assume

Responses
200

Add user role to assume

post/v1/iam/role
Request samples
application/json
{
  • "roleArn": "string"
}
Response samples
application/json
{
  • "uid": "string",
  • "roleArn": "string"
}

/v1/iam/role

SecurityApiKeyAuth
Responses
200

Delete user role to assume

delete/v1/iam/role
Response samples
application/json
{
  • "uid": "string"
}

/v1/iam/role

SecurityApiKeyAuth
Responses
200

Get user role to assume

get/v1/iam/role
Response samples
application/json
{
  • "uid": "string",
  • "roleArn": "string"
}