## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.mem0.ai/llms.txt)

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

### Python

```python
# To use the Python SDK, install the package:
# pip install mem0ai

from mem0 import MemoryClient
client = MemoryClient(api_key="your_api_key")
users = client.users()
print(users)
```

### JavaScript

```javascript
// To use the JavaScript SDK, install the package:
// npm i mem0ai

import MemoryClient from 'mem0ai';
const client = new MemoryClient({ apiKey: "your-api-key" });

// Retrieve all users
client.users()
  .then(result => console.log(result))
  .catch(error => console.error(error));
```

### cURL

```
curl --request GET \
  --url https://api.mem0.ai/v1/entities/ \
  --header 'Authorization: Token <api-key>'
```

### Go

```go
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

url := "https://api.mem0.ai/v1/entities/"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Token <api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

fmt.Println(res)
	fmt.Println(string(body))
}
```

### PHP

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mem0.ai/v1/entities/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Token <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>
```

### Unirest (Java)

```
HttpResponse<String> response = Unirest.get("https://api.mem0.ai/v1/entities/")
  .header("Authorization", "Token <api-key>")
  .asString();
```

### Ruby

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.mem0.ai/v1/entities/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

### Response Structure

```json
[
  {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "total_memories": 123,
    "owner": "<string>",
    "organization": "<string>",
    "metadata": {}
  }
]
```

### Authorizations

**Authorization**  
`string`  
`header`  
`required`  
API key authentication. Prefix your Mem0 API key with 'Token '. Example: 'Token your_api_key'

### Query Parameters

- **org_id**  
  `string`  
  Filter entities by organization ID.
- **project_id**  
  `string`  
  Filter entities by project ID.

### Response

**200 - application/json**  
Successfully retrieved list of entities.

- **id**  
  `string`  
  Unique identifier for the entity.
- **name**  
  `string`  
  Name of the entity.
- **created_at**  
  `string<date-time>`  
  Timestamp of when the entity was created.
- **updated_at**  
  `string<date-time>`  
  Timestamp of when the entity was last updated.
- **total_memories**  
  `integer`  
  Total number of memories associated with the entity.
- **owner**  
  `string`  
  Owner of the entity.
- **organization**  
  `string`  
  Organization the entity belongs to.
- **type**  
  `enum<string>`  
  Available options:
  `user`, `agent`, `app`, `run`
- **metadata**  
  `object`  
  Additional metadata associated with the entity.
