API reference · Facebook

facebook/bulk/groups

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/groups

Input Schema

6 parameters · 1 required · 5 optional

Parameter	Type	Required	Description
`startUrls`	array	Required	Insert a URL of a valid Facebook group. Only public Facebook groups can be scraped.
`viewOption`	string	Optional	Select sorting order by which the posts should be scraped. Please note that the Number of results field will be applied to New posts only. The BuySell items sorting will return results for BuySell groups only. · Options: CHRONOLOGICAL, RECENT_ACTIVITY, TOP_POSTS, CHRONOLOGICAL_LISTINGS · Default: "CHRONOLOGICAL" CHRONOLOGICALRECENT_ACTIVITYTOP_POSTSCHRONOLOGICAL_LISTINGS
`resultsLimit`	integer	Optional	Select the number of posts you want to scrape. If this limit is not set, as many results as possible will be returned. · Min: 1 · Max: 9007199254740991
`searchGroupYear`	string	Optional	The scraper will extract Facebook posts by this year. To use this field, you need to fill in the Search by letter field above ↑.
`onlyPostsNewerThan`	string	Optional	Scrapes post from the provided date to the present day. The date should be in YYYY-MM-DD or full ISO absolute format or in relative format e.g. 1 days, 2 months, 3 years. The JSON input also supports adding time units (UTC timezone): Full or partial ISO timestamp (e.g., `2025-09-23T10:02:01`) as absolute time and relative time, e.g., `1 hour` or `2 minutes`.
`searchGroupKeyword`	string	Optional	Without logging in, search results are VERY limited, so searching by word will return nothing in most cases. To get more messages, it is recommended to use a one or two letter search and change the year.

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/groups",
  "viewOption": "CHRONOLOGICAL",
  "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 Groups