Get user highlights

POST/v1/api/instagram/v3/user-highlights

Get Instagram user's Highlights list Returns all highlight collections created by the user Support pagination

Request body

Call this sync operation at its vendor-qualified URL. The model identity is encoded in the path; only operation-specific input fields belong in the request body.

Optional<string>after

Forward pagination cursor, from previous response `data.page_info.end_cursor`

Optional<string>before

Backward pagination cursor, from previous response `data.page_info.start_cursor`

Optional<integer>first

Number of highlights per page (default 10, max 50)

Range: 1 to 50

Default: 10

Optional<integer>last

Highlights per page for backward pagination, use with `before`

stringusernamerequired

Instagram username (required)

Response Schema

A synchronous completed response contains exactly one outputs item with only data. Failed and timeout responses contain error and never outputs.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

stringmodelrequired

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Contains exactly one item whose only field is data.

Optional<object | array>outputs[0].data

Operation-specific business payload. This reference uses an empty object when no safe example can be confirmed.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

API capabilities

array<string>capability_tagsrequired

Capabilities declared by the API registry.

Default: api, instagram

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"instagram/v3/user-highlights"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"instagram/v3/user-highlights"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"instagram/v3/user-highlights","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"instagram/v3/user-highlights","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"instagram/v3/user-highlights","error":{"type":"upstream_error","message":"upstream request failed"}}

curl -X POST https://api.sandbase.ai/v1/api/instagram/v3/user-highlights \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{\n
  "username": "instagram"
}'

Response200 OK

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "status": "completed",
  "model": "instagram/v3/user-highlights",
  "outputs": [
    {
      "data": {}
    }
  ]
}