API reference · Facebook

facebook/bulk/ads-library

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APIAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDfacebook/bulk/ads-library

Input Schema

9 parameters · 1 required · 8 optional

Parameter	Type	Required	Description
`urls`	array	Required	List of facebook ads search URLs or Page URLs to scrape ads from
`count`	integer	Optional	Leave this field empty if you want to limit number of ads scraped · Min: -9007199254740991 · Max: 9007199254740991
`runTag`	string	Optional	Add this value to 'runTag' column in the output
`limitPerSource`	integer	Optional	Limit number of ads scraped per input URL. Leave it blank to scrape all available ads ℹ️ Actual number might exceed the given limit by upto 30 · Min: -9007199254740991 · Max: 9007199254740991
`scrapeAdDetails`	boolean	Optional	Enable this option to scrape ads details such as EU Reach info
`scrapePageAds.period`	string	Optional	Search ads in given date range · Options: , last24h, last7d, last14d, last30d · Default: "" last24hlast7dlast14dlast30d
`scrapePageAds.sortBy`	string	Optional	Sort by impressions or date. Default: Impressions · Options: impressions_desc, most_recent · Default: "impressions_desc" impressions_descmost_recent
`scrapePageAds.countryCode`	string	Optional	2-letter ISO country code (ISO 3166-1 alpha-2). This should be the official uppercase country code, such as `IN` for India, `US` for United States, etc. Use `ALL` for targeting all countries · Default: "ALL"
`scrapePageAds.activeStatus`	string	Optional	Options: all, active, inactive · Default: "all" allactiveinactive

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "facebook/bulk/ads-library",
  "scrapePageAds.period": "",
  "scrapePageAds.sortBy": "impressions_desc",
  "scrapePageAds.countryCode": "ALL",
  "scrapePageAds.activeStatus": "all",
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Facebook Ad Library