API

Overview

The AIOZ AI API is the programmatic interface to the AIOZ AI Platform. It lets you run model inference, fetch model metadata and pricing, and check your account balance from your own applications, using the same compute network that powers the in-browser Playground.

What's available today

The API currently exposes the Inference surface across four resource groups:

  • Tasks: Create an inference task, fetch its status and result, list past tasks, cancel a queued task.
  • Models: Discover available models, fetch details, quote the cost of running a task, check whether a model is currently serving.
  • Account: Check your API key's balance and earnings.
  • Storage: Upload files via presigned URLs, list a folder's files, delete files.

Core concepts

  • Task. An inference run on a specific model. Tasks are asynchronous; see Working with Tasks for the full lifecycle.
  • Model. A runnable AI model on the platform. Each model has its own input/output schema, a price per inference, and a current serving status. See Working with Models.
  • Balance. Your account's available credits, free credits, debt, and accumulated earnings. Each successful inference draws from your balance; see How Billing Works.
  • Storage. An S3-compatible file store organized into named folders. Upload files and reference the resulting download_url as model input. See Working with Storage.

Inference API and Playground

The Playground is the no-code way to run a model from the browser. The API does the same thing programmatically: every Playground run is an inference task on the same compute network, so a model you've tried in the Playground is ready to ship in your own app through the API.

Where to next