Beamr Cloud API (1.0.0)

Download OpenAPI specification:Download

/heartbeat

Responses

200

heartbeat

get/heartbeat

Response samples

application/json

{"timestamp": 0
}

/v1/jobs

SecurityApiKeyAuth

Request

Request Body schema: application/json

source required	string <url> Source file url
codec	string Default: "preserve" Output codec Enum: "h264" "h265" "avc" "hevc" "preserve"
height	integer Output height (must be an even number)
width	integer Output width (must be an even number)

Responses

201

Job details

post/v1/jobs

Request samples

Payload

application/json

{"source": "string",
"codec": "h264",
"height": 0,
"width": 0
}

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": [{"created": 0,
"createdHuman": "2019-08-24T14:15:22Z",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"location": "string",
"input": {"path": "string",
"filesize": 0
},
"output": {"filesize": 0,
"savings": 0
},
"owner": "string",
"status": "SUBMITTED",
"lastUpdate": 0,
"lastUpdateHuman": "2019-08-24T14:15:22Z",
"ttl": 0,
"ttlHuman": "2019-08-24T14:15:22Z",
"userParameters": {"source": "string",
"codec": "h264",
"height": 0,
"width": 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": {"created": 0,
"createdHuman": "2019-08-24T14:15:22Z",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"location": "string",
"input": {"path": "string",
"filesize": 0
},
"output": {"filesize": 0,
"savings": 0
},
"owner": "string",
"status": "SUBMITTED",
"lastUpdate": 0,
"lastUpdateHuman": "2019-08-24T14:15:22Z",
"ttl": 0,
"ttlHuman": "2019-08-24T14:15:22Z",
"userParameters": {"source": "string",
"codec": "h264",
"height": 0,
"width": 0
}
}
}

/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"
}