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

curl --request POST \
  --url https://api-trial.cognigy.ai/testing/v1/transcript-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "success": true,
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresAt": "2026-02-08T15:00:00.000Z",
  "maxFiles": 5,
  "maxFileSize": 10485760,
  "maxTotalSize": 52428800,
  "supportedFormats": [
    "application/pdf",
    "text/csv",
    "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
  ],
  "status": "pending"
}

{
  "error": "projectId is required (in body, query, or as projectReference)"
}

{
  "error": "Maximum of 10 active transcript requests reached for this project."
}

Authorizations

Authorization

string

header

required

JWT Bearer Token for authentication

Headers

project_id

string

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

Query Parameters

projectId

string

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

Body

application/json

projectId

string

Project identifier (alternative to project_id header)

projectReference

string

Alternative project reference

Response

Transcript request created successfully

success

boolean

required

requestId

string

required

Unique request identifier for subsequent calls

expiresAt

string<date-time>

required

When this request will expire

maxFiles

integer

required

Maximum number of files that can be uploaded

maxFileSize

integer

required

Maximum file size in bytes

supportedFormats

string[]

required

Supported file formats

status

enum<string>

required

Request status

Available options:

pending

maxTotalSize

integer

Maximum total upload size in bytes

Last modified on July 2, 2026

Upload and parse a transcript fileUpload a single transcript file for parsing and content extraction. This is the second step in the three-step workflow. The file is streamed directly to Redis via the streamUpload middleware, then: 1. Read back from Redis 2. Parsed based on file type (PDF, CSV, DOCX) 3. Analyzed for speaker labels (Agent/Customer) 4. Stored as structured data in Redis (keyed by requestId) Multiple files can be uploaded by calling this endpoint multiple times with the same requestId. The generate endpoint retrieves all files for the request by requestId.

curl --request POST \
  --url https://api-trial.cognigy.ai/testing/v1/transcript-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "success": true,
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresAt": "2026-02-08T15:00:00.000Z",
  "maxFiles": 5,
  "maxFileSize": 10485760,
  "maxTotalSize": 52428800,
  "supportedFormats": [
    "application/pdf",
    "text/csv",
    "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
  ],
  "status": "pending"
}

{
  "error": "projectId is required (in body, query, or as projectReference)"
}

{
  "error": "Maximum of 10 active transcript requests reached for this project."
}