Skip to Content

Authentication

All API requests require an API key passed in the Authorization header.

Creating an API key

  1. Sign in to Forge Json 
  2. Go to Dashboard → API Keys
  3. Click Create New Key
  4. Give it a name and select permissions
  5. Copy the key — it’s only shown once

API keys start with the prefix fje_.

Using your API key

Include the key in the Authorization header as a Bearer token:

curl -X GET https://forgejson.com/api/v1/documents \ -H "Authorization: Bearer fje_your_api_key_here"

Keep your API key secret. Never commit it to source control or expose it in client-side code.

The live API schema is also available at /api/openapi.

Permissions

When creating an API key, you select what it can access:

PermissionAllows
documentsRead, create, update, and delete documents
pipelinesExecute saved pipelines
utilitiesRun individual utilities
*All permissions

A request to an endpoint without the required permission returns 403 Forbidden.

Rate limiting

API requests are rate-limited per key. Response headers indicate your current status:

HeaderDescription
X-RateLimit-RemainingRequests remaining in the current window
X-RateLimit-ResetUnix timestamp when the limit resets. Most useful on rate-limited responses.

When the limit is exceeded, requests return 429 Too Many Requests.

Monthly credits

Each API key is tied to your account’s monthly credit allocation:

PlanMonthly credits
Starter (Free)100
Pro ($12/mo)10,000
Team ($49/mo)100,000

Successful pipeline and utility executions consume 1 credit each. Document API calls are also tracked for usage in the current backend implementation. Failed executions do not consume execution credits.

Error responses

All authentication errors return a consistent format:

{ "success": false, "error": "Invalid API key" }
StatusMeaning
401Missing Authorization header, invalid key format, or revoked key
403Key lacks the required permission for this endpoint
429Rate limit exceeded
Last updated on