REST API Documentation
Complete reference for the GitFables REST API endpoints, authentication, and usage examples.
1
Authentication
All API requests require authentication using an API key.
Add your API key to the Authorization header:
auth-header.txt
Bash
Authorization: Bearer your-api-keyAPI Authentication Header Example
You can obtain your API key from your GitFables dashboard.
2
Story Endpoints
Manage stories through these REST endpoints.
GET
/api/storiesList all stories
POST
/api/storiesGenerate a new story
GET
/api/stories/:idGet a specific story
PUT
/api/stories/:idUpdate a story
DELETE
/api/stories/:idDelete a story
3
Template Endpoints
Manage story templates through these REST endpoints.
GET
/api/templatesList all templates
POST
/api/templatesCreate a new template
GET
/api/templates/:idGet a specific template
PUT
/api/templates/:idUpdate a template
DELETE
/api/templates/:idDelete a template
4
Rate Limiting
The API is rate limited to 100 requests per minute per API key.
Check your current rate limit status in the response headers:
X-RateLimit-LimitMaximum number of requests per minuteX-RateLimit-RemainingNumber of requests remaining in the current windowX-RateLimit-ResetTime when the rate limit will reset