roasOSGet research results
Returns the finished, normalized ad records with their source and provenance. Raw provider data and billing details are never included.
Returns the finished, normalized ad records with their source and provenance. Raw provider data and billing details are never included.
Authorization
bearerAuth API key authentication. Use your API key as the bearer token: Authorization: Bearer roasos_sk_...
In: header
Path Parameters
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/research/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/result"{ "data": { "schema_version": "research-result@1", "kind": "research_result", "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f", "capability_id": "research.facebook-company-ads@1", "status": "succeeded", "cache_disposition": "cache_hit", "reserved_credits": 0, "maximum_credits": 0, "settled_credits": 0, "provenance": { "source": "facebook", "native_id": "string", "fetched_at": "2019-08-24T14:15:22Z", "fresh_through": "2019-08-24T14:15:22Z" }, "result": { "kind": "facebook_company_ads", "items": [ { "id": "string", "source": "facebook_ad", "advertiser": { "id": "string", "name": "string", "avatar_url": "http://example.com" }, "media": { "type": "image", "slides": [ { "type": "image", "thumbnail_url": "http://example.com", "video_url": "http://example.com" } ] }, "copy": "string", "title": "string", "description": "string", "domain": "string", "cta": "string", "destination_url": "http://example.com", "run_start_date": "string", "run_end_date": "string", "is_active": true, "platform_link": "http://example.com" } ], "item_count": 0 } }}Get Research job status
Previous Page
Analyze an ad
Break one ad down into its structure. A video returns numbered shots with timings, camera, action, per-shot dialogue, on-screen text and product moments, plus a transcript, a character sheet, the global style and the insights. A still returns the layout, the copy by role, the product placement, the person, the style and a recreate prompt with {PRODUCT} and {PERSON} placeholders. Send exactly one source: `video_url`, `image_url` or `discover_item_id`. Set `quote_only: true` to see the price for free, then send the same body with the returned `quote_id` to run it. A still costs 1 credit and a video costs 2. An analysis this workspace can already reuse is a cache hit and costs nothing. The run is asynchronous: read it at `/v1/workflows/analyses/{id}`.