---
updatedAt: 2025-06-18T21:49:59.000Z
agentTools:
  projectIndex: https://developer.runn.io/llms.txt
---

# Getting Started with the Runn API

**Overview**

The Runn API uses REST principles, exposing predictable resource-oriented URLs. It accepts request bodies and exposes data via JSON encoding. Errors are communicated via standard HTTP response codes.

The Runn API v1 can be accessed via <https://api.runn.io>, unless you have been provided a different URL (check in "Settings > API" in the Runn app). Only administrators in your Runn account can see this page.

All Runn API v1 endpoints are available in a machine-readable format via the [OpenAPI v3.1 specification](https://developer.runn.io/openapi/v1.0.0.json). This spec provides a structured and standardized way to explore and interact with the Runn API programmatically.

For a human-friendly, interactive guide to all available endpoints, visit the [Runn API v1 Reference](https://developer.runn.io/reference/).

Browse the following sections to learn all about using the Runn API

* [Authentication](authentication)
* [Test Account](test-account)
* [Versioning](versioning)
* [Usage](usage)
* [Pagination](pagination)
* [Rate limits](rate-limits)
* [Errors](errors)

[![Watch the video](https://cdn.loom.com/sessions/thumbnails/8990783b99804cd7850d4d138398764b-2695f6526d386b6c-full-play.gif)](https://www.loom.com/share/8990783b99804cd7850d4d138398764b)