Public API Overview

Trigger automations from external systems

What is the Public API?

The Public API lets you trigger Granite automations from anywhere:

• Webhooks from other services
• Cron jobs and schedulers
• CI/CD pipelines
• Custom applications
• Integrations

How It Works

Quick Example

curl -X POST "https://api.getgranite.ai/api/your-org/generate-report" \
  -H "X-Granite-API-Key: gk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"month": "January", "year": 2024}'

Key Concepts

Endpoints

Custom URLs for your automations

API Keys

Authentication credentials

Invocation

How to call your endpoints

URL Structure

https://api.getgranite.ai/api/{org-slug}/{endpoint-slug}

Part	Example	Description
org-slug	acme-corp	Your organization’s slug
endpoint-slug	generate-report	The endpoint you created

Authentication

All API requests require an API key:

-H "X-Granite-API-Key: gk_live_abc123..."

Keep API keys secret. Never expose them in client-side code.

Response Modes

Asynchronous

Default behavior - returns immediately with a run ID:

{
  "runId": "run_abc123",
  "status": "queued"
}

Poll for status later.

Synchronous

Add ?wait=true to wait for completion:

{
  "runId": "run_abc123",
  "status": "completed",
  "duration": 45000,
  "result": { ... }
}

Common Use Cases

Use Case	Example
Scheduled reports	Cron triggers daily report generation
Webhook handling	Process incoming data from another service
CI/CD integration	Run tests or deployments
Form processing	Handle submitted data
Data sync	Keep systems in sync

Rate Limits

Plan	Limit
Free	100 requests/hour
Pro	1,000 requests/hour
Enterprise	Custom

Security Best Practices

Use HTTPS only

All Granite API endpoints use HTTPS. Never downgrade.

Rotate keys periodically

Create new keys and deprecate old ones every 90 days.

Use separate keys per integration

If one is compromised, only that integration is affected.

Monitor usage

Check Analytics for unexpected patterns.

Next Steps

Create Endpoints

Set up your first endpoint

API Keys

Generate and manage keys