roasOSGet an ad analysis
Read one analysis run and its credit state. The analysis document itself is at /result.
Read one analysis run and its credit state. The analysis document itself is at /result.
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/workflows/analyses/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "schema_version": "workflow-analysis@1", "kind": "workflow_analysis", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "workflow": "analyze", "analysis_kind": "image", "cache_disposition": "cache_hit", "maximum_credits": 0, "pricing_version": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "status": "quoted", "reserved_credits": 0, "quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992", "expires_at": "2019-08-24T14:15:22Z", "authorization": { "status": "auto_approved" } }}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}`.
Get ad analysis status
The light poll: the same envelope, read while the analysis runs.