Widget
Admin
- GETAPI to get StarFish settings
- POSTAPI to update StarFish settings
- POSTAPI to update StarFish RAG settings
- GETAPI to get all users
- POSTAPI to register user by admin
- POSTAPI to reset user password by admin
- GETAPI to get all models
- POSTAPI to save model from inputed url
- GETAPI to get models by Org Id
- POSTAPI to fetch avialable model from inputed url
- POSTAPI to toogle model
- POSTAPI to toogle model
- POSTAPI to save embedding model from inputed url
API Reference
- GETGet apiv1adminadmin details by userid
- POSTPost apiv1admintoggle account status
- POSTPost apiv1adminsendloginremindermessage
- POSTPost apiv1aptlyteamteamlogin
- POSTPost apiv1aptlyteamteam register
- GETGet apiv1aptlyteaminfo
- GETGet apiv1aptlyteamall
- POSTPost apiv1aptlyteamadd
- PUTPut apiv1aptlyteam
- DELDelete apiv1aptlyteam
- GETGet apiv1aptlyteambotslist
- GETGet apiv1orgmy organization
- GETGet apiv1org getaimodelsoforg
- DELDelete apiv1org chatmodelsonorg
- GETGet apiv1pricingplans
- POSTPost apiv1pricingsubscribe
- GETGet apiv1pricingmy payment
- POSTPost apiv1stripewebhook
- POSTPost apiv1userregisterwithinvitation
- GETGet apiv1userverify email
- POSTPost apiv1userforgot password
- GETGet apiv1userreset password
- POSTPost apiv1userreset password
- GETGet apiv1useruser info
- GETGet apiv1aptlyteampermission
- POSTPost apiv1aptlyteampermissionadd
- PUTPut apiv1aptlyteampermission
- DELDelete apiv1aptlyteampermission
- GETGet apiv1aptlyteamrole
- POSTPost apiv1aptlyteamroleadd
- PUTPut apiv1aptlyteamrole
- DELDelete apiv1aptlyteamrole
- GETGet apiv1aptlyteamrole permission detail
- POSTPost apiv1aptlyteamrole permission detail
- DELDelete apiv1aptlyteamrole permission detail
- GETGet apiv1oauthmicrosoftcallback
- GETGet apiv1oauthgithubcallback
- POSTPost apiv1oauthgooglecallback
- GETGet apiv1oauthgithub
- GETGet apiv1oauthmicrosoft
DataStore
- GETGet datastore overview details by org id and datastore id
- GETGet Data sources list by org id and datastore id
- POSTAdd data source into datastore
- POSTAdd data source ( file type only) into datastore
- GETGet Data sources list by org id and not eqaul to datastore id
- GETGet Datastores list by org id and not eqaul to bot id
- GETGet Datastores list by org id and embedding model
- POSTAPI to add datastore to bot
- GETGet Datastores list by org id and bot id
- PUTAPI to update existing data store detail
- PUTAdd or remove data source from datastore knowledge corpus
- PUTUpdate chunk status and content
- DELDelete data source from Data Source List
- GETGet the content of data source by data source id
- GETAPI to get bots and data source count by organization id and DataStore id
- DELDelete data store that added to bot
Bot
- GETAPI to get prompts by bot id
- GETAPI to get all bots
- POSTPost apiv1bot
- POSTAPI to create new bot based on project
- GETGet apiv1botorg project agents
- GETGet apiv1bot embed
- GETGet apiv1bot source
- POSTPost apiv1bot source
- GETGet apiv1bot
- PUTPut apiv1bot
- DELDelete apiv1bot
- POSTPost apiv1bot source refresh
- PUTPut apiv1bot source
- DELDelete apiv1bot source
- POSTAPI to upload files
- POSTAPI to upload files
- GETAPI to get bot config by organization id
- GETGet apiv1bot settings
- POSTPost apiv1bot copy
- POSTPost apiv1botapi
- POSTPost apiv1bot sourcebulk
- POSTAPI to upload files as source
- POSTAPI to send message to bot
- GETGet apiv1bot is ready
- PUTPut apiv1bot update
- PUTPut apiv1bot password
- GETAPI to get prompts by bot id
- GETAPI to get feedbacks by bot id
- GETGet chat history by intergation type
- GETGet chat history by chat id
- GETGet all bot channels
- POSTAPI to create bot integration
- POSTAPI to pause or resume bot integration
- GETAPI to get API key for bot integration
- PUTAPI to regenerate API key for bot integration
- POSTAPI to generate API key for bot integration
- POSTAPI to send message to bot on playground
- POSTAPI to get stream of message from bot on playground
- GETAPI to get history of message from bot on playground
- GETAPI to get history of message from bot on playground by history id
- POSTAPI to get audio settings from bot on playground
- PUTAPI to update bot playground title by id
- DELAPI to delete bot playground by id
- PUTProvide feedback for bot answer
- GETAPI to get bot appearance by id
- POSTAPI to save bot appearance by id
Organization
- GETAPI to get organization by id
- GETAPI to get organization by id
- GETAPI to get users by invitation key
- GETAPI to get projects by organization id
- GETAPI to get Organization Details by organization id
- POSTAPI to add new project
- GETAPI to get users by organization id
- POSTAPI to create new user
- PUTAPI to update user role on organization
- DELAPI to delete user on organization
- POSTAPI to add chat models to organization
- GETAPI to get counts of projects, teams, users, and bots on the organization
- POSTAPI to create new data store
- GETAPI to get data stores by organization id
- GETAPI to get admin users by organization id
- POSTAPI to create new Obstralog Instance for organization
- GETAPI to get obstralog instance details by org id
- GETAPI to get data stores size by organization id
- PUTAPI to update activeStatus of existing user
- PUTAPI to update IsWorkEmailBasedInvitations by org id
- PUTAPI to update org details of user
- PUTAPI to update existing project
Project
- GETGet project overview details by org id and project id
- POSTAPI to add new team into the project
- GETAPI to get teams list by organization id and project id
- GETAPI to get users list added to the team of project
- POSTAPI to add users to the team of the project
- GETAPI to get users list added to the team of project
- GETAPI to get obstralog instance details by organization id and project id
- POSTAPI to create new Obstralog Instance for project
- GETAPI to get bots count by organization id and project id
- DELAPI to delete user from team of project
- DELAPI to delete team from this project
- GETAPI to get all users from this project
- POSTAPI to delete users from the project
User
- POSTAPI to login user
- GETGet user profile
- POSTAPI to update user profile
- POSTAPI to update user password
- GETAPI to check if registeration is allowed
- POSTAPI to register user
- GETCheck if user is admin
- GETGet all api keys by user
- POSTCreate new api key
- DELDelete api key
- GETGet the users by filtering inactiveDays and pagination
- GETAPI to get user overview by organization id and user id
- GETAPI to get user team details by organization id and user id
- POSTUpdate user profile
- POSTAPI to login user
API to get user overview by organization id and user id
Copy
curl --request GET \
--url https://app.aptlystar.ai/api/v1/user/{org_id}/{user_id}/getUserOverview \
--header 'Authorization: <authorization>'User
API to get user overview by organization id and user id
GET
/
api
/
v1
/
user
/
{org_id}
/
{user_id}
/
getUserOverview
API to get user overview by organization id and user id
Copy
curl --request GET \
--url https://app.aptlystar.ai/api/v1/user/{org_id}/{user_id}/getUserOverview \
--header 'Authorization: <authorization>'Get the users by filtering inactiveDays and paginationAPI to get user team details by organization id and user id
⌘I