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

# Update an agent

> Update agent instructions, model, workspace, repositories, or persistent state; enable or pause the agent; archive or restore it. enabled and archived also control its schedules and triggers. Supply expectedUpdatedAt to reject concurrent changes.



## OpenAPI

````yaml https://api.tembo.io/public-api/openapi/public patch /v1/agents/{agentId}
openapi: 3.1.0
info:
  title: Tembo Public API
  description: >-
    Manage agents, sessions, repositories, and organization resources with the
    Tembo API.
  version: 1.0.0
servers:
  - url: https://api.tembo.io
    description: Tembo API
  - url: https://{deployment-origin}/api/public-api
    description: Self-hosted Tembo
    variables:
      deployment-origin:
        default: tembo.example.com
        description: Hostname of your self-hosted Tembo deployment
security: []
paths:
  /v1/agents/{agentId}:
    patch:
      tags:
        - Agents
      summary: Update an agent
      description: >-
        Update agent instructions, model, workspace, repositories, or persistent
        state; enable or pause the agent; archive or restore it. enabled and
        archived also control its schedules and triggers. Supply
        expectedUpdatedAt to reject concurrent changes.
      operationId: updateAgent
      parameters:
        - in: path
          name: agentId
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expectedUpdatedAt:
                  description: >-
                    Value of updatedAt from the last retrieved agent. A
                    concurrent change causes a conflict instead of overwriting
                    newer changes.
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                name:
                  description: Rename the agent.
                  type: string
                  minLength: 1
                  maxLength: 200
                key:
                  description: Change the agent lookup key, or null to clear it.
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 200
                    - type: 'null'
                instructions:
                  description: Replace the agent instruction document, or null to clear it.
                  anyOf:
                    - $ref: '#/components/schemas/TipTapDocument'
                      description: >-
                        Instructions for the agent as a rich-text document.
                        Mentions can reference integrations used by the agent.
                    - type: 'null'
                mcpServers:
                  description: >-
                    Replace the MCP server or connection IDs. An empty array
                    clears the selection.
                  maxItems: 100
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                agent:
                  description: >-
                    Change the coding agent and model key. Null clears the
                    override.
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 200
                    - type: 'null'
                agentOptions:
                  $ref: '#/components/schemas/AgentOptionsInput'
                  description: >-
                    Change agent-specific runtime options, such as reasoning
                    effort.
                userState:
                  $ref: '#/components/schemas/AgentState'
                  description: Replace the user-managed persistent agent state.
                sandboxSize:
                  description: Change the workspace VM size. Null clears the override.
                  anyOf:
                    - type: string
                      enum:
                        - nano
                        - micro
                        - medium
                        - large
                        - xl
                        - xxl
                        - ultra
                    - type: 'null'
                projectId:
                  description: >-
                    Change the project environment for runs. Null clears the
                    override.
                  anyOf:
                    - type: string
                      format: uuid
                      pattern: >-
                        ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    - type: string
                      const: tembo
                    - type: 'null'
                templateId:
                  description: >-
                    Change the associated agent template identifier, or null to
                    clear it.
                  anyOf:
                    - type: string
                      maxLength: 200
                    - type: 'null'
                script:
                  description: Replace the agent script, or null to clear it.
                  anyOf:
                    - type: string
                      maxLength: 100000
                    - type: 'null'
                artifactType:
                  description: >-
                    Change the artifact type produced by the agent, or null to
                    clear it.
                  anyOf:
                    - type: string
                      enum:
                        - PullRequest
                        - ToolCall
                        - Plan
                        - Response
                        - File
                        - Service
                        - Source
                    - type: 'null'
                    - type: 'null'
                repositoryIds:
                  description: >-
                    Replace repository associations. An empty array removes all
                    associations.
                  maxItems: 250
                  type: array
                  items:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                enabled:
                  description: >-
                    Enable or pause the agent and its schedules and triggers.
                    Archived agents remain paused until restored.
                  type: boolean
                archived:
                  description: >-
                    Archive with true or restore with false. Archiving disables
                    schedules and triggers; restoring follows the agent enabled
                    state.
                  type: boolean
              additionalProperties: false
              minProperties: 1
      responses:
        '200':
          description: Update an agent
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  name:
                    type: string
                  key:
                    type:
                      - string
                      - 'null'
                  sandboxSize:
                    anyOf:
                      - type: string
                        enum:
                          - nano
                          - micro
                          - small
                          - medium
                          - large
                          - xl
                          - xxl
                          - ultra
                      - type: 'null'
                  projectId:
                    type:
                      - string
                      - 'null'
                  templateId:
                    type:
                      - string
                      - 'null'
                  contentVersion:
                    default: 1
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  script:
                    type:
                      - string
                      - 'null'
                  artifactType:
                    anyOf:
                      - type: string
                        enum:
                          - PullRequest
                          - ToolCall
                          - Plan
                          - Response
                          - File
                          - Service
                          - Source
                      - type: 'null'
                  createdAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                  updatedAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                  archivedAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      - type: 'null'
                  enabledAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      - type: 'null'
                  organizationId:
                    anyOf:
                      - type: string
                        minLength: 1
                        maxLength: 255
                      - type: 'null'
                  organizationName:
                    type:
                      - string
                      - 'null'
                  createdBy:
                    type:
                      - string
                      - 'null'
                  instructions:
                    anyOf:
                      - $ref: '#/components/schemas/TipTapDocument'
                        description: >-
                          Instructions for the agent as a rich-text document.
                          Mentions can reference integrations used by the agent.
                      - type: 'null'
                  agent:
                    description: >-
                      Runtime and model selection key; not the ID of an agent
                      resource.
                    type:
                      - string
                      - 'null'
                  agentOptions:
                    $ref: '#/components/schemas/AgentOptionsInput'
                  mcpServers:
                    maxItems: 100
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 200
                    description: >-
                      Selected MCP server identifiers, including built-in server
                      keys.
                  userState:
                    anyOf:
                      - $ref: '#/components/schemas/AgentState'
                      - type: 'null'
                  codeRepositories:
                    maxItems: 250
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        name:
                          type: string
                        owner:
                          type:
                            - string
                            - 'null'
                        integrationId:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        integrationType:
                          type: string
                      required:
                        - id
                        - name
                        - owner
                        - integrationId
                        - integrationType
                      additionalProperties: false
                  lastRun:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            pattern: >-
                              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          sessionId:
                            type:
                              - string
                              - 'null'
                          status:
                            type: string
                          createdAt:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          updatedAt:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          durationMs:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                            description: >-
                              Measured duration of the agent run in
                              milliseconds.
                          errorMessage:
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - sessionId
                          - status
                          - createdAt
                          - updatedAt
                          - durationMs
                          - errorMessage
                        additionalProperties: false
                      - type: 'null'
                  scheduleCount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  triggerCount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  hasPausedSchedule:
                    type: boolean
                  hasPausedTrigger:
                    type: boolean
                  integrationIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                      pattern: >-
                        ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  integrationTypes:
                    type: array
                    items:
                      type: string
                required:
                  - id
                  - name
                  - key
                  - sandboxSize
                  - projectId
                  - templateId
                  - contentVersion
                  - script
                  - artifactType
                  - createdAt
                  - updatedAt
                  - archivedAt
                  - enabledAt
                  - organizationId
                  - organizationName
                  - createdBy
                  - instructions
                  - agent
                  - agentOptions
                  - mcpServers
                  - userState
                  - codeRepositories
                  - lastRun
                  - scheduleCount
                  - triggerCount
                  - hasPausedSchedule
                  - hasPausedTrigger
                  - integrationIds
                  - integrationTypes
                additionalProperties: false
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '409':
          description: Resource conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '500':
          description: Agent operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - apiKey: []
      x-codeSamples:
        - lang: typescript
          label: TypeScript SDK
          source: >
            import Tembo from '@tembo-io/sdk';


            const client = new Tembo();


            const agent = await
            client.agents.update('7c9e6679-7425-40de-944b-e07fc1f90ae7', {});
        - lang: rust
          label: Rust SDK
          source: |
            use tembo_rs::*;

            let client = Tembo::from_env()?;

            let response = client
                .agents()
                .update("7c9e6679-7425-40de-944b-e07fc1f90ae7", AgentsUpdateBody::new())
                .send()
                .await?;
components:
  schemas:
    TipTapDocument:
      anyOf:
        - $ref: '#/components/schemas/TipTapNode'
        - $ref: '#/components/schemas/CustomDocument'
      description: >-
        Rich-text document containing text, formatting, images, and mentions. A
        document typically has a "doc" root with nested content nodes.
      example:
        type: doc
        content:
          - type: paragraph
            content:
              - type: text
                text: Hello
    AgentOptionsInput:
      anyOf:
        - type: object
          properties:
            reasoningLevel:
              type: string
              minLength: 1
              maxLength: 100
            mode:
              description: >-
                Use Build (normal) to execute work or Plan (planning) to plan
                before writing code.
              type: string
              enum:
                - normal
                - planning
            speed:
              description: >-
                Preferred execution speed when supported by the selected
                runtime.
              type: string
              enum:
                - normal
                - fast
                - ultrafast
            goal:
              type: object
              properties:
                enabled:
                  type: boolean
                objective:
                  type: string
                  maxLength: 100000
              additionalProperties: false
            ultracode:
              description: >-
                Whether the agent orchestrates multi-agent workflows for every
                task when supported by the selected runtime and model.
              type: boolean
          additionalProperties: {}
        - $ref: '#/components/schemas/RuntimeAgentOptions'
      description: >-
        Execution settings for the selected agent runtime, including
        provider-specific options.
    AgentState:
      type: object
      propertyNames:
        type: string
      additionalProperties: {}
      description: >-
        User-defined state keyed by name. Values may be any JSON value,
        including nested objects and arrays. No application-specific keys are
        required.
    TipTapNode:
      anyOf:
        - oneOf:
            - $ref: '#/components/schemas/TipTapImageNode'
            - $ref: '#/components/schemas/TipTapMentionNode'
            - $ref: '#/components/schemas/TipTapHeadingNode'
            - $ref: '#/components/schemas/TipTapOrderedListNode'
            - $ref: '#/components/schemas/TipTapTaskItemNode'
            - $ref: '#/components/schemas/TipTapCodeBlockNode'
        - $ref: '#/components/schemas/TipTapContentNode'
    CustomDocument:
      type: object
      additionalProperties: {}
      description: Rich-text content with custom document properties and node attributes.
    RuntimeAgentOptions:
      type: object
      propertyNames:
        type: string
      additionalProperties: {}
      description: Runtime-specific execution settings and provider extensions.
    TipTapImageNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          const: image
        attrs:
          $ref: '#/components/schemas/TipTapImageAttributes'
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      required:
        - type
      additionalProperties: {}
    TipTapMentionNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          const: mention
        attrs:
          $ref: '#/components/schemas/TipTapMentionAttributes'
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      required:
        - type
      additionalProperties: {}
    TipTapHeadingNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          const: heading
        attrs:
          type: object
          properties:
            level:
              type: integer
              minimum: 1
              maximum: 6
          additionalProperties: {}
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      required:
        - type
      additionalProperties: {}
    TipTapOrderedListNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          const: orderedList
        attrs:
          type: object
          properties:
            start:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            type:
              type:
                - string
                - 'null'
          additionalProperties: {}
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      required:
        - type
      additionalProperties: {}
    TipTapTaskItemNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          const: taskItem
        attrs:
          type: object
          properties:
            checked:
              type: boolean
          additionalProperties: {}
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      required:
        - type
      additionalProperties: {}
    TipTapCodeBlockNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          const: codeBlock
        attrs:
          type: object
          properties:
            language:
              type:
                - string
                - 'null'
          additionalProperties: {}
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      required:
        - type
      additionalProperties: {}
    TipTapContentNode:
      type: object
      properties:
        text:
          type: string
          maxLength: 1000000
        marks:
          maxItems: 1000
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TipTapLinkMark'
              - $ref: '#/components/schemas/TipTapMark'
        type:
          type: string
          minLength: 1
          maxLength: 100
          not:
            enum:
              - image
              - mention
              - heading
              - orderedList
              - taskItem
              - codeBlock
        attrs:
          $ref: '#/components/schemas/TipTapExtensionAttributes'
        content:
          maxItems: 10000
          type: array
          items:
            $ref: '#/components/schemas/TipTapNode'
      additionalProperties: {}
    TipTapLinkMark:
      type: object
      properties:
        type:
          type: string
          const: link
        attrs:
          type: object
          properties:
            href:
              type:
                - string
                - 'null'
            target:
              type:
                - string
                - 'null'
            rel:
              type:
                - string
                - 'null'
            class:
              type:
                - string
                - 'null'
            title:
              type:
                - string
                - 'null'
          additionalProperties: {}
      required:
        - type
      additionalProperties: {}
    TipTapMark:
      type: object
      properties:
        type:
          type: string
          minLength: 1
          maxLength: 100
          not:
            enum:
              - link
        attrs:
          $ref: '#/components/schemas/TipTapExtensionAttributes'
      required:
        - type
      additionalProperties: {}
    TipTapImageAttributes:
      type: object
      properties:
        src:
          type:
            - string
            - 'null'
        alt:
          type:
            - string
            - 'null'
        title:
          type:
            - string
            - 'null'
        width:
          type:
            - string
            - 'null'
        data-uploading:
          type:
            - string
            - 'null'
        data-placeholder-id:
          type:
            - string
            - 'null'
        upload-progress:
          type:
            - string
            - 'null'
      additionalProperties: {}
    TipTapMentionAttributes:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
        label:
          type:
            - string
            - 'null'
        type:
          type:
            - string
            - 'null'
        mentionSuggestionChar:
          type:
            - string
            - 'null'
        metadata:
          anyOf:
            - type: object
              properties:
                integrationType:
                  type: string
                codeRepositoryId:
                  type: string
                isHeader:
                  type: boolean
                argumentHint:
                  type: string
                commandName:
                  type: string
                source:
                  type: string
              additionalProperties: {}
            - type: 'null'
      additionalProperties: {}
    TipTapExtensionAttributes:
      type: object
      propertyNames:
        type: string
      additionalProperties: {}
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.