> ## 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.

# Quickstart

> Begin building your first mock API with ease

## 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.

<Frame>
  <img src="https://mintcdn.com/mocklyapi/PSq8gvyinrK8vmNc/images/create-organization.png?fit=max&auto=format&n=PSq8gvyinrK8vmNc&q=85&s=560c6ec9f94240aa9f8133919aaa0d8d" alt="Screenshot of organization switcher." style={{ borderRadius: '0.5rem' }} width="519" height="306" data-path="images/create-organization.png" />
</Frame>

<Frame style={{ marginTop:'1rem' }}>
  <img src="https://mintcdn.com/mocklyapi/PSq8gvyinrK8vmNc/images/create-organization-modal.png?fit=max&auto=format&n=PSq8gvyinrK8vmNc&q=85&s=e227c3459ce8dd5e8397579982fdc175" alt="Screenshot of organization switcher." style={{ margin:'10px', borderRadius: '0.5rem' }} width="530" height="315" data-path="images/create-organization-modal.png" />
</Frame>

<Callout icon="dollar-sign" color="#407C8F" iconType="regular">Billing is calculated on a per-organization basis. Each user is entitled to create and manage up to two organizations at no cost.</Callout>

To create a new mock API, select a project and provide a name.

<Frame>
  <img src="https://mintcdn.com/mocklyapi/PSq8gvyinrK8vmNc/images/create-mock-api-modal.png?fit=max&auto=format&n=PSq8gvyinrK8vmNc&q=85&s=bcd216a2f2e936d39760ba24b530b451" alt="Screenshot of mock API creation modal." style={{ borderRadius: '0.5rem' }} width="439" height="297" data-path="images/create-mock-api-modal.png" />
</Frame>

You will then be redirected to the editor interface.

<Frame>
  <img src="https://mintcdn.com/mocklyapi/mnDN9u-0ibULlL6w/images/mock-api-editor-page.png?fit=max&auto=format&n=mnDN9u-0ibULlL6w&q=85&s=9b23736dac690a65dae1b313339e0246" alt="Screenshot of mock API editor page." style={{ borderRadius: '0.5rem' }} width="2556" height="1324" data-path="images/mock-api-editor-page.png" />
</Frame>

Generate data through a simple chat conversation. For example you can specify “Create 10 users for an e-commerce clothing store application.”

<Frame>
  <img src="https://mintcdn.com/mocklyapi/mnDN9u-0ibULlL6w/images/mock-api-editor-with-data-page.png?fit=max&auto=format&n=mnDN9u-0ibULlL6w&q=85&s=6f9ee05f22873f4d5861ddd2e1598443" alt="Screenshot of mock API editor page with data." style={{ borderRadius: '0.5rem' }} width="2551" height="1319" data-path="images/mock-api-editor-with-data-page.png" />
</Frame>

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.

<Danger>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.</Danger>

<Frame>
  <img src="https://mintcdn.com/mocklyapi/mnDN9u-0ibULlL6w/images/mock-api-editor-url.png?fit=max&auto=format&n=mnDN9u-0ibULlL6w&q=85&s=6c21f9495cfd19b784a09b07175aaf5a" alt="Screenshot of mock API editor URL." style={{ borderRadius: '0.5rem' }} width="1528" height="54" data-path="images/mock-api-editor-url.png" />
</Frame>

Visit the endpoint to retrieve the generated data.

<Frame>
  <img src="https://mintcdn.com/mocklyapi/mnDN9u-0ibULlL6w/images/api-json-result.png?fit=max&auto=format&n=mnDN9u-0ibULlL6w&q=85&s=e50450646ba572770ffb88b6d0922c18" alt="Screenshot of API JSON result." style={{ borderRadius: '0.5rem' }} width="1293" height="666" data-path="images/api-json-result.png" />
</Frame>

## Next Steps

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

<CardGroup cols={2}>
  <Card title="Bring Your Own Data (BYOD)" icon="suitcase" href="/features/byod">
    Seamlessly upload and utilize your existing datasets within MocklyAPI.
  </Card>

  <Card title="Private Endpoints" icon="lock" href="/features/private-endpoints">
    Secure your mock APIs with private endpoints and authentication tokens.
  </Card>

  <Card title="Advanced Configurations" icon="gear" href="/features/additional-configs">
    Customize response formats, latency, and other parameters for realistic simulations.
  </Card>

  <Card title="AI-Powered Data Generation" icon="sparkles" href="/features/chat">
    Instantly generate realistic, structured datasets using simple chat-based prompts.
  </Card>
</CardGroup>
