Skip to content

Guides

These guides walk you through the most common IPTO workflows from start to finish. Each guide includes tabbed code examples in cURL, Python, and TypeScript so you can follow along in whichever language your team uses.

Available guides

  • Uploading Data

    Create a dataset, upload objects through presigned URLs, confirm the upload, and track processing status. Covers the full provider ingest pipeline including the admin review window.

  • Searching Data

    Run search queries against the marketplace, use boolean operators and filters, choose retrieval modes, paginate results, and download full objects. Covers the planned search API syntax and concepts.

  • Managing API Keys

    Create scoped API keys, choose dataset access modes, grant and revoke dataset access, and follow security best practices for production deployments.

  • Provider Analytics

    View your provider dashboard, inspect per-dataset analytics, understand payout statements, and monitor revenue across your listed datasets.

Prerequisites

Before starting any guide, make sure you have:

  1. An IPTO account (sign up if you have not already).
  2. A session token or API key with the required scopes for the workflow.
  3. curl, Python 3.8+, or Node.js 18+ installed locally.

Conventions used in these guides

  • All examples use https://api.ipto.ai as the base URL.
  • Shell variables like $TOKEN and $DATASET_ID refer to values obtained in earlier steps.
  • Python examples use the requests library. Install it with pip install requests.
  • TypeScript examples use the built-in fetch API available in Node.js 18+.