Skip to documentation
Browse documentation

Platform APIs

Use one authenticated execution contract to retrieve structured data from every supported platform. Select a platform from the final sidebar section to open its endpoint reference.

One execution contract

Every platform endpoint runs through POST /execute. Send the endpoint's public capability ID and an input object that matches the parameter documentation.

{
  "capability": "instagram.profile.get",
  "input": {
    "username": "instagram"
  }
}

What each endpoint page documents

Endpoint pages are generated from the public capability contract and include:

  • The exact capability ID, credit cost, and maximum runtime.
  • Every input parameter, its type, requirement, description, example, and allowed values.
  • Copyable cURL, Node.js, and Python requests in the right-side request panel.
  • An illustrative response fixture when the endpoint publishes one.

Responses and queued jobs

A 200 response completed inline. A 202 response contains a job ID; poll GET /jobs/:id until the job reaches completed or failed. Endpoint output is returned in results[0].data.

Before you start