Read an upstream's macro documentation into preset fields

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/upstream-macro-presets/from-document.do

Reads an upstream's macro documentation (an SSAI stitcher's macro list, a publisher's notes, or a VAST tag URL with the upstream's macros in it; a PDF, an image of it, a link to its page, or its text) with one AI model call and answers which of the upstream's macros fills each of our tag parameters, one entry for each upstream the document tells apart - 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 entry you pick with upstream-macro-presets (code is made from the name). 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. Only our own tag parameters are filled and each macro passed what a saved preset accepts; a key the model answered that is not one of them is not filled and is listed in notApplied with the reason, and quotes gives the passage each macro came from. Check them against the document before saving. The call is billed like an AI assistant call. Requires the UPSTREAM_MACRO_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 documentation: its page or its PDF

https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html

text string

The documentation's text, pasted (a macro list, or a VAST tag URL with the macros in it); up to 150,000 characters are read

https://ads.example/vast?ip={{IP}}&ua={{USER_AGENT}}&ifa={{DEVICE_ID}}&us_privacy={{US_PRIVACY}}

Body

A multipart form: file (file).

Responses

200

{upstreams: [{name, code, source, asOf, notes, playerParamPrefix, macros, 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 macros for our tag parameters, 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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D' \
  --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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D", 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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D', {
  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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D"))
    .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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D");
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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D", 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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D");
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/upstream-macro-presets/from-document.do?url=https%3A%2F%2Fdocs.aws.amazon.com%2Fmediatailor%2Flatest%2Fug%2Fvariables.html&text=https%3A%2F%2Fads.example%2Fvast%3Fip%3D%7B%7BIP%7D%7D%26ua%3D%7B%7BUSER_AGENT%7D%7D%26ifa%3D%7B%7BDEVICE_ID%7D%7D%26us_privacy%3D%7B%7BUS_PRIVACY%7D%7D")
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