Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
username
string

Username

verified
boolean

Verified account

location
string

Location

avatar
string

Profile photo

photo
string

Post photo

caption
string

Caption

ratio
enum<string>

Photo ratio

Available options:
square,
portrait,
landscape
theme
enum<string>

Appearance

Available options:
light,
dark
likes
number

Likes

Required range: x >= 0
comments
number

Comments

Required range: x >= 0
timeAgo
string

Timestamp

liked
boolean

Already liked (red heart)

saved
boolean

Already saved (filled bookmark)

storyRing
boolean

Story ring around the profile photo

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.