Script Generation API

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

Method	HTTP request	Description
generateInterviewScript	POST /scriptGeneration/generate	Generate Interview Script Suggestion

generateInterviewScript

ScriptGenerationOutput generateInterviewScript(scriptGenerationRequest)

Generates a suggested list of open-ended interview questions based on audience, concepts, and optional topics for Multi-Concept studies.

Example

import { createConfiguration, ScriptGenerationApi } from '';
import type { ScriptGenerationApiGenerateInterviewScriptRequest } from '';

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

const request: ScriptGenerationApiGenerateInterviewScriptRequest = {
  
  scriptGenerationRequest: {
    audienceDescription: "audienceDescription_example",
    concepts: [
      {
        title: "title_example",
        description: "description_example",
      },
    ],
    topics: [
      "topics_example",
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
scriptGenerationRequest	ScriptGenerationRequest

Return type

ScriptGenerationOutput

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]