Authorization
ApiKeyAuth Use Bearer br_live_....
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/onboarding/brand-scan" \ -H "Content-Type: application/json" \ -d '{ "website_url": "string", "business_outcome": "book_calls" }'{ "run_id": "string", "brand_profile_id": "string", "source_url": "string", "status": "string", "error": "string", "pages_scanned": 0, "created_at": "string", "completed_at": "string", "profile": { "id": "string", "business_outcome": "book_calls", "website_url": "string", "brand_name": "string", "tagline": "string", "audience": "string", "offer": "string", "conversion_goal": "string", "tone": "string", "messaging": { "property1": null, "property2": null }, "color_palette": [ "string" ], "logo_candidates": [ { "url": "string", "label": "ogImage" } ], "suggested_safe_words": [ "string" ], "social_profiles": [ { "platform": "linkedin", "value": "string" } ], "status": "string", "last_scanned_at": "string", "updated_at": "string" }, "next_actions": [ { "method": "GET", "path": "string", "reason": "string" } ]}Set project caption theme POST
Previous Page
Export project POST
Export a video or carousel project. For video projects, returns MP4/MOV video files or thin FCPXML timeline metadata with container_format='mp4'/'mov'/'fcpxml'. FCPXML exports do not bundle media and may reference signed cloud URLs that expire, so relinking may be required. For carousel projects, returns ZIP archive with individual slides as JPG/PNG images. Response includes container_format and image_formats fields. Cost note: This operation may consume AI credits and can take time to complete.