klas/t6_mem0
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[REST API] Incorporate changes related to REST API docs (#900)

Browse Source
This commit is contained in:
Deshraj Yadav
2023-11-03 00:42:55 -07:00
committed by GitHub
parent 8dd5cb9602
commit fa3ca1d08a
23 changed files with 323 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-reference/getting-started.mdx
View File

@@ -7,10 +7,10 @@ title: "🌍 Getting Started"
To run Embedchain as a REST API server use,
```bash
docker run -d --name embedchain -p 8000:8000 embedchain/app:rest-api-latest
docker run -d --name embedchain -p 8080:8080 embedchain/app:rest-api-latest
```
Open up your browser and navigate to http://0.0.0.0:8000/docs to interact with the API. There is a full-fledged Swagger docs playground with all the information
Open up your browser and navigate to http://0.0.0.0:8080/docs to interact with the API. There is a full-fledged Swagger docs playground with all the information
about the API endpoints.
![Swagger Docs Screenshot](https://github.com/embedchain/embedchain/assets/73601258/299d81e5-a0df-407c-afc2-6fa2c4286844)
@@ -83,7 +83,7 @@ To provide them, you can simply run the docker command with the `-e` flag.
For example,
```bash
docker run -d --name embedchain -p 8000:8000 -e OPENAI_API_KEY=YOUR_API_KEY embedchain/app:rest-api-latest
docker run -d --name embedchain -p 8080:8080 -e OPENAI_API_KEY=YOUR_API_KEY embedchain/app:rest-api-latest
```
Cool! This will create a new Embedchain App with the given `app_id`.