🔗Assisterr SLM Integration

The Assisterr SLM Integration allows users to interact with the Small Language Model (SLM) through a set of API endpoints.

You can check API documenation here.

Base URL

All requests should be made to the following base URL:

https://api.assisterr.ai/

Authentication

To authenticate API requests, you must include your API key in the X-Api-Key header for each request.

Endpoints

[POST] /api/v1/slm/{handle_name}/chat/

Description: Sends a query to SLM (Stateful Language Model) and retrieves a response without maintaining any session history.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the slm.

Request Body (JSON):

{
  "query": "Your query here"
}

[POST] /api/v1/slm/{handle_name}/chat/stream/

Description: Sends a query to SLM and retrieves a streaming response (via SSE), without maintaining any session history.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the slm.

Request Body (JSON):

{
  "query": "Your query here"
}

[POST] /api/v1/slm/{handle_name}/session/create/

Description: Creates a new session and returns a unique session ID for further interaction with SLM.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the slm.

Respponse Body (JSON):

"1234567891234"

[POST] /api/v1/slm/{handle_name}/session/{slm_session_id}/chat/

Description: Sends a query to SLM within a specific session, receiving a response while maintaining session history.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the slm.
slm_session_id	string	Yes	Unique session identifier.

Request Body (JSON):

{
  "query": "Your query here"
}

[POST] /api/v1/slm/{handle_name}/session/{slm_session_id}/chat/stream/

Description: Sends a query to SLM within a specific session and retrieves a streaming response (via SSE), while maintaining session history for context during the interaction.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the SLM.
slm_session_id	string	Yes	Unique session identifier.

Request Body (JSON):

{
  "query": "Your query here"
}

[GET] /api/v1/slm/{handle_name}/session/list/

Description: Retrieves a list of all active sessions associated with the given handle name.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the SLM.
slm_session_id	string	Yes	Unique session identifier.

[GET] /api/v1/slm/{handle_name}/session/{slm_session_id}/history/

Description: Retrieves the conversation history for a specific session, providing context for the ongoing interactions.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the SLM.
slm_session_id	string	Yes	Unique session identifier.

[DELETE] /api/v1/slm/{handle_name}/session/{slm_session_id}/

Description: Deletes an active session identified by the provided session ID, ending any ongoing session-interactions with SLM.

Headers:

Header	Required	Example Value	Description
X-Api-Key	Yes	your_token	API Key for authentication.

Path Parameters:

Parameter	Type	Required	Description
handle_name	string	Yes	Unique identifier for the SLM.
slm_session_id	string	Yes	Unique session identifier.

Example

To obtain your personal token, follow these steps:

1. Navigate to the AI Lab page:

   • Go to the AI Lab page.

2. Click on API button

   • Click on API Button to obtain your personal token

API Button

1. Copy your personal token by clicking copy button

Token

To obtain the handle_name, follow these steps:

1. Navigate to the SLM page:

   • Go to the SLM page.

2. Extract handle_name:

   • Inside the URL, you will find a parameter called handle_name.

Handle name

Send a query

Sends a question to Solana Assistant API to get a response.

Example curl

curl -X POST "https://api.assisterr.ai/api/v1/slm/solana_assistant/chat/" \
-H "X-Api-Key: <your-token>" \
-H "Content-Type: application/json" \
-d '{
  "query": "What is Solana?"
}'

Create a session

Starts a new session with the Solana Assistant API for tracking conversation.

Example curl

curl -X POST "https://api.assisterr.ai/api/v1/slm/solana_assistant/session/create/" \
-H "X-Api-Key: <your-token>" \
-H "Content-Type: application/json"

Send a query using sessions

Sends a query to an active session, maintaining conversation context.

Example curl

curl -X POST "https://api.assisterr.ai/api/v1/slm/solana_assistant/session/1234567891234/chat/" 
-H "X-Api-Key: <your-token>" 
-H "Content-Type: application/json" -d '{
  "query": "What is Solana?"
}'

Response

{
    "message":"Solana is a blockchain built for mass adoption. It's a high-performance network that is utilized for a range of use cases, including finance, NFTs, payments, and gaming. Solana operates as a single global state machine and is open, interoperable and decentralized.\n\nYou can learn more about Solana from the official Solana documentation: https://docs.solana.com/",
    "message_at":"2024-12-11T19:01:16.972013",
    "is_user":false
}

Example curl

curl -X POST "https://api.assisterr.ai/api/v1/slm/solana_assistant/session/1234567891234/chat/" 
-H "X-Api-Key: <your-token>" 
-H "Content-Type: application/json" -d '{
  "query": "What was my first question?"
}'

Response

{
    "message":"Your first question was \"What is Solana?\"",
    "message_at":"2024-12-11T19:02:18.205151",
    "is_user":false
}

Retrieve list of sessions

Fetches all active sessions for the Solana Assistant.

Example curl

curl -X GET "https://api.assisterr.ai/api/v1/slm/solana_assistant/session/list/" 
-H "X-Api-Key: <your-token>" 
-H "Content-Type: application/json"

Response

[
    {
        "_id":"session_id",
        "slm_agent_id":"slm_agent_id",
        "uid":"uid",
        "description":"What is Solana?",
        "is_deleted":false,
        "created_at":"2024-12-11T19:00:52.124000",
        "updated_at":"2024-12-11T19:02:18.192000"
    },
    {
        "_id":"session_id",
        "slm_agent_id":"slm_agent_id",
        "uid":"uid",
        "description":"What is Solana?",
        "is_deleted":false,
        "created_at":"2024-12-11T18:32:31.929000",
        "updated_at":"2024-12-11T18:45:03.513000"
    }
]

Retrieve history

Retrieves the history of interactions for a specific session.

Example curl

curl -X GET "https://api.assisterr.ai/api/v1/slm/solana_assistant/session/1234567891234/history/" 
-H "X-Api-Key: <your-token>" 
-H "Content-Type: application/json"

Response

[
    {
        "_id":"message_id",
        "slm_agent_id":"slm_agent_id",
        "uid":"user_id",
        "is_user":false,
        "slm_session_id":"slm_session_id",
        "ident":"private_api",
        "source":"web",
        "query":"Your first question was \"What is Solana?\"",
        "created_at":"2024-12-11T19:02:18.198000"
    },
    {
        "_id":"message_id",
        "slm_agent_id":"slm_agent_id",
        "uid":"user_id",
        "is_user":true,
        "slm_session_id":"slm_session_id",
        "ident":"public_api",
        "source":"web",
        "query":"What was my first question?",
        "created_at":"2024-12-11T19:02:18.185000"
    },
    {
        "_id":"message_id",
        "slm_agent_id":"slm_agent_id",
        "uid":"user_id",
        "is_user":false,
        "slm_session_id":"slm_session_id",
        "ident":"private_api",
        "source":"web",
        "query":"Solana is a blockchain built for mass adoption. It's a high-performance network that is utilized for a range of use cases, including finance, NFTs, payments, and gaming. Solana operates as a single global state machine and is open, interoperable and decentralized.\n\nYou can learn more about Solana from the official Solana documentation: https://docs.solana.com/",
        "created_at":"2024-12-11T19:01:16.967000"
    },
    {
        "_id":"message_id",
        "slm_agent_id":"slm_agent_id",
        "uid":"user_id",
        "is_user":true,
        "slm_session_id":"slm_session_id",
        "ident":"public_api",
        "source":"web",
        "query":"What is Solana?",
        "created_at":"2024-12-11T19:01:16.957000"
    }
]

Delete session

Deletes an existing session with the Solana Assistant API.

Example curl

curl -X DELETE "https://api.assisterr.ai/api/v1/slm/solana_assistant/session/1234567891234/" 
-H "X-Api-Key: <your-token>" 
-H "Content-Type: application/json"

Response

true

Conclusion

Assisterr SLM Integration makes it easy for developers to use the Small Language Model in their applications. With simple API endpoints for querying, session management, and streaming responses, it provides a powerful and straightforward way to enhance app functionality.