API Endpoints
In this section will cover how to access the Ask Sage API and the available endpoints.
Table of contents
API Endpoints
The Ask Sage API is a RESTful API that provides access to the Ask Sage platform. The API is divided into two main parts: the User API and the Server API. Each API has its own set of endpoints and functionalities.
User API Endpoints:
The User API is used for managing users, authentication, and datasets.
- The Base URL varies depending on the environment you are working on, but it typically follows the format: [ Base URL: api.asksage.ai/user/ ]
Reference the following Swagger Documentation for detailed information on the User API endpoints and how to use them:
- Ask Sage User API: Copy and paste the following URL to access the Swagger documentation:
https://app.swaggerhub.com/apis-docs/asksageinc/ask-sage_user_api/1.21
The following table shows a summary of some of the available endpoints in the User API: (Reference the Swagger documentation for full details on each endpoint and other available endpoints.)
| Endpoint | Description |
|---|---|
/get-token-with-api-key | Get an access token with API Key and email |
/get-user-logins | Get your last logins (limited to 5 by default) |
/get-user-logs | Get your last prompts |
/add-dataset | Add a new dataset |
/delete-datasets | Deletes a dataset |
Server API Endpoints:
The Server API is used for managing the server, including the Ask Sage API.
- The Base URL varies depending on the environment you are working on, but it typically follows the format: [ Base URL: api.asksage.ai/server/ ]
Reference the following Swagger Documentation for detailed information on the Server API endpoints and how to use them:
- Ask Sage Server API: Copy and paste the following URL to access the Swagger documentation:
https://app.swaggerhub.com/apis-docs/asksageinc/ask-sage_server_api/1.55
The following table shows the available endpoints in the Server API:
| Endpoint | Description |
|---|---|
/get-models | Returns a list of available models via the Ask Sage services |
/query | Main endpoint for generating completions based on the user’s input |
/query_with_file | Query with file endpoint for generating completions based on the user’s input |
/query-plugin | Query with plugin endpoint for generating completions based on the user’s input |
/execute-plugin | Execute a plugin with the provided content |
/follow_up_questions | Endpoint for generating follow-up questions based on the user’s input |
/tokenizer | Endpoint for getting tokens of string value |
/get-personas | Endpoint for getting the tokens of string |
/get-datasets | Returns a list of available datasets |
/get-plugins | Returns a list of available plugins |
/train | Trains the model based on the user’s input |
/file | Converts a supported file to plain/text |
Base URLs may change, depending on the environment you are working on. If you need assistance, please reach out to us at support@asksage.ai.