> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.




## OpenAPI

````yaml https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /v1/transcript-request
openapi: 3.0.0
info:
  title: SIMULATOR OPENAPI REST-ful-API Reference
  version: 2025.20.0
  description: >

    ### Introduction

    This is the [OpenAPI 3.0](https://swagger.io/specification/) documentation

    of the
    [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful
    SIMULATOR OPENAPI API.


    ### Cross-Origin Resource Sharing

    This API features Cross-Origin Resource Sharing (CORS) implemented in

    compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows

    cross-domain communication from the browser. All responses have a wildcard

    same-origin header which makes the API completely accessible.


    ### Authentication

    SIMULATOR OPENAPI offers following forms of authentication:

    - Bearer Token (JWT)

    - API Key


    ### Error Handling

    This API uses HTTP status codes equal or above 400 to indicate errors. Error

    details are generated in compliance with [RFC 7807 - "Problem Details for
    HTTP APIs"](https://tools.ietf.org/html/rfc7807).


    Every error response contains a traceId, which should be provided to the
    SIMULATOR OPENAPI Technical Support when reporting an error.
  contact:
    name: Cognigy Technical Support
    url: https://www.cognigy.com
    email: support@cognigy.com
  license:
    name: Cognigy Proprietary License
servers:
  - url: https://api-trial.cognigy.ai/testing
    description: Cognigy Service Testing API
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Simulations
    description: >-
      Simulation management operations - Create, read, update, and delete
      simulations
externalDocs:
  description: SIMULATOR OPENAPI Documentation
  url: https://docs.cognigy.com/docs/service-testing/
paths:
  /v1/transcript-request:
    post:
      tags:
        - Transcript Scenario Generation
      summary: Create transcript upload request
      description: >
        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.
      operationId: createTranscriptRequest
      parameters:
        - name: project_id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Project identifier. Use this header to pass projectId; alternatively
            use body or query.
        - name: projectId
          in: query
          required: false
          schema:
            type: string
          description: >-
            Project identifier (alternative to project_id header or
            projectReference in body)
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  description: Project identifier (alternative to project_id header)
                projectReference:
                  type: string
                  description: Alternative project reference
            examples:
              basic:
                summary: Create transcript request (with header project_id)
                value: {}
              withBody:
                summary: Create transcript request with body projectId
                value:
                  projectId: 683ef2a378a878cc6550f78b
      responses:
        '201':
          description: Transcript request created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  requestId:
                    type: string
                    description: Unique request identifier for subsequent calls
                  expiresAt:
                    type: string
                    format: date-time
                    description: When this request will expire
                  maxFiles:
                    type: integer
                    description: Maximum number of files that can be uploaded
                  maxFileSize:
                    type: integer
                    description: Maximum file size in bytes
                  maxTotalSize:
                    type: integer
                    description: Maximum total upload size in bytes
                  supportedFormats:
                    type: array
                    items:
                      type: string
                    description: Supported file formats
                  status:
                    type: string
                    enum:
                      - pending
                    description: Request status
                required:
                  - success
                  - requestId
                  - expiresAt
                  - maxFiles
                  - maxFileSize
                  - supportedFormats
                  - status
              example:
                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
        '400':
          description: >-
            Bad Request - projectId is required (provide via project_id header,
            or in body/query)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: projectId is required (in body, query, or as projectReference)
        '401':
          description: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
              example:
                error: >-
                  Maximum of 10 active transcript requests reached for this
                  project.
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer Token for authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````