Skip to main content

API Reference

Complete reference documentation for all Gravity Rail API endpoints.

Base URL: https://api.gravityrail.com/api/v2

Every endpoint requires authentication with an API key or OAuth token unless marked otherwise — see the Authentication guide. For a curl-first tour of the most common calls, start with the Quick Reference. TypeScript users can call the same API through the SDK.

Pages are grouped by scope: Global APIs act on your account and organizations; Workspace APIs act inside a single workspace and are prefixed with /api/v2/w/{workspace_uuid}.

API Modules​

The API is organized into the following categories:

Global​

  • AI Models — Available AI models and capabilities
  • Account — User account management
  • Features — Available platform features and capabilities
  • Organizations — Organization public configuration
  • Resources — Resource metadata and definitions

Workspace​

  • Assignments — A Member's state and progress through a Workflow during a Chat.
  • Calendar Event Types — Calendar event type definitions
  • Calendar Events — Calendar event management
  • Calendars — Calendar and scheduling management
  • Chat Labels — Chat conversation tagging and categorization
  • Chats — Conversation threads between Members, Agents, and staff across web, SMS, email, and voice
  • Custom Toolkits — Custom AI toolkit creation and management
  • Data Records — Structured data record CRUD within a data type
  • Data Types — Custom data type management
  • Event Rules — Event-driven automation rules
  • Files — File upload and management
  • Folders — File and document folder management
  • Inboxes — Email inbox and message thread management
  • Journey Notes — Notes and annotations on member journeys
  • Journeys — Member journey tracking and progression
  • Journeys Enrollment — Enroll, unenroll, and re-enroll members in journeys
  • MCP Servers — Model Context Protocol server management
  • Member Labels — Member tagging and categorization
  • Member Roles — Member role and permission management
  • Members — The people in a workspace — roster, profiles, custom fields, and bulk import/export
  • Site menu — Manage a Site's navigation menu and hierarchical menu items.
  • Notification Rules — Notification delivery rules and triggers
  • Notifications — Notification management
  • Phone Call List — Voice call history and management
  • Phone Numbers — Phone number and SMS management
  • Recordings — Voice call recordings
  • Routines — Routines — the unified automation primitive (schedule, webhook, and system-event triggers)
  • Settings — Workspace configuration and settings management
  • File sharing — Access shared Files and folders, including folder contents and File downloads.
  • Sites — Website and content management
  • Snippets — Reusable content snippets and macros
  • Tasks — Task execution and monitoring
  • Toolkits — Available AI toolkits and capabilities
  • Webhook Logs — Webhook request history and debugging
  • Workflows — Create and run Workflows — multi-step processes with Tasks, permissions, and escalation rules