---
title: "Create a session"
method: POST
path: "/v1/sessions"
---

# Create a session

`POST /v1/sessions`

## Request

- Base URL: `https://api.condens.io`
- URL: `https://api.condens.io/v1/sessions`
- Auth: HTTP bearer

## Request body

- CreateSession
  - `name` string, required
  - `projectId` string, required
  - `informationFields` InformationField[]
    - union
      - TextInformationField
        - `fieldName` string, required
        - `fieldType` 'text', required
        - `value` string, required
      - NumberInformationField
        - `fieldName` string, required
        - `fieldType` 'number', required
        - `value` integer, required
      - DateInformationField
        - `fieldName` string, required
        - `fieldType` 'date', required
        - `value` string, date, required
      - CheckboxInformationField
        - `fieldName` string, required
        - `fieldType` 'checkbox', required
        - `value` boolean, required
      - SingleSelectInformationField
        - `fieldName` string, required
        - `fieldType` 'single_select', required
        - `value` string, required
      - MultiSelectInformationField
        - `fieldName` string, required
        - `fieldType` 'multi_select', required
        - `value` string[], required
      - ParticipantsInformationField
        - `fieldName` string, required
        - `fieldType` 'participant', required
        - `value` union[], required
          - union
            - object
              - …
            - object
              - …
      - UserInformationField
        - `fieldName` string, required
        - `fieldType` 'user', required
        - `value` union[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
      - UrlInformationField
        - `fieldName` string, required
        - `fieldType` 'url', required
        - `value` string, uri, required
      - EmailInformationField
        - `fieldName` string, required
        - `fieldType` 'email', required
        - `value` string, email, required
      - NpsInformationField
        - `fieldName` string, required
        - `fieldType` 'nps', required
        - `value` integer, required
  - `media` SessionMedia
    - `name` string
    - `sourceUrl` string, uri, required: URL of the source to be fetched. Must be accessible from the internet.
    - `sourceAuth` union
      - object
        - `type` 'bearer', required
        - `token` string, required: Bearer token to be sent as 'Authorization: Bearer <token>'
      - object
        - `type` 'apiKey', required
        - `key` string, required: API key to be sent as 'x-api-key: <key>'
    - `transcription` object
      - `languages` LanguageCode[], required: When setting multiple languages for transcription, please refer the transcription settings in Condens to learn which languages support them.
        - union: BCP-47 language/locale code for transcription.
          - 'af-ZA'
          - 'sq-AL'
          - 'am-ET'
          - 'ar-EG'
          - 'ar-MA'
          - 'ar-SA'
          - 'hy-AM'
          - 'az-AZ'
          - 'eu-ES'
          - 'bn-IN'
          - 'bs-BA'
          - 'bg-BG'
          - 'my-MM'
          - 'ca-ES'
          - 'zh-CN'
          - 'zh-HK'
          - 'zh-TW'
          - 'yue-CN'
          - 'hr-HR'
          - 'cs-CZ'
          - 'da-DK'
          - 'nl-NL'
          - 'nl-BE'
          - 'en-US'
          - 'en-GB'
          - 'en-AU'
          - 'en-IN'
          - 'en-NG'
          - 'en-KE'
          - 'en-ZA'
          - 'et-EE'
          - 'fil-PH'
          - 'fi-FI'
          - 'fr-FR'
          - 'fr-BE'
          - 'fr-CA'
          - 'gl-ES'
          - 'ka-GE'
          - 'de-DE'
          - 'de-AT'
          - 'de-CH'
          - 'el-GR'
          - 'gu-IN'
          - 'he-IL'
          - 'hi-IN'
          - 'hu-HU'
          - 'is-IS'
          - 'id-ID'
          - 'ga-IE'
          - 'it-IT'
          - 'ja-JP'
          - 'jv-ID'
          - 'kn-IN'
          - 'kk-KZ'
          - 'km-KH'
          - 'ko-KR'
          - 'lo-LA'
          - 'lv-LV'
          - 'lt-LT'
          - 'mk-MK'
          - 'ms-MY'
          - 'ml-IN'
          - 'mt-MT'
          - 'mr-IN'
          - 'mn-MN'
          - 'ne-NP'
          - 'nb-NO'
          - 'ps-AF'
          - 'fa-IR'
          - 'pl-PL'
          - 'pt-BR'
          - 'pt-PT'
          - 'pa-IN'
          - 'ro-RO'
          - 'ru-RU'
          - 'sr-RS'
          - 'si-LK'
          - 'sk-SK'
          - 'sl-SI'
          - 'so-SO'
          - 'es-MX'
          - 'es-ES'
          - 'sw-KE'
          - 'sv-SE'
          - 'ta-IN'
          - 'te-IN'
          - 'th-TH'
          - 'tr-TR'
          - 'uk-UA'
          - 'ur-IN'
          - 'uz-UZ'
          - 'vi-VN'
          - 'cy-GB'
          - 'zu-ZA'
      - `numberOfSpeakers` integer: If unspecified, number of speakers will be automatically detected.
      - `generateBookmarks` boolean
    - `anonymization` object
      - `blurMode` 'faces' | 'names' | 'faces_and_names' | 'video'
      - `anonymizeAudio` boolean
  - `note` SessionNote
    - `name` string
    - `content` string, required
    - `type` 'plain' | 'markdown' | 'html'
  - `attachments` object[]
    - `sourceUrl` string, uri, required: URL of the source to be fetched. Must be accessible from the internet.
    - `sourceAuth` union
      - object
        - `type` 'bearer', required
        - `token` string, required: Bearer token to be sent as 'Authorization: Bearer <token>'
      - object
        - `type` 'apiKey', required
        - `key` string, required: API key to be sent as 'x-api-key: <key>'
    - `name` string

## Response `201`

Created session

- SessionItem
  - `id` string, required
  - `name` string, required
  - `projectId` string, required
  - `workspaceId` string, required
  - `processed` boolean, required
  - `informationFields` InformationField[], required
    - union
      - TextInformationField
        - `fieldName` string, required
        - `fieldType` 'text', required
        - `value` string, required
      - NumberInformationField
        - `fieldName` string, required
        - `fieldType` 'number', required
        - `value` integer, required
      - DateInformationField
        - `fieldName` string, required
        - `fieldType` 'date', required
        - `value` string, date, required
      - CheckboxInformationField
        - `fieldName` string, required
        - `fieldType` 'checkbox', required
        - `value` boolean, required
      - SingleSelectInformationField
        - `fieldName` string, required
        - `fieldType` 'single_select', required
        - `value` string, required
      - MultiSelectInformationField
        - `fieldName` string, required
        - `fieldType` 'multi_select', required
        - `value` string[], required
      - ParticipantsInformationField
        - `fieldName` string, required
        - `fieldType` 'participant', required
        - `value` union[], required
          - union
            - object
              - …
            - object
              - …
      - UserInformationField
        - `fieldName` string, required
        - `fieldType` 'user', required
        - `value` union[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
      - UrlInformationField
        - `fieldName` string, required
        - `fieldType` 'url', required
        - `value` string, uri, required
      - EmailInformationField
        - `fieldName` string, required
        - `fieldType` 'email', required
        - `value` string, email, required
      - NpsInformationField
        - `fieldName` string, required
        - `fieldType` 'nps', required
        - `value` integer, required
  - `attachments` object[], required
    - `name` string, required
  - `updatedAt` string, date-time, required: ISO-8601 timestamp of last update
  - `failedUploadUrls` string[]: URLs of files that failed to upload. Only present if one or more uploads failed.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/condens/apis/condens-api.md) · [All operations](https://skmtc.dev/condens/apis/condens-api/llms.txt) · [OpenAPI document](https://skmtc.dev/condens/apis/condens-api/revisions/7b93612e150f?raw)