Skip to main content

Overview

The Granite API provides programmatic access to all platform features. It’s a RESTful API with JSON request/response bodies.

Base URL

For local development:

Authentication

For server-to-server communication:

API Categories

The API is organized into these categories: Total: 110+ endpoints

Request Format

All requests should include:
Request bodies are JSON:

Response Format

Successful responses return JSON:
Error responses include:

Status Codes

Rate Limits

Rate limit headers:

Pagination

List endpoints support pagination:
Response includes pagination info:

Streaming Endpoints

Some endpoints return Server-Sent Events (SSE):
  • GET /api/agent/run - Agent execution stream
  • GET /api/rpa/run - RPA execution stream

WebSocket Endpoints

Real-time communication:
  • wss://api.getgranite.ai/ws/driver - Driver connection
  • wss://api.getgranite.ai/api/frontend-ws - Frontend updates

OpenAPI Specification

The complete API specification is available:
  • Swagger UI: https://api.getgranite.ai/docs
  • ReDoc: https://api.getgranite.ai/redoc
  • OpenAPI JSON: https://api.getgranite.ai/openapi.json

SDK

Use our TypeScript SDK for easier integration:
See TypeScript SDK for details.

Explore the API

Browse endpoints by category in the sidebar, or use the interactive API playground.