Wire

Run a Wire Action

Run a Wire action by its action_id — either a READ action that extracts data (search listings, fetch a product's price/specs/reviews, read a profile) or a WRITE action that performs a state-changing interaction (submit a form, add to cart). The action's type, reported by Discover Wire Actions and Get a Wire Catalog, determines which kind it is. params must match that action's parameter schema; omit for actions that take none. Some actions complete synchronously and return their data inline in this same response; others return {status, job_id} — poll GET /wire/jobs/{jobId} for those. Does not execute payments or transfer funds; such actions are refused.

post/wire/task

Request

  • Base URL: https://api.anakin.io/v1
  • URL: https://api.anakin.io/v1/wire/task
  • Auth: API key in header X-API-Key

Request body

action_idstring required

The action to run (from Discover Wire Actions or Get a Wire Catalog).

paramsobject

The action's input parameters. Shape depends on the action — use its parameter schema from discovery. Omit for actions that take none.

credential_idstring

Required when the action's auth_mode is "required"; honored when "optional"; ignored when "none". Get one from List Wire Identities or Sign In to a Wire Site.

identity_idstring

Optional identity selector — the server resolves a credential from it (alternative to credential_id).

Response

The action's data inline (synchronous actions), or a job handle to poll (asynchronous actions)

statusstring

Present on both sync and async responses.

job_idstring

Present when the action runs asynchronously — poll GET /wire/jobs/{jobId}. Absent when the action completed synchronously, in which case its result data is returned inline in this same object.

poll_urlstring

Present alongside job_id — convenience polling URL.

Changes

No recorded changes to this operation across all 1 revision of this API.