ad-campaigns
ad-campaigns

Get Full Company Profile Data

Get full company profile data with Saphire AI images.

This endpoint runs a full pipeline:

  1. Crawls the website with Saphire to extract brand assets (or uses cached)
  2. Runs company profile generation (includes company research in step1)
  3. Generates creative images for each ad using Saphire AI

If either task already has completed data, it will be returned. If either task fails, the other's results are still returned (partial success). Image/forecast generation failures don't fail the overall operation - campaigns are still returned.

Note: This endpoint may take several minutes to respond if generation is triggered.

Query Parameters:

  • force_regenerate: If True, generates new data even if existing data exists

Requirements:

  • User must have a company_website set in their profile

Response:

  • success: True if generation succeeded
  • was_existing: True if returning existing data
  • company_profile: Full profile data with company research, creative images and forecasts
  • company_profile_error: Error message (if failed)
  • saphire_error: Saphire crawl/image generation error (if any)
  • image_stats: Statistics about image generation
  • forecast_stats: Statistics about forecast generation
  • forecast_error: Forecast generation error (if any)
get/api/v1/ad-campaigns/full

Request

  • Base URL: https://api.trylapis.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.trylapis.com/api/v1/ad-campaigns/full
  • Auth: HTTP bearer

Query parameters

force_regenerateboolean

Force generation of new profile even if existing one exists

client_user_idinteger nullable

Client user ID to view data for

Headers

x-lapis-dev-tokenstring nullable
x-assume-user-idinteger nullable

Response

Successful Response

successboolean required
was_existingboolean
company_profile_errorstring nullable
saphire_errorstring nullable
forecast_errorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.