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

# Create a full-page meeting note

> Creates a full-page meeting note, or gets or creates the meeting note for a calendar event.

Creates a full-page meeting note and returns it in `meeting_note` as a [meeting notes block](https://developers.notion.com/reference/block.md#meeting-notes) with `is_full_page` set to `true`. To create AI meeting notes from an uploaded recording instead, use [Create a meeting note](https://developers.notion.com/reference/create-meeting-note.md).

| Body parameters | Behavior |
| - | - |
| `parent` | Creates the meeting note in the parent page or data source. In a data source that isn't a meetings database, Notion adds a page and puts the meeting note inside it. |
| No `parent` and no `calendar_event` | Creates the meeting note in the user's meeting notes database. Notion creates that database if the user doesn't have one. |
| `calendar_event` | Returns the event's existing meeting note, or creates one. Notion files and titles it like the event's other meeting notes. |

`markdown` sets the content of the meeting note's Notes tab. You can't pass `parent`, `title`, or `markdown` with `calendar_event`. The API can't add content to the meeting note after this call.

To find an event's IDs for `calendar_event`, see [Link a full-page meeting note to a calendar event](https://developers.notion.com/reference/update-meeting-note-page.md).

The response's `created` field is `true` when Notion created a new meeting note and `false` when it returned an existing one. Without `calendar_event`, every call creates a new meeting note.

When an event has a meeting note that the user can't read, Notion creates a new one. The event then has two meeting notes.

With `calendar_event`, the existing meeting note can be a meeting notes block inside a page, with `is_full_page` set to `false`.

### Workers

A [Notion Worker](https://developers.notion.com/workers/get-started/overview.md) calling this endpoint needs a connected calendar. It acts as itself: the parent must be shared with the Worker, and the Worker is recorded as the meeting note's creator. A Worker must pass `parent` and can't pass `calendar_event`. To link its meeting note to an event, call [Link a full-page meeting note to a calendar event](https://developers.notion.com/reference/update-meeting-note-page.md) next.

### Requirements

This endpoint accepts personal access tokens and Workers. The integration must have the **Read content** and **Insert content** capabilities. See the [capabilities guide](https://developers.notion.com/reference/capabilities.md).

### Errors

Returns a 400 HTTP response if the request combines `calendar_event` with `parent`, `title`, or `markdown`, or if a Worker passes `calendar_event` or omits `parent`. Also returns a 400 if a Worker has no working calendar connection.

Returns a 403 HTTP response if the token isn't a personal access token or a Worker, or if the user can't edit the parent.

Returns a 404 HTTP response if the parent doesn't exist or the integration can't access it.

Each Public API endpoint can return several possible error codes. See the [Error codes section](https://developers.notion.com/reference/status-codes.md#error-codes) for more information.


## OpenAPI

````yaml post /v1/meeting_notes
openapi: 3.1.0
info:
  title: Notion API
  version: 1.0.0
  termsOfService: >-
    https://notion.notion.site/Terms-and-Privacy-28ffdd083dc3473e9c2da6ec011b58ac
servers:
  - url: https://api.notion.com
security:
  - bearerAuth: []
tags:
  - name: Agent Skills
    description: Skill and plugin directory endpoints
  - name: Databases
    description: Database endpoints
  - name: Data sources
    description: Data source endpoints
  - name: Pages
    description: Page endpoints
  - name: Async tasks
    description: Async task endpoints
  - name: Blocks
    description: Block endpoints
  - name: Comments
    description: Comment endpoints
  - name: File uploads
    description: File upload endpoints
  - name: OAuth
    description: OAuth endpoints (basic authentication)
  - name: Users
    description: User endpoints
  - name: Search
    description: Search endpoints
  - name: Views
    description: View endpoints
  - name: Agents
    description: Agent endpoints
  - name: Sessions
    description: Session endpoints
  - name: Custom emojis
    description: Custom emoji endpoints
  - name: Meeting notes
    description: Meeting notes endpoints
paths:
  /v1/meeting_notes:
    post:
      tags:
        - Meeting notes
      summary: Create a full-page meeting note
      operationId: create-meeting-note-page
      parameters:
        - $ref: '#/components/parameters/notionVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                parent:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: page_id
                          description: Always `page_id`
                        page_id:
                          $ref: '#/components/schemas/idRequest'
                          description: ID of the parent page.
                      additionalProperties: false
                      required:
                        - type
                        - page_id
                    - type: object
                      properties:
                        type:
                          type: string
                          const: data_source_id
                          description: Always `data_source_id`
                        data_source_id:
                          $ref: '#/components/schemas/idRequest'
                          description: ID of the parent data source.
                      additionalProperties: false
                      required:
                        - type
                        - data_source_id
                  description: >-
                    Page or data source to create the meeting note in. Defaults
                    to the user's meeting notes database, which is created if
                    they don't have one. Not accepted with calendar_event.
                title:
                  type: string
                  maxLength: 2000
                  description: >-
                    Title for the meeting note. Not accepted with
                    calendar_event.
                markdown:
                  type: string
                  description: >-
                    Content for the meeting note's Notes tab, as Markdown. Not
                    accepted with calendar_event.
                calendar_event:
                  type: object
                  properties:
                    calendar:
                      type: object
                      properties:
                        account_id:
                          type: string
                          minLength: 1
                          description: ID of the calendar account.
                        calendar_id:
                          type: string
                          minLength: 1
                          description: ID of the calendar.
                      additionalProperties: false
                      required:
                        - account_id
                        - calendar_id
                      description: The calendar the event belongs to.
                    event_id:
                      type: string
                      minLength: 1
                      description: >-
                        ID of the event, as returned in eventId by Notion MCP's
                        notion-calendar-list-events.
                  additionalProperties: false
                  required:
                    - calendar
                    - event_id
                  description: >-
                    Calendar event to get or create the meeting note for. The
                    meeting note is filed and titled like the event's other
                    meeting notes. Add content to it afterwards.
                markdown_version:
                  description: >-
                    The Markdown syntax to use. `v2` is [Notion-flavored
                    Markdown](/guides/data-apis/notion-flavored-markdown) and is
                    recommended. `v1` is enhanced markdown. It's deprecated.
                    It's the default on current Notion-Versions. The next
                    Notion-Version rejects `v1` with a `400` `validation_error`.
                  type: string
                  enum:
                    - v1
                    - v2
              additionalProperties: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    const: meeting_note_page_result
                    description: Always "meeting_note_page_result".
                  meeting_note:
                    type: object
                    properties:
                      object:
                        type: string
                        const: block
                        description: Always "block".
                      id:
                        $ref: '#/components/schemas/idResponse'
                        description: The ID of the meeting note block.
                      type:
                        type: string
                        const: meeting_notes
                        description: Always "meeting_notes".
                      meeting_notes:
                        type: object
                        properties:
                          is_full_page:
                            type: boolean
                            description: Whether this is a full-page meeting note.
                          title:
                            type: array
                            items:
                              $ref: '#/components/schemas/richTextItemResponse'
                            maxItems: 100
                            description: Title of the meeting note as rich text.
                          status:
                            type: string
                            enum:
                              - transcription_not_started
                              - transcription_paused
                              - transcription_in_progress
                              - transcription_failed
                              - summary_in_progress
                              - notes_ready
                            description: >-
                              Current processing status of the meeting note
                              transcription.
                          children:
                            type: object
                            properties:
                              summary_block_id:
                                $ref: '#/components/schemas/idResponse'
                                description: Block ID of the AI summary tab.
                              notes_block_id:
                                $ref: '#/components/schemas/idResponse'
                                description: Block ID of the meeting notes tab.
                              transcript_block_id:
                                $ref: '#/components/schemas/idResponse'
                                description: Block ID of the transcript tab.
                            additionalProperties: false
                            description: >-
                              Block IDs for each tab (summary, notes,
                              transcript).
                          calendar_event:
                            type: object
                            properties:
                              start_time:
                                type: string
                                description: ISO-8601 start time of the calendar event.
                              end_time:
                                type: string
                                description: ISO-8601 end time of the calendar event.
                              event_id:
                                type: string
                                description: >-
                                  ID of the calendar event, as returned by the
                                  calendar tools.
                              attendees:
                                type: array
                                items:
                                  $ref: '#/components/schemas/idResponse'
                                maxItems: 100
                                description: List of attendee user IDs.
                            additionalProperties: false
                            required:
                              - start_time
                              - end_time
                            description: >-
                              Calendar event metadata associated with this
                              meeting note.
                          recording:
                            type: object
                            properties:
                              start_time:
                                type: string
                                description: ISO-8601 timestamp when the recording started.
                              end_time:
                                type: string
                                description: ISO-8601 timestamp when the recording ended.
                            additionalProperties: false
                            description: Start and end times of the actual recording.
                        additionalProperties: false
                        required:
                          - is_full_page
                        description: Meeting note content fields.
                      created_time:
                        type: string
                        description: ISO-8601 timestamp when this meeting note was created.
                      last_edited_time:
                        type: string
                        description: >-
                          ISO-8601 timestamp when this meeting note was last
                          edited.
                      created_by:
                        $ref: '#/components/schemas/partialUserObjectResponse'
                        description: User who created this meeting note.
                      last_edited_by:
                        $ref: '#/components/schemas/partialUserObjectResponse'
                        description: User who last edited this meeting note.
                      has_children:
                        type: boolean
                        description: Whether this block has child blocks.
                      in_trash:
                        type: boolean
                        description: Whether this meeting note is in the trash.
                    additionalProperties: false
                    required:
                      - object
                      - id
                      - type
                      - meeting_notes
                      - created_time
                      - last_edited_time
                      - created_by
                      - last_edited_by
                      - has_children
                      - in_trash
                    description: The full-page meeting note, as a meeting_notes block.
                  created:
                    type: boolean
                    description: >-
                      Whether the meeting note was created, rather than an
                      existing meeting note for the event returned.
                additionalProperties: false
                required:
                  - object
                  - meeting_note
                  - created
        '400':
          $ref: '#/components/responses/error_api_400'
        '401':
          $ref: '#/components/responses/error_api_401'
        '403':
          $ref: '#/components/responses/error_api_403'
        '404':
          $ref: '#/components/responses/error_api_404'
        '406':
          $ref: '#/components/responses/error_api_406'
        '409':
          $ref: '#/components/responses/error_api_409'
        '429':
          $ref: '#/components/responses/error_api_429'
        '500':
          $ref: '#/components/responses/error_api_500'
        '503':
          $ref: '#/components/responses/error_api_503'
        '504':
          $ref: '#/components/responses/error_api_504'
        '529':
          $ref: '#/components/responses/error_api_529'
      x-codeSamples:
        - lang: javascript
          label: TypeScript SDK
          source: |-
            import { Client } from "@notionhq/client"

            const notion = new Client({ auth: process.env.NOTION_API_KEY })

            const response = await notion.request({
              method: "post",
              path: "meeting_notes",
              body: {
                parent: {
                  type: "data_source_id",
                  data_source_id: "c02fc1d3-db8b-45c5-a222-27595b15aea7"
                },
                title: "Weekly sync",
                markdown: "## Agenda\n- Roadmap review"
              }
            })
components:
  parameters:
    notionVersion:
      name: Notion-Version
      in: header
      required: true
      schema:
        enum:
          - '2026-03-11'
      description: >-
        The [API version](/reference/versioning) to use for this request. The
        latest version is `2026-03-11`.
  schemas:
    idRequest:
      type: string
    idResponse:
      type: string
      format: uuid
    richTextItemResponse:
      allOf:
        - $ref: '#/components/schemas/richTextItemResponseCommon'
        - oneOf:
            - $ref: '#/components/schemas/textRichTextItemResponse'
            - $ref: '#/components/schemas/mentionRichTextItemResponse'
            - $ref: '#/components/schemas/equationRichTextItemResponse'
    partialUserObjectResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/idResponse'
        object:
          type: string
          const: user
          description: Always `user`
      additionalProperties: false
      required:
        - id
        - object
    richTextItemResponseCommon:
      type: object
      properties:
        plain_text:
          type: string
          description: The plain text content of the rich text object, without any styling.
        href:
          oneOf:
            - type: string
            - type: 'null'
          description: A URL that the rich text object links to or mentions.
        annotations:
          $ref: '#/components/schemas/annotationResponse'
          description: >-
            All rich text objects contain an annotations object that sets the
            styling for the rich text.
      additionalProperties: false
      required:
        - plain_text
        - href
        - annotations
    textRichTextItemResponse:
      type: object
      properties:
        type:
          type: string
          const: text
          description: Always `text`
        text:
          type: object
          properties:
            content:
              type: string
              maxLength: 2000
              description: The actual text content of the text.
            link:
              oneOf:
                - type: object
                  properties:
                    url:
                      type: string
                      examples:
                        - https://www.notion.com
                      description: The URL of the link.
                  additionalProperties: false
                  required:
                    - url
                - type: 'null'
              description: >-
                An object with information about any inline link in this text,
                if included.
          additionalProperties: false
          required:
            - content
            - link
          description: >-
            If a rich text object's type value is `text`, then the corresponding
            text field contains an object including the text content and any
            inline link.
      required:
        - type
        - text
      title: Text
    mentionRichTextItemResponse:
      type: object
      properties:
        type:
          type: string
          const: mention
          description: Always `mention`
        mention:
          oneOf:
            - type: object
              properties:
                type:
                  type: string
                  const: user
                  description: Always `user`
                user:
                  $ref: '#/components/schemas/userValueResponse'
                  description: Details of the user mention.
              additionalProperties: false
              required:
                - type
                - user
              title: User
            - type: object
              properties:
                type:
                  type: string
                  const: date
                  description: Always `date`
                date:
                  $ref: '#/components/schemas/dateResponse'
                  description: Details of the date mention.
              additionalProperties: false
              required:
                - type
                - date
              title: Date
            - type: object
              properties:
                type:
                  type: string
                  const: link_preview
                  description: Always `link_preview`
                link_preview:
                  $ref: '#/components/schemas/linkPreviewMentionResponse'
                  description: Details of the link preview mention.
              additionalProperties: false
              required:
                - type
                - link_preview
              title: Link Preview
            - type: object
              properties:
                type:
                  type: string
                  const: link_mention
                  description: Always `link_mention`
                link_mention:
                  $ref: '#/components/schemas/linkMentionResponse'
                  description: Details of the link mention.
              additionalProperties: false
              required:
                - type
                - link_mention
              title: Link Mention
            - type: object
              properties:
                type:
                  type: string
                  const: page
                  description: Always `page`
                page:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/idResponse'
                      description: The ID of the page in the mention.
                  additionalProperties: false
                  required:
                    - id
                  description: Details of the page mention.
              additionalProperties: false
              required:
                - type
                - page
              title: Page
            - type: object
              properties:
                type:
                  type: string
                  const: database
                  description: Always `database`
                database:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/idResponse'
                      description: The ID of the database in the mention.
                  additionalProperties: false
                  required:
                    - id
                  description: Details of the database mention.
              additionalProperties: false
              required:
                - type
                - database
              title: Database
            - type: object
              properties:
                type:
                  type: string
                  const: template_mention
                  description: Always `template_mention`
                template_mention:
                  $ref: '#/components/schemas/templateMentionResponse'
                  description: Details of the template mention.
              additionalProperties: false
              required:
                - type
                - template_mention
              title: Template Mention
            - type: object
              properties:
                type:
                  type: string
                  const: custom_emoji
                  description: Always `custom_emoji`
                custom_emoji:
                  $ref: '#/components/schemas/customEmojiResponse'
                  description: Details of the custom emoji mention.
              additionalProperties: false
              required:
                - type
                - custom_emoji
              title: Custom Emoji
          description: >-
            Mention objects represent an inline mention of a database, date,
            link preview mention, page, template mention, or user. A mention is
            created in the Notion UI when a user types `@` followed by the name
            of the reference.
      required:
        - type
        - mention
      title: Mention
    equationRichTextItemResponse:
      type: object
      properties:
        type:
          type: string
          const: equation
          description: Always `equation`
        equation:
          type: object
          properties:
            expression:
              type: string
              examples:
                - e=mc^2
              description: A KaTeX compatible string.
          additionalProperties: false
          required:
            - expression
          description: >-
            Notion supports inline LaTeX equations as rich text objects with a
            type value of `equation`.
      required:
        - type
        - equation
      title: Equation
    error_api_400:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - invalid_json
                - invalid_request_url
                - invalid_request
                - missing_version
                - invalid_beta
                - validation_error
                - invalid_credit_limit
            status:
              const: 400
          required:
            - code
            - status
          additionalProperties: false
    error_api_401:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - unauthorized
            status:
              const: 401
          required:
            - code
            - status
          additionalProperties: false
    error_api_403:
      oneOf:
        - allOf:
            - $ref: '#/components/schemas/publicApiCommonErrorResponse'
            - type: object
              properties:
                code:
                  enum:
                    - restricted_resource
                    - status_change_not_allowed
                status:
                  const: 403
              required:
                - code
                - status
              additionalProperties: false
        - allOf:
            - $ref: '#/components/schemas/publicApiCommonErrorResponse'
            - type: object
              properties:
                code:
                  const: workspace_credits_exhausted
                status:
                  const: 403
                additional_data:
                  type: object
                  properties:
                    tool_error_code:
                      const: workspace_credits_exhausted
                    tool_error_class:
                      const: entitlement_required
                    tool_error_retryable:
                      const: 'false'
                    recovery_kind:
                      enum:
                        - contact_workspace_owner
                        - open_workspace_credit_settings
                      description: The recovery action selected by Notion for the caller.
                    recovery_url:
                      type: string
                      format: uri
                      description: >-
                        Present when recovery_kind directs the caller to a
                        settings page.
                  required:
                    - tool_error_code
                    - tool_error_class
                    - tool_error_retryable
                    - recovery_kind
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              required:
                - code
                - status
                - additional_data
        - allOf:
            - $ref: '#/components/schemas/publicApiCommonErrorResponse'
            - type: object
              properties:
                code:
                  const: agent_credit_limit_reached
                status:
                  const: 403
                additional_data:
                  type: object
                  properties:
                    tool_error_code:
                      const: agent_credit_limit_reached
                    tool_error_class:
                      const: entitlement_required
                    tool_error_retryable:
                      const: 'false'
                    recovery_kind:
                      enum:
                        - contact_workspace_owner
                        - none
                        - open_agent_settings
                        - request_agent_limit_increase
                        - request_pending
                      description: The recovery action selected by Notion for the caller.
                    recovery_url:
                      type: string
                      format: uri
                      description: >-
                        Present when recovery_kind directs the caller to a
                        settings page.
                  required:
                    - tool_error_code
                    - tool_error_class
                    - tool_error_retryable
                    - recovery_kind
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              required:
                - code
                - status
                - additional_data
    error_api_404:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - object_not_found
                - directory_not_found
            status:
              const: 404
          required:
            - code
            - status
          additionalProperties: false
    error_api_406:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - row_limit_exceeded
            status:
              const: 406
          required:
            - code
            - status
          additionalProperties: false
    error_api_409:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - conflict_error
                - idempotency_key_reused
                - agent_deleted
            status:
              const: 409
          required:
            - code
            - status
          additionalProperties: false
    error_api_429:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - rate_limited
            status:
              const: 429
          required:
            - code
            - status
          additionalProperties: false
    error_api_500:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - internal_server_error
            status:
              const: 500
          required:
            - code
            - status
          additionalProperties: false
    error_api_503:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - service_unavailable
            status:
              const: 503
          required:
            - code
            - status
          additionalProperties: false
    error_api_504:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - gateway_timeout
            status:
              const: 504
          required:
            - code
            - status
          additionalProperties: false
    error_api_529:
      allOf:
        - $ref: '#/components/schemas/publicApiCommonErrorResponse'
        - type: object
          properties:
            code:
              enum:
                - service_overload
            status:
              const: 529
          required:
            - code
            - status
          additionalProperties: false
    annotationResponse:
      type: object
      properties:
        bold:
          type: boolean
        italic:
          type: boolean
        strikethrough:
          type: boolean
        underline:
          type: boolean
        code:
          type: boolean
        color:
          $ref: '#/components/schemas/apiColor'
      additionalProperties: false
      required:
        - bold
        - italic
        - strikethrough
        - underline
        - code
        - color
    userValueResponse:
      oneOf:
        - $ref: '#/components/schemas/partialUserObjectResponse'
        - $ref: '#/components/schemas/userObjectResponse'
    dateResponse:
      type: object
      properties:
        start:
          type: string
          format: date
          description: The start date of the date object.
        end:
          oneOf:
            - type: string
              format: date
            - type: 'null'
          description: The end date of the date object, if any.
        time_zone:
          oneOf:
            - $ref: '#/components/schemas/timeZoneRequest'
            - type: 'null'
          description: The time zone of the date object.
      additionalProperties: false
      required:
        - start
        - end
        - time_zone
    linkPreviewMentionResponse:
      type: object
      properties:
        url:
          type: string
          description: The URL of the link preview mention.
      additionalProperties: false
      required:
        - url
    linkMentionResponse:
      type: object
      properties:
        href:
          type: string
          description: The href of the link mention.
        title:
          type: string
          description: The title of the link.
        description:
          type: string
          description: The description of the link.
        link_author:
          type: string
          description: The author of the link.
        link_provider:
          type: string
          description: The provider of the link.
        thumbnail_url:
          type: string
          description: The thumbnail URL of the link.
        icon_url:
          type: string
          description: The icon URL of the link.
        iframe_url:
          type: string
          description: The iframe URL of the link.
        height:
          type: integer
          description: The height of the link preview iframe.
        padding:
          type: integer
          description: The padding of the link preview iframe.
        padding_top:
          type: integer
          description: The top padding of the link preview iframe.
      additionalProperties: false
      required:
        - href
    templateMentionResponse:
      oneOf:
        - $ref: '#/components/schemas/templateMentionDateTemplateMentionResponse'
        - $ref: '#/components/schemas/templateMentionUserTemplateMentionResponse'
    customEmojiResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/idResponse'
          description: The ID of the custom emoji.
        name:
          type: string
          description: The name of the custom emoji.
        url:
          type: string
          description: The URL of the custom emoji.
      additionalProperties: false
      required:
        - id
        - name
        - url
    publicApiCommonErrorResponse:
      type: object
      properties:
        object:
          const: error
        message:
          type: string
        additional_data:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
      required:
        - object
        - message
    apiColor:
      type: string
      enum:
        - default
        - gray
        - brown
        - orange
        - yellow
        - green
        - blue
        - purple
        - pink
        - red
        - default_background
        - gray_background
        - brown_background
        - orange_background
        - yellow_background
        - green_background
        - blue_background
        - purple_background
        - pink_background
        - red_background
      description: >-
        One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`,
        `purple`, `pink`, `red`, `default_background`, `gray_background`,
        `brown_background`, `orange_background`, `yellow_background`,
        `green_background`, `blue_background`, `purple_background`,
        `pink_background`, `red_background`
    userObjectResponse:
      allOf:
        - $ref: '#/components/schemas/userObjectResponseCommon'
        - oneOf:
            - $ref: '#/components/schemas/personUserObjectResponse'
            - $ref: '#/components/schemas/botUserObjectResponse'
    timeZoneRequest:
      type: string
      example: Africa/Abidjan
    templateMentionDateTemplateMentionResponse:
      type: object
      properties:
        type:
          type: string
          const: template_mention_date
          description: Always `template_mention_date`
        template_mention_date:
          type: string
          enum:
            - today
            - now
          description: The date of the template mention.
      additionalProperties: false
      required:
        - type
        - template_mention_date
      title: Template Mention Date
    templateMentionUserTemplateMentionResponse:
      type: object
      properties:
        type:
          type: string
          const: template_mention_user
          description: Always `template_mention_user`
        template_mention_user:
          type: string
          const: me
          description: The user of the template mention.
      additionalProperties: false
      required:
        - type
        - template_mention_user
      title: Template Mention User
    userObjectResponseCommon:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/idResponse'
          description: The ID of the user.
        object:
          type: string
          const: user
          description: The user object type name.
        name:
          oneOf:
            - type: string
            - type: 'null'
          description: The name of the user.
        avatar_url:
          oneOf:
            - type: string
            - type: 'null'
          description: The avatar URL of the user.
        agent_id:
          $ref: '#/components/schemas/idResponse'
          description: >-
            The ID of the Custom Agent this bot acts for. Only present when the
            user is a Custom Agent's bot.
      additionalProperties: false
      required:
        - id
        - object
        - name
        - avatar_url
    personUserObjectResponse:
      type: object
      properties:
        type:
          type: string
          const: person
          description: Indicates this user is a person.
        person:
          type: object
          properties:
            email:
              type: string
              description: The email of the person.
            email_verified:
              type: boolean
              description: Whether the person's email is verified.
          additionalProperties: false
          description: Details about the person, when the `type` of the user is `person`.
      required:
        - type
        - person
      title: Person
    botUserObjectResponse:
      type: object
      properties:
        type:
          type: string
          const: bot
          description: Indicates this user is a bot.
        bot:
          oneOf:
            - $ref: '#/components/schemas/emptyObject'
            - $ref: '#/components/schemas/botInfoResponse'
          description: Details about the bot, when the `type` of the user is `bot`.
      required:
        - type
        - bot
      title: Bot
    emptyObject:
      type: object
      properties: {}
      additionalProperties: false
    botInfoResponse:
      type: object
      properties:
        owner:
          oneOf:
            - type: object
              properties:
                type:
                  type: string
                  const: user
                  description: Always `user`
                user:
                  oneOf:
                    - type: object
                      properties:
                        id:
                          $ref: '#/components/schemas/idResponse'
                          description: The ID of the user.
                        object:
                          type: string
                          const: user
                          description: The user object type name.
                        name:
                          oneOf:
                            - type: string
                            - type: 'null'
                          description: The name of the user.
                        avatar_url:
                          oneOf:
                            - type: string
                            - type: 'null'
                          description: The avatar URL of the user.
                        type:
                          type: string
                          const: person
                          description: The type of the user.
                        person:
                          type: object
                          properties:
                            email:
                              type: string
                              description: The email of the person.
                            email_verified:
                              type: boolean
                              description: Whether the person's email is verified.
                          additionalProperties: false
                          description: The person info of the user.
                      additionalProperties: false
                      required:
                        - id
                        - object
                        - name
                        - avatar_url
                        - type
                        - person
                    - $ref: '#/components/schemas/partialUserObjectResponse'
                  description: >-
                    Details about the owner of the bot, when the `type` of the
                    owner is `user`. This means the bot is for a integration.
              additionalProperties: false
              required:
                - type
                - user
              title: User
            - type: object
              properties:
                type:
                  type: string
                  const: workspace
                  description: Always `workspace`
                workspace:
                  type: boolean
                  const: true
                  description: >-
                    Details about the owner of the bot, when the `type` of the
                    owner is `workspace`. This means the bot is for an internal
                    integration.
              additionalProperties: false
              required:
                - type
                - workspace
              title: Workspace
          description: Details about the owner of the bot.
        workspace_id:
          type: string
          description: The ID of the bot's workspace.
        workspace_limits:
          type: object
          properties:
            max_file_upload_size_in_bytes:
              type: integer
              minimum: 0
              description: The maximum allowable size of a file upload, in bytes
          additionalProperties: false
          required:
            - max_file_upload_size_in_bytes
          description: Limits and restrictions that apply to the bot's workspace
        workspace_name:
          oneOf:
            - type: string
            - type: 'null'
          description: The name of the bot's workspace.
      additionalProperties: false
      required:
        - owner
        - workspace_id
        - workspace_limits
        - workspace_name
  responses:
    error_api_400:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_400'
    error_api_401:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_401'
    error_api_403:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_403'
    error_api_404:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_404'
    error_api_406:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_406'
    error_api_409:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_409'
    error_api_429:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_429'
    error_api_500:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_500'
    error_api_503:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_503'
    error_api_504:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_504'
    error_api_529:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_api_529'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````