Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mocklyapi.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Getting Started

When you log in to MocklyAPI for the first time, an organization and project will be automatically created for you. To create additional organizations, use the organization switcher and select the option to create a new one.
Screenshot of organization switcher.
Screenshot of organization switcher.
Billing is calculated on a per-organization basis. Each user is entitled to create and manage up to two organizations at no cost.
To create a new mock API, select a project and provide a name.
Screenshot of mock API creation modal.
You will then be redirected to the editor interface.
Screenshot of mock API editor page.
Generate data through a simple chat conversation. For example you can specify “Create 10 users for an e-commerce clothing store application.”
Screenshot of mock API editor page with data.
Refine your dataset through additional interactions as needed. Once finalized, click “Save Endpoint” to persist your changes. You can access the data by visiting the provided URL or sending an HTTP request to the endpoint.
By default, endpoints are private and require an authentication token via query parameters to prevent unauthorized access. You can make them public through the settings if necessary.
Screenshot of mock API editor URL.
Visit the endpoint to retrieve the generated data.
Screenshot of API JSON result.

​
Next Steps

With your first mock API up and running, explore these key features:

Bring Your Own Data (BYOD)

Seamlessly upload and utilize your existing datasets within MocklyAPI.

Private Endpoints

Secure your mock APIs with private endpoints and authentication tokens.

Advanced Configurations

Customize response formats, latency, and other parameters for realistic simulations.

AI-Powered Data Generation

Instantly generate realistic, structured datasets using simple chat-based prompts.