User Parameters and Responses

In this section will cover the User Base URL and the associated endpoints in the Ask Sage API, including the parameters and responses for each endpoint.

Table of contents

1. User API Endpoints:
   1. Get Access Token
   2. Get User Logs
   3. Get User Logins
   4. Add Dataset
   5. Delete Dataset
   6. Train Model

User API Endpoints:

The User API is used for managing users, authentication, and datasets. We have the following Swagger documentation for the User API:

• The Base URL for the User API is: [ Base URL: api.asksage.ai/user/ ]

Make sure to use the correct Base URL associated with your tenant.

Users can use the Static API key Generated in the Ask Sage Platform as the required token for authentication. However, there is no expiration on the API key, while if you generate a token it is valid for 24 hours.
"x-access-tokens": "your_access_token_here"
"x-access-tokens": "api-key"

The following table shows the available endpoints in the User API:

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-dataset	Deletes a dataset

---

Get Access Token

POST https://api.asksage.ai/user/get-token-with-api-key

A user with an API key and email can obtain an access token.

Request body

---

email string Required

The user's email address.

---

api_key string Required

The user's API key.

---

Returns

On success (HTTP 200):

response object Contains:

- access_token string

The access token for the user, which is only valid for 24 hours.

- status integer

The status code of the response.

---

On error (HTTP 400):

- response string

An error message describing the issue.

- status integer

The status code of the response.

Bash Python JavaScript

        
curl -X 'POST' \
  'https://api.asksage.ai/user/get-token-with-api-key' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "your_email@email.com",
  "api_key": "your_api_key"
}'
        
        import requests

url = 'https://api.asksage.ai/user/get-token-with-api-key'
headers = {
    'accept': 'application/json',
    'Content-Type': 'application/json'
}
data = {
    'email': 'your_email@email.com',
    'api_key': 'your_api_key'
}

response = requests.post(url, headers=headers, json=data)

print(response.json())
        
        
import fetch from 'node-fetch';

fetch('https://api.asksage.ai/user/get-token-with-api-key', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'your_email@email.com',
    api_key: 'your_api_key'
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
        
      

---

Get User Logs

POST https://api.asksage.ai/user/get-user-logs

Get the latest prompts of the user.

Request body

---

x-access-tokens string Required

The 24-hour Token or API Key used for authentication.

---

Returns

On success (HTTP 200):

response array Contains objects with:

- date_time string

The date and time of the prompt.

- prompt string

The user's prompt.

- completion string

The completion of the prompt.

- IP string

The IP address from which the prompt was made.

---

On error (HTTP 400):

- response string

An error message describing the issue.

- status integer

The status code of the response.

Bash Python JavaScript

        
curl -X POST https://api.asksage.ai/user/get-user-logs \
-H "x-access-tokens: your_access_token_here" \
-H 'Content-Type: application/json'
        
        import requests

def get_user_log(access_token):
    url = "https://api.asksage.ai/user/get-user-logs"
    headers = {
        "x-access-tokens": access_token,
        "Content-Type": "application/json"
    }

    # Create the body
    body = {}

    response = requests.post(url, headers=headers, json=body)  # Use json= to send JSON body

    # Check if the request was successful
    if response.status_code == 200:
        data = response.json()
        print("Success:", data)  # Response is a JSON object
    elif response.status_code == 400:
        error_data = response.json()
        print("Error:", error_data.get("response", "Missing required fields or invalid input."))
    else:
        print("Error:", response.text)

    # Example usage
access_token = "Your_Access_Token"
get_user_log(access_token)  # Call the function 
        
        import fetch from 'node-fetch';

const url = 'https://api.asksage.ai/user/get-user-logs';
const accessToken = 'your_access_token_here'; // Replace with your actual access token

const body = JSON.stringify({}); // Create an empty body

fetch(url, {
    method: 'POST',
    headers: {
        'x-access-tokens': accessToken,
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    },
    body: body
})
.then(response => {
    if (!response.ok) {
        throw new Error('Network response was not ok: ' + response.statusText);
    }
    return response.json();
})
.then(data => console.log("Success:", data))
.catch(error => console.error('Error:', error));
        
      

---

Get User Logins

POST https://api.asksage.ai/user/get-user-logins

Get the latest logins of the user.

Request body

---

limit integer Optional

The maximum number of user logins to retrieve. Must be between 0 and 101.

---

x-access-tokens string Required

The 24-hour Token or API Key used for authentication.

---

Returns

On success (HTTP 200):

response array Contains objects with:

- date_time string

The date and time of the login.

- IP string

The IP address from which the login was made.

---

On error (HTTP 400):

- response string

An error message describing the issue.

- status integer

The status code of the response.

Bash Python JavaScript

        
curl -X POST "https://api.asksage.ai/user/get-user-logins" \
-H "x-access-tokens: your_access_token_here" \
-H "Content-Type: application/json" \
-d '{"limit": 5}'
        
        import requests

def get_user_logins(access_token, limit=5):
    # Ensure limit is within the allowed range
    if not (1 <= limit <= 100):
        raise ValueError("Limit must be between 1 and 100.")

    url = "https://api.asksage.ai/user/get-user-logins"
    headers = {
        "x-access-tokens": access_token,
        "Content-Type": "application/json"
    }
    
    # Create the body with the limit parameter
    body = {
        "limit": limit
    }

    response = requests.post(url, headers=headers, json=body)  # Use json= to send JSON body

    # Check if the request was successful
    if response.status_code == 200:
        data = response.json()
        print("Success:", data) 
    elif response.status_code == 400:
        error_data = response.json()
        print("Error:", error_data.get("response", "Missing required fields or invalid input."))
    else:
        print("Error:", response.text)

    # Example usage
access_token = "Your_Access_Token"
get_user_logins(access_token, limit=5)  # Call the function with the desired limit
        
        import fetch from 'node-fetch';

const url = 'https://api.asksage.ai/user/get-user-logins';
const accessToken = 'your_access_token_here'; // Replace with your actual access token
const limit = 5; // Set your desired limit

// Ensure limit is within the allowed range
if (limit < 1 || limit > 100) {
    throw new Error("Limit must be between 1 and 100.");
}

const body = JSON.stringify({ limit });

fetch(url, {
    method: 'POST',
    headers: {
        'x-access-tokens': accessToken,
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    },
    body: body
})
.then(response => {
    if (!response.ok) {
        throw new Error('Network response was not ok: ' + response.statusText);
    }
    return response.json();
})
.then(data => console.log("Success:", data))
.catch(error => console.error('Error:', error));
        
      

---

Add Dataset

POST https://api.asksage.ai/user/add-dataset

Add a new dataset to the user’s account.

If your content is CUI, you must name your dataset with the prefix “CUI-“.

For dataset names, only alphanumeric characters allowed. NO spaces!

Request body

---

dataset string Required

The name of the dataset.

---

x-access-tokens string Required

The 24-hour Token or API Key used for authentication.

---

Returns

On success (HTTP 200):

response object Contains:

- response string

Message indicating that the dataset was added successfully.

- status integer

The status code of the response.

---

On error (HTTP 400):

- response string

An error message indicating missing required fields or invalid input.

- status integer

The status code of the response.

---

On error (HTTP 406):

- response string

An error message indicating that the dataset name is too long.

- status integer

The status code of the response.

---

On error (HTTP 407):

- response string

An error message indicating that a CAC is required for adding the dataset.

- status integer

The status code of the response.

Bash Python JavaScript

        
curl -X POST "https://api.asksage.ai/user/add-dataset" \    
-H "x-access-tokens: your_access_token_here" \
-H "Content-Type: application/json" \
-d '{"dataset": "dataset-name"}'
        
        import requests

url = "https://api.asksage.ai/user/add-dataset"
headers = {
    "x-access-tokens": "your_access_token_here", # Replace with your access token
  "Content-Type": "application/json"
}
data = {
    "dataset": "dataset-name"  # Replace with your actual dataset name
}

response = requests.post(url, headers=headers, json=data)

if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Error:", response.json())
        
fetch('https://api.asksage.ai/user/add-dataset', {
  method: 'POST',
  headers: {
    'x-access-tokens': 'your_access_token_here', // Replace with your actual Access Token
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dataset: 'dataset-name'  // Replace with your actual dataset name
  })
})
.then(response => {
  if (!response.ok) {
    throw new Error('Network response was not ok: ' + response.statusText);
  }
  return response.json();
})
.then(data => console.log("Success:", data))
.catch(error => console.error('Error:', error));
        
      

---

Delete Dataset

POST https://api.asksage.ai/user/delete-dataset

Deletes dataset from the user’s account.

To get the full name of your dataset use the ‘get-models’ endpoint in the[ Base URL: api.asksage.ai/server/ ]

Request body

---

dataset string Required

Apply the full name of the dataset which is
defined as user_custom_USERID_DATASETNAME_content.

---

x-access-tokens string Required

The 24-hour Token or API Key used for authentication.

---

Returns

On success (HTTP 200):

response object Contains:

- response string

Message indicating that the dataset was deleted successfully.

- status integer

The status code of the response.

---

On error (HTTP 400):

- response string

An error message indicating missing required fields or invalid input.

- status integer

The status code of the response.

---

On error (HTTP 408):

- response string

An error message indicating that required information is missing.

- status integer

The status code of the response.

Bash Python JavaScript

        
curl -X POST "https://api.asksage.ai/user/delete-dataset" \
-H "x-access-tokens: your_access_token_here" \ # Make sure to replace 'your_access_token_here' with your actual access token.
-H "Content-Type: application/json" \
-d '{"dataset": "user_custom_USERID_DATASETNAME_content"}' # Update 'USERID' and 'DATASETNAME' in the dataset parameter with the appropriate values.
        
        import requests
import json

url = "https://api.asksage.ai/user/delete-dataset"
headers = {
    "x-access-tokens": "your_access_token_here", # Replace with your access token
    "Content-Type": "application/json"
}
data = {
    "dataset": "user_custom_USERID_DATASETNAME_content" # Replace USERID and DATASETNAME 
}

response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())
        
        fetch('https://api.asksage.ai/user/delete-dataset', {
    method: 'POST',
    headers: {
        'x-access-tokens': 'your_access_token_here', // Replace with your actual access token
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        dataset: 'user_custom_USERID_DATASETNAME_content' // Replace USERID and DATASETNAME
    })
})
.then(response => {
    if (!response.ok) {
        throw new Error('Network response was not ok: ' + response.statusText);
    }
    return response.json();
})
.then(data => console.log("Success:", data))
.catch(error => console.error('Error:', error));
        
      

---

Train Model

POST https://api.asksage.ai/user/train

Train the model based on the user’s input.

Request body

---

content object Required

The user's input content.

---

context string Optional

Short context (metadata) about the content.

---

summarize boolean Optional

Summarize the content.

---

summarize_model string Optional

Model to use for summarization.

---

force_dataset string Optional

Force a specific dataset.

---

x-access-tokens string Required

The 24-hour Token or API Key used for authentication.

---

Returns

On success (HTTP 200):

response object Contains:

- result string

The result of the training process.

- status integer

The status code of the response.

---

On error (HTTP 400):

- response string

An error message indicating missing required fields or invalid input.

- status integer

The status code of the response.

Bash Python JavaScript

        
curl -X POST "https://api.asksage.ai/user/train" \
-H "x-access-tokens: your_access_token_here" \
-H "Content-Type: application/json" \
-d '{
  "content": {
    "context": "Your context here",
    "content": "Your input content here"
  },
  "summarize": true,
  "summarize_model": "model_name",
  "force_dataset": "dataset_name"
}'
        
        import requests

url = "https://api.asksage.ai/user/train"
headers = {
    "x-access-tokens": "your_access_token_here", # Replace with your access token
    "Content-Type": "application/json"
}
data = {
    "content": {
        "context": "Your context here",
        "content": "Your input content here"
    },
    "summarize": True,
    "summarize_model": "model_name",
    "force_dataset": "dataset_name"
}

response = requests.post(url, headers=headers, json=data)

if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Error:", response.json())
        
        fetch('https://api.asksage.ai/user/train', {
    method: 'POST',
    headers: {
        'x-access-tokens': 'your_access_token_here', // Replace with your actual access token
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        content: {
            context: 'Your context here',
            content: 'Your input content here'
        },
        summarize: true,
        summarize_model: 'model_name',
        force_dataset: 'dataset_name'
    })
})
.then(response => {
    if (!response.ok) {
        throw new Error('Network response was not ok: ' + response.statusText);
    }
    return response.json();
})
.then(data => console.log("Success:", data))
.catch(error => console.error('Error:', error));