Reports API

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

Method	HTTP request	Description
createReport	POST /reports	Create Report
deleteReport	DELETE /reports/	Delete Report
generateFullReport	POST /reports/{report_id}/generate	Generate Full Report
generateTocEndpoint	POST /reports/{report_id}/generate-toc	Generate Toc Endpoint
getReport	GET /reports/	Get Report
getReportPdf	GET /reports/{report_id}/pdf	Get Report Pdf
listReports	GET /reports	List Reports
updateReport	PATCH /reports/	Update Report

createReport

StandaloneReport createReport(standaloneReportCreate)

Create a new standalone report from studies and automatically start TOC generation.

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiCreateReportRequest } from '';

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

const request: ReportsApiCreateReportRequest = {
  
  standaloneReportCreate: {
    projectId: "projectId_example",
    studyIds: [
      "studyIds_example",
    ],
    tableOfContents: [
      {
        title: "title_example",
        description: "description_example",
        subsections: null,
      },
    ],
    focus: "focus_example",
  },
};

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

Parameters

Name	Type	Description	Notes
standaloneReportCreate	StandaloneReportCreate

Return type

StandaloneReport

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]

deleteReport

void deleteReport()

Delete a standalone report.

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiDeleteReportRequest } from '';

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

const request: ReportsApiDeleteReportRequest = {
  
  reportId: "report_id_example",
};

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

Parameters

Name	Type	Description	Notes
reportId	[string]		defaults to undefined

Return type

void

Authorization

HTTPBearer

HTTP request headers

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

HTTP response details

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

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

generateFullReport

StandaloneReport generateFullReport()

Start full report generation (requires TOC to be present).

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiGenerateFullReportRequest } from '';

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

const request: ReportsApiGenerateFullReportRequest = {
  
  reportId: "report_id_example",
};

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

Parameters

Name	Type	Description	Notes
reportId	[string]		defaults to undefined

Return type

StandaloneReport

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]

generateTocEndpoint

StandaloneReport generateTocEndpoint()

Generate table of contents for a standalone report using LLM (async). Args: report_id: The ID of the report request_body: Optional request body with focus parameter

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiGenerateTocEndpointRequest } from '';

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

const request: ReportsApiGenerateTocEndpointRequest = {
  
  reportId: "report_id_example",
  
  generateTOCRequest: {
    focus: "focus_example",
  },
};

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

Parameters

Name	Type	Description	Notes
generateTOCRequest	GenerateTOCRequest
reportId	[string]		defaults to undefined

Return type

StandaloneReport

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]

getReport

StandaloneReport getReport()

Get a specific standalone report.

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiGetReportRequest } from '';

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

const request: ReportsApiGetReportRequest = {
  
  reportId: "report_id_example",
};

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

Parameters

Name	Type	Description	Notes
reportId	[string]		defaults to undefined

Return type

StandaloneReport

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]

getReportPdf

HttpFile getReportPdf()

Download standalone report as PDF.

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiGetReportPdfRequest } from '';

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

const request: ReportsApiGetReportPdfRequest = {
  
  reportId: "report_id_example",
};

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

Parameters

Name	Type	Description	Notes
reportId	[string]		defaults to undefined

Return type

HttpFile

Authorization

HTTPBearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns the PDF report	-
404	Report not found	-
500	Error generating report	-
422	Validation Error	-

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

listReports

PageStandaloneReport listReports()

List standalone reports (report_mode='standalone' only).

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiListReportsRequest } from '';

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

const request: ReportsApiListReportsRequest = {
    // Project ID filter (optional)
  projectId: "projectId_example",
    // Report type: standard or multiconcept (optional)
  reportType: "reportType_example",
    // Status filter (optional)
  status: "status_example",
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

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

Parameters

Name	Type	Description	Notes
projectId	[string]	Project ID filter	(optional) defaults to undefined
reportType	[string]	Report type: standard or multiconcept	(optional) defaults to undefined
status	[string]	Status filter	(optional) defaults to undefined
page	[number]	Page number	(optional) defaults to 1
size	[number]	Page size	(optional) defaults to 50

Return type

PageStandaloneReport

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]

updateReport

StandaloneReport updateReport()

Update a standalone report (e.g., table_of_contents, focus).

Example

import { createConfiguration, ReportsApi } from '';
import type { ReportsApiUpdateReportRequest } from '';

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

const request: ReportsApiUpdateReportRequest = {
  
  reportId: "report_id_example",
  
  standaloneReportUpdate: {
    tableOfContents: [
      {
        title: "title_example",
        description: "description_example",
        subsections: null,
      },
    ],
    focus: "focus_example",
  },
};

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

Parameters

Name	Type	Description	Notes
standaloneReportUpdate	StandaloneReportUpdate
reportId	[string]		defaults to undefined

Return type

StandaloneReport

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]