This guide covers the fundamental concepts and best practices for working with the Catalyzed REST API. The API provides programmatic access to all platform features including teams, users, datasets, files, agents, and pipelines.

API Overview

Base URL and Documentation

• Platform API: https://platform.us.catalyzed.ai
• Interactive Documentation: Available at /docs (Swagger UI)
• OpenAPI Specification: Available at /openapi.json

API Characteristics

• Response Format: JSON with consistent error handling
• Request Timeout: 10 seconds for all endpoints
• Schema Validation: All requests and responses are validated
• CORS: Configured for web application integration

Authentication

The API supports two authentication methods that can be used interchangeably:

Session-Based Authentication

Used primarily by web applications for user interactions.

How it works:

• Login with email/password or magic link
• Receive HTTP-only session cookie
• Cookie automatically included in subsequent requests
• 7-day session expiry with automatic renewal