> ## Documentation Index
> Fetch the complete documentation index at: https://doc.eazemyapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Api reference

This document describes how to interact with **EazeMyAPI generated APIs**.
EazeMyAPI automatically generates REST APIs for each database table in your project.
Describe your app → AI creates database → APIs ready instantly.

Guide:
[Getting Started](https://doc.eazemyapi.com/docs/getting-started.md)

***

# Base API URL

All API requests follow this format:

```
https://api.eazemyapi.com/{project-name}/{table}/{version}/{action}
```

Example:

```
https://api.eazemyapi.com/my-project/users/v1/list
```

***

# Authentication

Every request must include the API signature header.

```
X-API-SIGNATURE: <your-secret-key>
```

You can find your key here:

```
Project → Settings → API Signature Key
```

Full guide:
[Authentication](https://doc.eazemyapi.com/docs/authentication.md)

***

# API Endpoints

For each table, EazeMyAPI automatically generates REST endpoints.

Example table:

```
users
```

Generated endpoints:

| Method | Endpoint | Description |
| - | - | - |
| GET | `/{project-name}/{table}/{version}/list` | Retrieve all records |
| GET | `/{project-name}/{table}/{version}/show/:id` | Retrieve a single record |
| POST | `/{project-name}/{table}/{version}/create` | Create a new record |
| POST | `/{project-name}/{table}/{version}/update/:id` | Update a record |
| DELETE | `/{project-name}/{table}/{version}/delete/:id` | Delete a record |

Guide:
[Generating APIs](https://doc.eazemyapi.com/docs/generate-api.md)

***

# Example Requests

### List Records

```javascript theme={null}
fetch("https://api.eazemyapi.com/my-project/users/v1/list", {
  method: "GET",
  headers: {
    "X-API-SIGNATURE": "your-secret-key"
  }
})
```

***

### Show Record

```javascript theme={null}
fetch("https://api.eazemyapi.com/my-project/users/v1/show/1", {
  method: "GET",
  headers: {
    "X-API-SIGNATURE": "your-secret-key"
  }
})
```

***

### Create Record

```javascript theme={null}
fetch("https://api.eazemyapi.com/my-project/users/v1/create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-SIGNATURE": "your-secret-key"
  },
  body: JSON.stringify({
    name: "Dara Singh",
    email: "dara@example.com"
  })
})
```

***

### Update Record

```javascript theme={null}
fetch("https://api.eazemyapi.com/my-project/users/v1/update/1", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-SIGNATURE": "your-secret-key"
  },
  body: JSON.stringify({
    name: "Dara Singh Updated"
  })
})
```

***

### Delete Record

```javascript theme={null}
fetch("https://api.eazemyapi.com/my-project/users/v1/delete/1", {
  method: "DELETE",
  headers: {
    "X-API-SIGNATURE": "your-secret-key"
  }
})
```

***

# Response Format

All APIs return JSON responses.

Example:

```json theme={null}
{
  "success": true,
  "message": "Data found.",
  "data": {
    "id": 1,
    "name": "Dara Singh",
    "email": "dara@example.com"
  }
}
```

***

# Next Steps

Learn more about using EazeMyAPI:

* [Creating Tables](https://doc.eazemyapi.com/docs/create-tables.md)
* [Generating APIs](https://doc.eazemyapi.com/docs/generate-api.md)
* [Frontend Integration](https://doc.eazemyapi.com/docs/frontend-integration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.