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

# Rename an assistant



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/assistants/{id}
openapi: 3.1.0
info:
  description: >-
    Larynth control-plane API v1. Errors are RFC 9457 problem+json with a stable
    type URI per code (x-larynth-error-codes). Operations carry
    x-larynth-min-role, x-larynth-auth, x-larynth-scope, x-larynth-idempotency
    and x-larynth-sdk.
  title: Larynth API
  version: 1.0.0
servers:
  - url: https://api-us.larynth.com
    description: US region
security: []
tags:
  - description: Dashboard login and session. Excluded from SDKs.
    name: auth
    x-larynth-sdk: false
  - description: Tenant settings and members. Dashboard session only.
    name: tenants
    x-larynth-sdk: true
  - description: API keys. Dashboard session only.
    name: api-keys
    x-larynth-sdk: true
  - description: Audit log. Dashboard session only.
    name: audit
    x-larynth-sdk: true
  - description: Models and voices available to assistants.
    name: catalog
    x-larynth-sdk: true
  - description: Assistants and their immutable published versions.
    name: assistants
    x-larynth-sdk: true
  - description: Phone numbers and inbound routing.
    name: numbers
    x-larynth-sdk: true
  - description: Contacts and CSV imports.
    name: contacts
    x-larynth-sdk: true
  - description: Consent, revocations, do-not-call and pre-dial decisions.
    name: compliance
    x-larynth-sdk: true
  - description: Outbound campaigns.
    name: campaigns
    x-larynth-sdk: true
  - description: Calls, turns and events.
    name: calls
    x-larynth-sdk: true
  - description: Encrypted call recordings.
    name: recordings
    x-larynth-sdk: true
  - description: Prepaid balance, ledger, top-ups and rates (micro-USD).
    name: billing
    x-larynth-sdk: true
  - description: Webhook endpoints and deliveries (Standard Webhooks signatures).
    name: webhooks
    x-larynth-sdk: true
  - description: >-
      Knowledge bases built from files and websites, attached to assistant
      versions.
    name: knowledge
    x-larynth-sdk: true
  - description: Live updates over WebSocket. Dashboard session only.
    name: realtime
    x-larynth-sdk: true
  - description: Platform operator endpoints. Excluded from SDKs.
    name: admin
    x-larynth-sdk: false
paths:
  /v1/assistants/{id}:
    patch:
      tags:
        - assistants
      summary: Rename an assistant
      operationId: updateAssistant
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAssistantRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Assistant'
          description: OK
        '400':
          $ref: '#/components/responses/Problem400'
        '401':
          $ref: '#/components/responses/Problem401'
        '403':
          $ref: '#/components/responses/Problem403'
        '404':
          $ref: '#/components/responses/Problem404'
        '409':
          $ref: '#/components/responses/Problem409'
        '422':
          $ref: '#/components/responses/Problem422'
        '429':
          $ref: '#/components/responses/Problem429'
        '500':
          $ref: '#/components/responses/Problem500'
      security:
        - session: []
        - apiKey:
            - assistants:write
components:
  schemas:
    UpdateAssistantRequest:
      additionalProperties: false
      properties:
        name:
          maxLength: 120
          minLength: 1
          type: string
      type: object
    Assistant:
      additionalProperties: false
      properties:
        archived_at:
          format: date-time
          type: string
        created_at:
          format: date-time
          type: string
        id:
          format: uuid
          type: string
        latest_version:
          format: int64
          type: integer
        name:
          type: string
        published_version:
          format: int64
          type: integer
        status:
          enum:
            - active
            - archived
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - status
        - latest_version
        - created_at
        - updated_at
      type: object
    Problem:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable machine-readable error code; compliance denials carry the
            dial.* rule id
          type: string
        detail:
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        instance:
          type: string
        retry_at:
          description: Next moment the request may succeed (calling windows)
          format: date-time
          type: string
        status:
          format: int64
          type: integer
        title:
          type: string
        type:
          description: Stable URI identifying the error code
          type: string
      required:
        - type
        - title
        - status
        - code
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  responses:
    Problem400:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Bad Request
    Problem401:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Unauthorized
    Problem403:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Forbidden
    Problem404:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Not Found
    Problem409:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Conflict
    Problem422:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Unprocessable Entity
    Problem429:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Too Many Requests
    Problem500:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Internal Server Error
  securitySchemes:
    session:
      description: Dashboard session cookie
      in: cookie
      name: lx_session
      type: apiKey
    apiKey:
      bearerFormat: lx_<key_id>_<secret>
      description: API key; the listed scope is required
      scheme: bearer
      type: http

````

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