v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Transcript Scenario Generation

Create transcript upload request

Create a new transcript upload session. This is the first step in the three-step workflow for generating scenarios from transcript files.

This endpoint:

  • Creates a new request with a unique ID
  • Checks rate limits per project (max active requests)
  • Returns configuration details (max files, max file size, supported formats)

The returned requestId must be passed in subsequent upload and generation calls.

projectId is required. Provide it via the project_id header, or in the request body/query.

post/v1/transcript-request

Query parameters

projectIdstring

Project identifier (alternative to project_id header or projectReference in body)

Headers

project_idstring

Project identifier. Use this header to pass projectId; alternatively use body or query.

Request body

projectIdstring

Project identifier (alternative to project_id header)

projectReferencestring

Alternative project reference

Response

Transcript request created successfully

successboolean required
requestIdstring required

Unique request identifier for subsequent calls

expiresAtstring date-time required

When this request will expire

maxFilesinteger required

Maximum number of files that can be uploaded

maxFileSizeinteger required

Maximum file size in bytes

maxTotalSizeinteger

Maximum total upload size in bytes

supportedFormatsstring[] required

Supported file formats

status'pending' required

Request status