DocsREST API Access
REST API Access
Technical documentation for developers looking to integrate the PromptEase Forge into their own apps.
maxAPI Access requires the Max plan.
The PromptEase API allows you to programmatically hit the Forge Engine. Instead of answering questions in our UI, you pass a JSON payload of answers, and we return the highly optimized, paste-ready prompt.
Authentication
Generate a Bearer token in your Account Settings under the 'API Keys' tab. Include this in the `Authorization` header of all requests.
Never expose your API key in client-side code. All API calls must be routed through your secure backend server.
Endpoint: POST /v1/forge/generate
Generates a prompt based on specific workflow criteria.
- type (string, required): The ID of the prompt type (e.g., 'text', 'code', 'image').
- title (string, required): The core objective.
- answers (object, required): A key-value mapping of step IDs to string answers.
Rate Limits
Max plan users are limited to 10,000 API requests per month, with a burst limit of 10 requests per second. Exceeding this will result in a `429 Too Many Requests` response.
Was this page helpful?