Skip to navigation

REST API guide

Practical workflow guidance for building with the platform.
View as Markdown

Use the REST API to prepare data, train and deploy models, and request predictions and explanations from your applications.

Start with the quickstart

Follow the Quickstart to run a complete workflow with sample data, from ingestion to your first prediction and explanation.

Before you begin, sign in to the platform UI. You will create your API credentials there as part of the quickstart.

For detailed workflows, use the sections below. For endpoint definitions, request fields and response schemas, use the API reference.

Guide areas

AreaCoversStart with
SetupAccount storage, authentication, credentials, and shared compute configuration.Account storage
DataData preparation, source-storage access, schemas, ingestion, onboarding, datasources, and datasets.Prepare data
ModelsTraining configuration, constraints, workspaces, training jobs, and trained models.Training
DeploymentDeployment configuration and deployed model management.Configuration
ViewsPrediction, explanation, evaluation, inspection, and analysis views.Overview
AdministrationAccount access, users, roles, profile, and settings.Overview

For screen-based workflows, see the Web app guide.