API reference · Instagram

instagram/bulk/posts

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

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDinstagram/bulk/posts
01

Input Schema

5 parameters · 1 required · 4 optional

ParameterTypeRequiredDescription
usernamearrayRequiredInsert the username or URL of any profile you want to get posts from. You can also paste the post URLs.
resultsLimitintegerOptionalThis is the maximum number of posts you want to scrape per profile. If you set it to 5, you'll get 5 posts for each profile you've included. This setting does not apply if you're scraping by post URLs. · Min: 1 · Max: 9007199254740991
dataDetailLevelstringOptionalChoose the data package you want to extract. Please note the Detailed data are paid extra. · Options: basicData, detailedData · Default: "detailedData"
basicDatadetailedData
skipPinnedPostsbooleanOptionalCheck if you do not want to save pinned posts. · Default: false
onlyPostsNewerThanstringOptionalLimit how far back to the history the scraper should go. 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. All time values are taken in UTC timezone
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

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

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

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": "instagram/bulk/posts",
  "dataDetailLevel": "detailedData",
  "skipPinnedPosts": false,
  "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"