Add API-Reference docs for Organization/Project (#1858)
This commit is contained in:
4
docs/api-reference/organization/add-org-member.mdx
Normal file
4
docs/api-reference/organization/add-org-member.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Add Member'
|
||||||
|
openapi: post /api/v1/orgs/organizations/{org_id}/members/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/create-org.mdx
Normal file
4
docs/api-reference/organization/create-org.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Create Organization'
|
||||||
|
openapi: post /api/v1/orgs/organizations/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/delete-org-member.mdx
Normal file
4
docs/api-reference/organization/delete-org-member.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Delete Member'
|
||||||
|
openapi: delete /api/v1/orgs/organizations/{org_id}/members/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/delete-org.mdx
Normal file
4
docs/api-reference/organization/delete-org.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Delete Organization'
|
||||||
|
openapi: delete /api/v1/orgs/organizations/{org_id}/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/get-org-members.mdx
Normal file
4
docs/api-reference/organization/get-org-members.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Get Members'
|
||||||
|
openapi: get /api/v1/orgs/organizations/{org_id}/members/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/get-org.mdx
Normal file
4
docs/api-reference/organization/get-org.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Get Organization'
|
||||||
|
openapi: get /api/v1/orgs/organizations/{org_id}/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/get-orgs.mdx
Normal file
4
docs/api-reference/organization/get-orgs.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Get Organizations'
|
||||||
|
openapi: get /api/v1/orgs/organizations/
|
||||||
|
---
|
||||||
4
docs/api-reference/organization/update-org-member.mdx
Normal file
4
docs/api-reference/organization/update-org-member.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Update Member'
|
||||||
|
openapi: put /api/v1/orgs/organizations/{org_id}/members/
|
||||||
|
---
|
||||||
@@ -23,6 +23,32 @@ Our API is organized into several main categories:
|
|||||||
|
|
||||||
All API requests require authentication using HTTP Basic Auth. Ensure you include your API key in the Authorization header of each request.
|
All API requests require authentication using HTTP Basic Auth. Ensure you include your API key in the Authorization header of each request.
|
||||||
|
|
||||||
|
## Organizations and projects (optional)
|
||||||
|
|
||||||
|
For users who belong to multiple organizations or are working on multiple projects, you can specify the organization and project for an API request. This is done by initializing the Mem0 client with the appropriate parameters. Usage from these API requests will be attributed to the specified organization and project.
|
||||||
|
|
||||||
|
Example with the mem0 Python package:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from mem0 import MemoryClient
|
||||||
|
|
||||||
|
client = MemoryClient(
|
||||||
|
organization_name='YOUR_ORG_NAME',
|
||||||
|
project_name='YOUR_PROJECT_NAME',
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
Example with the mem0 Node.js package:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { MemoryClient } from "mem0ai";
|
||||||
|
|
||||||
|
const client = new MemoryClient({
|
||||||
|
organization: "YOUR_ORG_NAME",
|
||||||
|
project: "YOUR_PROJECT_NAME"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To begin using the Mem0 API, you'll need to:
|
To begin using the Mem0 API, you'll need to:
|
||||||
|
|||||||
4
docs/api-reference/project/add-project-member.mdx
Normal file
4
docs/api-reference/project/add-project-member.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Add Member'
|
||||||
|
openapi: post /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/create-project.mdx
Normal file
4
docs/api-reference/project/create-project.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Create Project'
|
||||||
|
openapi: post /api/v1/orgs/organizations/{org_id}/projects/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/delete-project-member.mdx
Normal file
4
docs/api-reference/project/delete-project-member.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Delete Member'
|
||||||
|
openapi: delete /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/delete-project.mdx
Normal file
4
docs/api-reference/project/delete-project.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Delete Project'
|
||||||
|
openapi: delete /api/v1/orgs/organizations/{org_id}/projects/{project_id}/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/get-project-members.mdx
Normal file
4
docs/api-reference/project/get-project-members.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Get Members'
|
||||||
|
openapi: get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/get-project.mdx
Normal file
4
docs/api-reference/project/get-project.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Get Project'
|
||||||
|
openapi: get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/get-projects.mdx
Normal file
4
docs/api-reference/project/get-projects.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Get Projects'
|
||||||
|
openapi: get /api/v1/orgs/organizations/{org_id}/projects/
|
||||||
|
---
|
||||||
4
docs/api-reference/project/update-project-member.mdx
Normal file
4
docs/api-reference/project/update-project-member.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: 'Update Member'
|
||||||
|
openapi: put /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||||
|
---
|
||||||
@@ -159,6 +159,42 @@
|
|||||||
"api-reference/entities/get-users",
|
"api-reference/entities/get-users",
|
||||||
"api-reference/entities/delete-user"
|
"api-reference/entities/delete-user"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group": "Organizations APIs",
|
||||||
|
"pages": [
|
||||||
|
"api-reference/organization/get-orgs",
|
||||||
|
"api-reference/organization/get-org",
|
||||||
|
"api-reference/organization/create-org",
|
||||||
|
"api-reference/organization/delete-org",
|
||||||
|
{
|
||||||
|
"group": "Members APIs",
|
||||||
|
"pages": [
|
||||||
|
"api-reference/organization/get-org-members",
|
||||||
|
"api-reference/organization/add-org-member",
|
||||||
|
"api-reference/organization/update-org-member",
|
||||||
|
"api-reference/organization/delete-org-member"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group": "Projects APIs",
|
||||||
|
"pages": [
|
||||||
|
"api-reference/project/get-projects",
|
||||||
|
"api-reference/project/get-project",
|
||||||
|
"api-reference/project/create-project",
|
||||||
|
"api-reference/project/delete-project",
|
||||||
|
{
|
||||||
|
"group": "Members APIs",
|
||||||
|
"pages":[
|
||||||
|
"api-reference/project/get-project-members",
|
||||||
|
"api-reference/project/add-project-member",
|
||||||
|
"api-reference/project/update-project-member",
|
||||||
|
"api-reference/project/delete-project-member"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
1004
docs/openapi.json
1004
docs/openapi.json
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user