​
Quickstart

To use Embedchain as a REST API service, run the following command:

docker run --name embedchain -p 8080:8080 embedchain/rest-api:latest

Navigate to http://localhost: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

​
⚡ Steps to get started

1

⚙️ Create an app

curl --request POST "http://localhost:8080/create?app_id=my-app" \
 -H "accept: application/json"
2

🗃️ Add data sources

curl --request POST \
  --url http://localhost:8080/my-app/add \
  -d "source=https://www.forbes.com/profile/elon-musk" \
  -d "data_type=web_page"
3

💬 Query on your data

curl --request POST \
  --url http://localhost:8080/my-app/query \
  -d "query=Who is Elon Musk?"
4

🚀 (Optional) Deploy your app to Embedchain Platform

curl --request POST \
  --url http://localhost:8080/my-app/deploy \
  -d "api_key=ec-xxxx"

And you’re ready! 🎉

If you run into issues, please feel free to contact us using below links:

Talk to founders

Schedule a call

Slack

Join our slack community

Discord

Join our discord community

Was this page helpful?

Notebooks & ReplitsCreate app