Request
Make a HTTP POST request to the following url. You can use omnirender_demo as apikey, this is a live demo queue responsible for processing HTML5 banners using a regular capture driver. Please refer to creative requirements to properly setup your creative container (it’s probably already working that way).
CURL request:
|
1 2 3 4 5 6 7 |
curl --location --request POST 'api.omnirender.com/job/batch/addautohtml?apikey=demo' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'width=1080' \ --data-urlencode 'height=1080' \ --data-urlencode 'delay=10' \ --data-urlencode 'fps=60' \ --data-urlencode 'url=https://airshifumi.hands.agency/' |
Returns
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
{ "result": { "data": { "__v": 0, "user_token": "not_provided", "user_email": "not@provided.com", "user_name": "demo", "cdn_access_token": null, "cdn_grant_type": null, "cdn_storage_uri": null, "cdn_client_id": null, "video_length": -1, "group": "public", "domain": "omnirender", "details": { "requireWatermark": false, "videoDelay": 5000, "capDelay": 5000, "type": "bannerflow", "auto": 1, "scraper": "default", "project": "yourAssignedProjectID", "timer_enabled": false, "fps": 30, "height": 1920, "width": 1080, "author": "N/A" }, "is_hq": true, "is_inactive": false, "user_notification_targets": { "scrape_status": [ { "hash": "yourprojectdomain-1", "key": "callbackApiToken", "method": "POST", "uri": "https://yourcallbackapi.com/callbackurl", "type": "api" } ] }, "scheme": "scraper", "error_history": [], "status_history": [], "in_operation": false, "add_date": "2021-08-31T20:09:00.115Z", "id": "612e8c5cd11bff30d5a384f7" } }, "success": true } |
Basic parameters
url: the URL of the creative, must be available over HTTP/HTTPS without any two-step authentication
width: width of the target video
height: height of the target video
delay: duration of the creative in seconds
Extended parameters for premium users:
fps: frames per sec for the video, allowed values 30 or 60
scraper: custom driver for syncing start/stop signals with the creative
XMP tag: add custom XMP tags that should be added to the final video
timer_enabled: for debug purposes, add a timer overlay to the final video
Notification parameters
Examples
To add custom notification targets
Please refer to this documentation page:
Configure notification targets