Documentation FAQ

Forge API is a hosted mock REST API service. You define an endpoint path and JSON response, then Forge API gives you a public HTTPS URL that can be used by frontend applications, mobile apps, tests and API clients.

No. Forge API is designed to let you continue frontend development before the real backend is available. When the production backend is ready, you can replace the Forge API base URL while keeping a compatible response structure.

No. You can create a Free account without entering payment-card details. Paid plans are only required when you need higher limits or paid features.

Yes. After signing in, you can enter an endpoint path, paste valid JSON and select Generate API. Forge API can save the endpoint to your default project or create an automatic project when appropriate.

A project groups related mock API endpoints under one public project key. For example, one ecommerce project could contain products, customers, orders and authentication endpoints.

A project key is the public identifier included in endpoint URLs. It identifies the project but should not be treated as a password or private secret.

Yes. Updating the project name or description does not change its public project key or existing endpoint URLs.

The default project is the project Forge API uses when you generate an endpoint from the homepage. You can change the default project through project settings.

Yes, but deleting a project permanently removes its endpoints. Applications using those endpoint URLs will receive a not-found response.

Forge API supports the standard methods available in the endpoint editor, including GET, POST, PUT, PATCH, DELETE and HEAD.

They can use the same path when their HTTP methods are different. For example, GET /products and POST /products are separate endpoints. Two endpoints with the same method and path cannot exist in the same project.

Yes. Paths such as /products/featured, /users/profile and /orders/latest are supported.

Yes. Responses can contain arrays, objects, nested arrays, nested objects, strings, numbers, booleans and null values, as long as the complete response is valid JSON.

Yes. You can update the HTTP method, path, status code, response body, response headers, required request headers, delay and active state.

Changing the path changes the public URL. Any application calling the previous path must be updated.

Yes. Mark the endpoint as inactive to stop public access without deleting its saved configuration.

Yes. You can configure success and error status codes such as 200, 201, 400, 401, 404 and 500.

Yes. You can configure supported custom response headers. Unsafe transport-level headers such as Content-Length, Connection and Set-Cookie are not forwarded.

Yes, on supported paid plans. Add a response delay to test loading indicators, skeleton screens, disabled controls and timeout behaviour.

For an empty collection, return an empty JSON array such as []. You can also configure a 204 status when testing a successful response with no body.

Create separate endpoints that return the relevant status codes and error JSON. Common examples include validation errors, unauthorized responses, not-found responses and server errors.

Public endpoint URLs can be called by anyone who knows or discovers them unless required request-header protection is configured.

Supported paid plans can require one or more request headers. The caller must provide the correct header names and values before Forge API returns the configured response.

Yes. Project-level request-header protection applies shared required headers across endpoints in that project.

The caller must provide every required project header and every required endpoint header.

No. It is shared-secret request protection, not a complete user authentication or authorization system. It does not replace OAuth, user sessions or production access-control logic.

You should not treat a value included in public frontend code as secret because users can inspect it. Secret headers are better suited to trusted servers, internal tools, controlled clients and test environments.

No. Do not store real passwords, API keys, access tokens, card details, private customer data or confidential production information in mock responses.

Yes. Paste the complete generated URL into the browser address bar to view the JSON response.

Yes. Forge API endpoints are ordinary HTTPS REST endpoints and can be called using fetch, Axios or another HTTP library.

Yes. Use the generated endpoint URL, select the configured HTTP method and include any required request headers.

Yes. Mobile applications can call Forge API endpoints using their normal HTTP networking libraries.

Public endpoint responses include CORS headers so they can be called from browser-based frontend applications.

Forge API primarily matches the configured project key, endpoint path and HTTP method, then returns the saved mock response. It is designed for predictable mock responses rather than full production request processing.

A request to a public Forge API endpoint counts toward the monthly request allowance, whether it comes from a browser, application, test suite, Postman or another client.

The monthly request allowance resets according to the account billing or usage period shown in the dashboard.

Forge API prevents another project from being created until you delete an unused project or upgrade to a plan with a higher allowance.

Forge API prevents another endpoint from being created in that project until usage is reduced or the account is upgraded.

Additional public endpoint requests may be rejected until the allowance resets or the account is upgraded.

Yes. The maximum response size per endpoint depends on the active plan.

Open the Dashboard and Usage pages to review project, endpoint, storage and monthly request usage.

Open the pricing or Billing page, select a paid plan and complete Stripe Checkout.

Paid access normally begins after Stripe confirms the subscription and Forge API synchronizes the subscription status.

Open Dashboard, then Billing, and select Manage subscription to open the Stripe Customer Portal.

A subscription scheduled for cancellation normally remains active until the current paid period ends. It will not renew automatically, and the account then returns to the Free plan.

Yes, while the subscription remains active and the paid period has not ended. Resuming enables future automatic renewal again.

No. Cancellation controls future renewal. Refunds are separate and do not happen automatically when a subscription is cancelled.

No. The account remains available and returns to the Free plan after paid access ends.

Available invoices and billing documents can be accessed through the Stripe Customer Portal.

A paused account cannot use protected dashboard actions or create additional resources. The user can still access appropriate public support routes such as the contact page.

Use the Forge API contact page for account, billing, technical or general enquiries.

Include the email associated with your account, the affected project or endpoint, the error message and the steps required to reproduce the issue. Do not send passwords, secret header values or complete card details.