Assistant Sessions API

All URIs are relative to https://api.syntheticusers.com/api/v1

Method	HTTP request	Description
chat	POST /assistants/{assistant_session_id}/chat	Chat
createAssistant	POST /assistants	Create Assistant
getAssistantSession	GET /assistants/	Get Assistant Session
listAssistantSessions	GET /assistants	List Assistant Sessions

chat

AssistantSession chat(assistantChat)

Example

import { createConfiguration, AssistantSessionsApi } from '';
import type { AssistantSessionsApiChatRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AssistantSessionsApi(configuration);

const request: AssistantSessionsApiChatRequest = {
  
  assistantSessionId: "assistant_session_id_example",
  
  assistantChat: {
    message: "message_example",
    lock: true,
    studyType: "studyType_example",
  },
};

const data = await apiInstance.chat(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
assistantChat	AssistantChat
assistantSessionId	[string]		defaults to undefined

Return type

AssistantSession

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

createAssistant

AssistantSession createAssistant(assistantSessionCreate)

Example

import { createConfiguration, AssistantSessionsApi } from '';
import type { AssistantSessionsApiCreateAssistantRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AssistantSessionsApi(configuration);

const request: AssistantSessionsApiCreateAssistantRequest = {
  
  assistantSessionCreate: {
    projectId: "projectId_example",
  },
};

const data = await apiInstance.createAssistant(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
assistantSessionCreate	AssistantSessionCreate

Return type

AssistantSession

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

getAssistantSession

AssistantSession getAssistantSession()

Example

import { createConfiguration, AssistantSessionsApi } from '';
import type { AssistantSessionsApiGetAssistantSessionRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AssistantSessionsApi(configuration);

const request: AssistantSessionsApiGetAssistantSessionRequest = {
  
  assistantSessionId: "assistant_session_id_example",
};

const data = await apiInstance.getAssistantSession(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
assistantSessionId	[string]		defaults to undefined

Return type

AssistantSession

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

listAssistantSessions

PageAssistantSession listAssistantSessions()

Example

import { createConfiguration, AssistantSessionsApi } from '';
import type { AssistantSessionsApiListAssistantSessionsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AssistantSessionsApi(configuration);

const request: AssistantSessionsApiListAssistantSessionsRequest = {
    // Comma-separated list of asssitant sessions IDs (optional)
  id: "id_example",
    // Comma-separated list of project IDs (optional)
  projectId: "projectId_example",
    // Status to filter by (optional)
  status: "status_example",
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

const data = await apiInstance.listAssistantSessions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
id	[string]	Comma-separated list of asssitant sessions IDs	(optional) defaults to undefined
projectId	[string]	Comma-separated list of project IDs	(optional) defaults to undefined
status	[string]	Status to filter by	(optional) defaults to undefined
page	[number]	Page number	(optional) defaults to 1
size	[number]	Page size	(optional) defaults to 50

Return type

PageAssistantSession

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]