Type Alias ListTranscriptParams

ListTranscriptParams: {
    after_id?: string;
    before_id?: string;
    created_on?: string;
    limit?: number;
    status?: TranscriptStatus;
    throttled_only?: boolean;
}

Type declaration

  • Optionalafter_id?: string

    Get transcripts that were created after this transcript ID

  • Optionalbefore_id?: string

    Get transcripts that were created before this transcript ID

  • Optionalcreated_on?: string

    Only get transcripts created on this date

  • Optionallimit?: number

    Maximum amount of transcripts to retrieve

    Default Value

    10
  • Optionalstatus?: TranscriptStatus

    Filter by transcript status

  • Optionalthrottled_only?: boolean

    Only get throttled transcripts, overrides the status filter

    Default Value

    false

Example

{
  "after_id": "a7c5cafd-2c2e-4bdd-b0b2-69dade2f7a1b",
  "before_id": "9ea68fd3-f953-42c1-9742-976c447fb463",
  "created_on": "2023-11-03",
  "limit": 2,
  "status": "completed",
  "throttled_only": false
}

Settings

Member Visibility