Skip to main content
GET
/
v3
/
vendor
/
{org_token}
/
1
/
rt_ad
/
{screen_id}
Get Spot
curl --request GET \
  --url https://api.framen.com/v3/vendor/{org_token}/1/rt_ad/{screen_id}

Documentation Index

Fetch the complete documentation index at: https://docs.framen.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Spot

Request a single creative for a single playout on a specific screen. Returns content (news or ad) along with a proof-of-play URL. This is part of the Vendor Default API for real-time ad serving, separate from the SMAPI CRUD endpoints.
Need a test campaign? To set up a test campaign for your screens, contact support@framen.com with one or multiple screen_id you want to test with.
​
org_token
string
required
Your organization token (e.g., Org_4KmTqZnWpLx).
​
screen_id
string
required
The unique identifier of the screen requesting content.

​
Response

The response data object contains:
FieldTypeDescription
requestIdstringUnique ID for this request
billablebooleanWhether this playout is billable
newsFirstbooleanWhether news should play before the ad
The data object also contains two nested content objects: news and ad. Both share the same schema:
FieldTypeDescription
idstringContent item ID
titlestringContent title
mimeTypestringe.g., text/html, video/mp4
heightintegerPixel height
widthintegerPixel width
durationintegerDuration in milliseconds
urlstringURL to fetch/render the content
popstringProof-of-play callback URL (GET)
The news object additionally contains:
FieldTypeDescription
newsTypestringNews category (e.g., WELT_WISSEN)

​
Request Cycle Flow

  1. Player sends ad-request -> receives ad-response (containing news + ad + pop URLs).
  2. Player pre-caches content.
  3. Player plays the content.
  4. Player fires the proof-of-play GET request. Must happen within 1 hour of the original request.
  5. Repeat for next spot.

​
Example Request

curl -X GET https://api.framen.com/v3/vendor/Org_4KmTqZnWpLx/1/rt_ad/Scr_xYz789
Last modified on April 22, 2026