Skip to main content
POST
Call a public data endpoint from its canonical marketplace version

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Optional. Scoped to the owner, API and endpoint. A retry with the same key and params is not charged again: a successful response up to 375 KB is stored and replayed with Idempotent-Replayed: true; a login response, a larger one or a failed call answers 409 with the recorded outcome (already_finalized), and a call still running answers request_in_progress. The same key with different params returns 409 idempotency_key_reused.

Required string length: 1 - 255
Peel-Shape
string

Optional. A JSON shape (see the batch body's shape) applied to this call's result. A bad shape answers 400 shape_invalid before the run and costs nothing.

Path Parameters

marketplace_id
string
required
endpoint_name
string
required
Minimum string length: 1

Body

application/json

Endpoint parameters. The body is the endpoint's input.

Response

Canonical marketplace endpoint execution envelope.

status
string | null
required
status_code
number | null
required
data
any
required
error
string | null
required
error_code
string | null
required
execution_time
number | null
required
action_outcome
enum<string>

What the call changed on the target. Present on every failed call and on every write. unknown means requests may have been sent.

Available options:
committed,
not_committed,
unknown,
cancelled
retry_safe
boolean

False when action_outcome is committed or unknown.

retry
enum<string>

Present on every failed call. never: do not repeat it, inspect the target first. fix_request: nothing ran, change the request first. same_key: repeat the same request with the same Idempotency-Key. new_key: nothing was committed, repeat it as a new request.

Available options:
never,
fix_request,
same_key,
new_key
credits_charged
number
credits_remaining
number | null
transport
enum<string> | null
Available options:
html_browser,
http_replay
initiates_session
boolean
session_id
string | null
encryption_key
string | null
session_renewed
boolean

True when the session sent was gone and Peel signed in again with the saved login; session_id and encryption_key then hold the new session, and the old pair no longer works.

shape
object

Present when the call carried a shape. applied: data is in the shape's form. skipped: data is the endpoint's own result and reason says why.