Getting Started
The Forgecroft API allows you to programmatically manage workspaces, runs, policies, and more.
Base URL
https://api.forgecroft.com/v1
Authentication
All API requests require authentication via an API key. Pass your key in the Authorization header:
Authorization: Bearer <your-api-key>
Response Format
All responses are JSON. Error responses include an error field with a message.
Rate Limits
- Standard keys: 100 requests/minute
- Admin keys: 1000 requests/minute
Exceeded limits return 429 Too Many Requests.
Quick Examples
List Workspaces
curl -H "Authorization: Bearer $FORGECROFT_KEY" \
https://api.forgecroft.com/v1/workspaces
Create a Run
curl -X POST -H "Authorization: Bearer $FORGECROFT_KEY" \
-H "Content-Type: application/json" \
https://api.forgecroft.com/v1/workspaces/{workspace-id}/runs \
-d '{"message": "Apply changes"}'
Interactive API Docs
Explore our API using the interactive reference below: