> ## 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 or change its job line and reply-time target



## 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: Activity log and its exports. Dashboard session only.
    name: audit
    x-larynth-sdk: true
  - description: >-
      Notification preferences, Slack and Telegram channels, browser push.
      Dashboard session only.
    name: notifications
    x-larynth-sdk: true
  - description: >-
      Export and deletion requests for a workspace or account. Dashboard session
      only.
    name: data-rights
    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, routing hours, area codes, branded calling and
      bring-your-own SIP trunks.
    name: numbers
    x-larynth-sdk: true
  - description: Contacts and CSV imports.
    name: contacts
    x-larynth-sdk: true
  - description: >-
      Consent, revocations, do-not-call, pre-dial decisions, outbound readiness
      and calling rules.
    name: compliance
    x-larynth-sdk: true
  - description: >-
      Business and identity verification that unlocks outbound calling.
      Dashboard session only.
    name: verification
    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
  - description: Workspaces of the signed-in user. Dashboard session only.
    name: workspaces
    x-larynth-sdk: true
  - description: >-
      Spending requests from Members to Owners and Admins. Dashboard session
      only.
    name: spending
    x-larynth-sdk: true
  - description: Home brief and setup checklist. Dashboard session only.
    name: home
    x-larynth-sdk: true
  - description: Shared action inbox of a workspace. Dashboard session only.
    name: inbox
    x-larynth-sdk: true
paths:
  /v1/assistants/{id}:
    patch:
      tags:
        - assistants
      summary: Rename an assistant or change its job line and reply-time target
      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:
        description:
          maxLength: 200
          type: string
        latency_target_ms:
          format: int64
          maximum: 3000
          minimum: 300
          type: integer
        name:
          maxLength: 120
          minLength: 1
          type: string
      type: object
    Assistant:
      additionalProperties: false
      properties:
        archived_at:
          format: date-time
          type: string
        coverage:
          $ref: '#/components/schemas/AssistantCoverage'
          description: Working hours derived from number routing; null until schedules ship
        created_at:
          format: date-time
          type: string
        description:
          description: The job line
          maxLength: 200
          type: string
        draft:
          $ref: '#/components/schemas/AssistantDraftInfo'
        has_unpublished_changes:
          type: boolean
        id:
          format: uuid
          type: string
        languages:
          description: Main language of the current spec, then the languages it switches to
          items:
            type: string
          type: array
        latency_target_ms:
          description: Reply-time target the call pages compare against
          format: int64
          type: integer
        latest_version:
          format: int64
          type: integer
        name:
          type: string
        number_ids:
          description: Numbers routed to this assistant
          items:
            type: string
          type: array
        paused:
          $ref: '#/components/schemas/AssistantPause'
        published:
          $ref: '#/components/schemas/AssistantPublished'
        published_version:
          format: int64
          type: integer
        source:
          enum:
            - manual
            - setup
            - duplicate
            - template
            - import
          type: string
        state:
          enum:
            - live
            - paused
            - draft
            - archived
          type: string
        status:
          enum:
            - active
            - archived
          type: string
        type:
          description: Always single_prompt until flows ship
          enum:
            - single_prompt
            - flow
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - status
        - latest_version
        - created_at
        - updated_at
        - type
        - languages
        - number_ids
        - state
        - has_unpublished_changes
        - latency_target_ms
      type: object
    AssistantCoverage:
      additionalProperties: false
      properties:
        bands:
          items:
            $ref: '#/components/schemas/AssistantCoverageBand'
          type: array
        summary_key:
          description: i18n key of the plain summary, for example around_the_clock
          type: string
      required:
        - summary_key
        - bands
      type: object
    AssistantDraftInfo:
      additionalProperties: false
      properties:
        changed_sections:
          description: Editor sections that differ from the published version
          items:
            type: string
          type: array
        revision:
          format: int64
          type: integer
        updated_at:
          format: date-time
          type: string
        updated_by_name:
          type: string
        version:
          format: int64
          type: integer
      required:
        - version
        - revision
        - changed_sections
        - updated_at
      type: object
    AssistantPause:
      additionalProperties: false
      properties:
        at:
          format: date-time
          type: string
        by_user_id:
          format: uuid
          type: string
        reason:
          maxLength: 200
          type: string
      required:
        - at
      type: object
    AssistantPublished:
      additionalProperties: false
      properties:
        at:
          format: date-time
          type: string
        by_name:
          type: string
        by_user_id:
          format: uuid
          type: string
        version:
          format: int64
          type: integer
      required:
        - version
        - at
      type: object
    Problem:
      additionalProperties: true
      properties:
        api_base:
          description: API base URL of the workspace's home region (workspace.other_region)
          type: string
        attempts_left:
          description: Code attempts left in this sign-in step
          format: int64
          type: integer
        campaign_ids:
          description: Campaigns that use the number (numbers.in_use)
          items:
            type: string
          type: array
        checks:
          description: Failed launch checks (campaign.preflight_failed)
          items:
            $ref: '#/components/schemas/PreflightCheck'
          type: array
        code:
          description: >-
            Stable machine-readable error code; compliance denials carry the
            dial.* rule id
          type: string
        contact_id:
          description: Existing contact (contacts.exists)
          type: string
        detail:
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        instance:
          type: string
        optout_line:
          description: The number is the opt-out line (numbers.in_use)
          type: boolean
        reauth_methods:
          description: Ways to re-authenticate, in preference order (auth.reauth_required)
          items:
            type: string
          type: array
        request_kind:
          description: Spending request kind to file instead (spending.approval_required)
          enum:
            - number_purchase
            - campaign_launch
          type: string
        retry_at:
          description: Next moment the request may succeed (calling windows)
          format: date-time
          type: string
        revision:
          description: >-
            Current revision (numbers.routing_conflict,
            campaign.revision_conflict)
          format: int64
          type: integer
        status:
          format: int64
          type: integer
        title:
          type: string
        type:
          description: Stable URI identifying the error code
          type: string
        updated_by_name:
          type: string
      required:
        - type
        - title
        - status
        - code
      type: object
    AssistantCoverageBand:
      additionalProperties: false
      properties:
        days:
          description: mon to sun
          items:
            type: string
          type: array
        end_minute:
          format: int64
          maximum: 1440
          minimum: 1
          type: integer
        start_minute:
          format: int64
          maximum: 1439
          minimum: 0
          type: integer
      required:
        - days
        - start_minute
        - end_minute
      type: object
    PreflightCheck:
      additionalProperties: false
      properties:
        code:
          enum:
            - platform_outbound_open
            - verification
            - telemarketing_approved
            - paid_top_up
            - outbound_terms
            - script_check
            - agent_published
            - caller_id
            - audience
            - consent_coverage
            - dnc_internal
            - dnc_national
            - calling_hours
            - frequency_cap
            - holidays_sundays
            - ca_preamble
            - state_registrations
            - voicemail_optout_line
            - balance
            - daily_spend_cap
            - recheck_due
          type: string
        fix:
          $ref: '#/components/schemas/CheckFix'
        params:
          additionalProperties: {}
          type: object
        state:
          enum:
            - ok
            - warn
            - stop
            - info
          type: string
      required:
        - code
        - state
      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
    CheckFix:
      additionalProperties: false
      properties:
        kind:
          enum:
            - link
            - step
          type: string
        target:
          description: Dashboard route or wizard step
          type: string
      required:
        - kind
        - target
      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: __Host-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.