Read a publisher's video spec document into preset fields

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do

Reads a publisher's video ad spec (a PDF, an image of it, a link to its page, or its text) with one AI model call and answers the preset fields it states, one profile for each set of requirements the document tells apart (site-served and VAST, mezzanine and programmatic) - at most 10, with 'total' the number the document has and 'more' true when some were left out. Nothing is saved: create the preset from the profile you pick with video-requirements/presets. Send exactly one of file, url or text. A link is downloaded from the public internet only; a page that builds its content in the browser has no text to read, so send its PDF or its text instead. Each profile's requirements passed the constraints a saved preset is held to; a value the model answered that failed them is not filled and is listed in notApplied with the reason, and quotes gives the passage each filled field came from. Check them against the document before saving. The call is billed like an AI assistant call. Requires the VIDEO_REQUIREMENT_PRESETS admin permission and an Anthropic key: the user's own, the network's, or Epom's while the network's plan includes it.

Query Params

url string

A public http(s) link to the spec: its page or its PDF

https://help.ads.roku.com/en/articles/7154647-creative-guidelines

text string

The spec's text, pasted; up to 150,000 characters are read

Duration: 15 or 30 seconds. Resolution: 1920x1080. Bitrate: 15-30 Mbps CBR.

Body

A multipart form: file (file).

Responses

200

{profiles: [{name, profile, source, asOf, notes, requirements, quotes, notApplied}], total, more, document: {kind, origin}}

400

Field errors under 'errors': none or several of file, url and text; the document empty, too large, of a type that cannot be read, without readable text, not downloadable, without a video ad spec, too long to read in one answer, or declined by the model (errors.document)

401

Authentication error

403

Insufficient permissions, naming the missing one

429

This month's AI budget is spent

503

No Anthropic key is set up, or the model could not be reached or answered something that cannot be read; try again

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --form 'file=@data.csv'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.", headers={"X-Api-Key": "YOUR_API_KEY"}, files={"file": open("data.csv", "rb")})
print(response.json())

Node Request

import fs from 'node:fs/promises';

const form = new FormData();
form.append('file', new Blob([await fs.readFile('data.csv')]), 'data.csv');

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  body: form,
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR."))
    .header("X-Api-Key", "YOUR_API_KEY")
    // multipart upload: build the body with your HTTP library of choice
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
var form = new MultipartFormDataContent();
form.Add(new ByteArrayContent(File.ReadAllBytes("data.csv")), "file", "data.csv");
request.Content = form;

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	// multipart upload: build the body with mime/multipart

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, ["file" => new CURLFile("data.csv")]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/preset-from-document.do?url=https%3A%2F%2Fhelp.ads.roku.com%2Fen%2Farticles%2F7154647-creative-guidelines&text=Duration%3A%2015%20or%2030%20seconds.%20Resolution%3A%201920x1080.%20Bitrate%3A%2015-30%20Mbps%20CBR.")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request.set_form([['file', File.open('data.csv')]], 'multipart/form-data')

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body