Summaries API

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

Method	HTTP request	Description
exportSummary	GET /summaries/{summary_id}/export	Export Summary
getSummary	GET /summaries/	Get Summary
listSummaries	GET /summaries	List Summaries
summaryFollowUp	POST /summaries/{summary_id}/follow_up	Summary Follow Up

exportSummary

any exportSummary()

Export a summary with all related inputs and user interviews Args: summary_id: The ID of the summary file_extension: The extension of the exported file Returns: FileResponse with the exported file Raises: HTTPException: If summary not found or error during export

Example

import { createConfiguration, SummariesApi } from '';
import type { SummariesApiExportSummaryRequest } from '';

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

const request: SummariesApiExportSummaryRequest = {
  
  summaryId: "summary_id_example",
    // File extension to export (optional)
  fileExtension: "txt",
};

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

Parameters

Name	Type	Description	Notes
summaryId	[string]		defaults to undefined
fileExtension	[string]	File extension to export	(optional) defaults to 'txt'

Return type

any

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]

getSummary

Summary getSummary()

Example

import { createConfiguration, SummariesApi } from '';
import type { SummariesApiGetSummaryRequest } from '';

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

const request: SummariesApiGetSummaryRequest = {
  
  summaryId: "summary_id_example",
};

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

Parameters

Name	Type	Description	Notes
summaryId	[string]		defaults to undefined

Return type

Summary

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]

listSummaries

PageSummary listSummaries()

Example

import { createConfiguration, SummariesApi } from '';
import type { SummariesApiListSummariesRequest } from '';

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

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

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

Parameters

Name	Type	Description	Notes
id	[string]	Comma-separated list of studies IDs	(optional) defaults to undefined
projectId	[string]	Comma-separated list of project IDs	(optional) defaults to undefined
studyId	[string]	Comma-separated list of audiences 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

PageSummary

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]

summaryFollowUp

SummaryMessage summaryFollowUp(summaryMessageCreate)

Example

import { createConfiguration, SummariesApi } from '';
import type { SummariesApiSummaryFollowUpRequest } from '';

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

const request: SummariesApiSummaryFollowUpRequest = {
  
  summaryId: "summary_id_example",
  
  summaryMessageCreate: {
    message: "message_example",
  },
};

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

Parameters

Name	Type	Description	Notes
summaryMessageCreate	SummaryMessageCreate
summaryId	[string]		defaults to undefined

Return type

SummaryMessage

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]