Getting Started

Introduction

Runtype is an AI product development platform. Use the Runtype API to manage Flows, Agents, Tools, Records, Products, API keys, Model Configs, and Secrets.

What is Runtype?

Use Runtype to:

  • Build Flows: Create multi-step AI workflows with prompts, context steps, and conditions.
  • Manage Records: Store and organize data that Flows process.
  • Run Flows: Process individual Records or batches with Flows.
  • Use supported models: Run Flows with models from supported providers, including OpenAI, Anthropic, Google, and xAI.
  • Use Tools: Create custom Tools or use built-in Tools.

For a product overview, see What is Runtype? in the User Guide.

Use these links to start with authentication, your first request, the API reference, or an SDK.

Authentication

Create an API key and authenticate requests

Quickstart

Send your first API request

API Reference

Find endpoints and request details

TypeScript SDK

Use the official TypeScript SDK

Base URLs

Use the following base URLs for each environment:

EnvironmentBase URL
Productionhttps://api.runtype.com/v1
Staginghttps://api.runtype-staging.com/v1
Localhttp://localhost:8787/v1

The runtype CLI and official SDKs connect to the production and staging hosts over HTTPS. If you run them in CI, a sandbox, or another restricted-egress environment, allowlist api.runtype.com for production or api.runtype-staging.com for staging. A proxy or firewall that intercepts the connection can report an authentication failure instead of a network error. Check reachability before treating the API key as invalid.

Response format

All API responses use camelCase field names. The following response shows the format:

Response
1{
2  "id": "flow_abc123",
3  "flowName": "Customer Analysis",
4  "createdAt": "2024-01-15T10:30:00Z",
5  "isActive": true
6}

Get help

If you need help, use one of these channels:

Next steps

Continue with one of these developer guides:

Working with tools

Configure and call Tools

Runtime tools

Define Tools inside dispatch requests

Reporting telemetry from an external agent

Send traces from an external agent