Back to Docs
API Reference15 min read

API Reference

Complete reference documentation for all Gravitre API endpoints, including request/response schemas and examples.

Base URL

All API requests should be made to: https://api.gravitre.app/v1

Workflows

The Workflows API allows you to create, read, update, and delete workflows programmatically.

// List all workflows
GET /v1/workflows

// Create a workflow
POST /v1/workflows

// Get a specific workflow
GET /v1/workflows/:id

// Update a workflow
PATCH /v1/workflows/:id

// Delete a workflow
DELETE /v1/workflows/:id

Runs

The Runs API provides access to workflow execution history and real-time status.

// List runs for a workflow
GET /v1/workflows/:id/runs

// Get a specific run
GET /v1/runs/:id

// Cancel a running workflow
POST /v1/runs/:id/cancel

Need more help?

Can't find what you're looking for? Our team is here to help.