Skip to main content

Tedro API

The Tedro REST API lets you programmatically manage workflows, contacts, conversations, runs, and more. All endpoints are served from https://api.tedro.io and return JSON responses.

Base URL

Quick Overview

The API is organized around these core resources:

Authentication

Every API request requires two things:
  1. A session cookie obtained by signing in
  2. An x-workspace-id header with your workspace UUID
See the Authentication page for details and working examples.

Getting Started

Authentication

Learn how to authenticate your API requests with session cookies and workspace headers.

API Quickstart

Make your first API call in under 5 minutes with a working cURL example.

Error Reference

Understand error response formats, HTTP status codes, and common error scenarios.

Code Examples

Copy-paste cURL and Node.js examples for common API operations.

Conventions

  • UUIDs — All resource IDs are UUIDs (e.g., 550e8400-e29b-41d4-a716-446655440000)
  • JSON — Request and response bodies use application/json
  • Pagination — List endpoints support limit and offset query parameters
  • Workspace isolation — All data is scoped to the workspace specified in x-workspace-id