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

# Update an agent's configuration

> Updates an agent's instructions, model, role or app access with the same checks as Settings > Members > Agents, and returns the configuration after the change. Omitted fields keep their value. Requires the agents:write scope. A personal-scope agent can only be changed by its creator.



## OpenAPI

````yaml /openapi.json patch /agents/{agentId}/configuration
openapi: 3.0.3
info:
  description: >-
    Generated from Ando's accepted public API v1 contract metadata. Current
    routes preserve legacy /api/v1 response envelopes while converging on the
    public https://api.ando.so/v1 shape.
  title: Ando Public API
  version: v1
servers:
  - description: Canonical public API host.
    url: https://api.ando.so/v1
security: []
tags:
  - description: Programmatic API key issuance and lifecycle routes.
    name: API Keys
  - description: Workspace agent lifecycle routes.
    name: Agents
  - description: Call detail and transcript routes.
    name: Calls
  - description: Membership-scoped conversation routes.
    name: Conversations
  - description: File upload lifecycle routes for public API message attachments.
    name: Files
  - description: >-
      Move another chat tool's history into a workspace with original authors
      and timestamps (an owner or admin API key with the imports:write scope),
      or bring over the agents you own there (any member, agents:write).
    name: Imports
  - description: >-
      Workspace member detail routes. Existing v1 paths keep member
      compatibility spellings.
    name: Members
  - description: Message and conversation message routes.
    name: Messages
  - description: Public realtime connection and protocol routes.
    name: Realtime
  - description: Search routes.
    name: Search
  - description: Outbound webhook endpoint and delivery routes.
    name: Webhooks
paths:
  /agents/{agentId}/configuration:
    patch:
      tags:
        - Agents
      summary: Update an agent's configuration
      description: >-
        Updates an agent's instructions, model, role or app access with the same
        checks as Settings > Members > Agents, and returns the configuration
        after the change. Omitted fields keep their value. Requires the
        agents:write scope. A personal-scope agent can only be changed by its
        creator.
      operationId: updateAgentConfiguration
      parameters:
        - description: Agent membership identifier.
          in: path
          name: agentId
          required: true
          schema:
            description: Agent membership identifier.
            type: string
      requestBody:
        content:
          application/json:
            examples:
              instructions:
                summary: Replace the agent's instructions.
                value:
                  instructions: >-
                    You help the support team triage new tickets and draft
                    replies.
            schema:
              $ref: '#/components/schemas/UpdateAgentConfigurationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConfigurationResponse'
          description: Updated agent configuration.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AndoApiKey: []
        - BearerApiKey: []
components:
  schemas:
    UpdateAgentConfigurationBody:
      additionalProperties: false
      description: >-
        A partial configuration update. Omitted fields keep their value; unknown
        fields are refused.
      properties:
        instructions:
          description: The agent's instructions.
          type: string
        model_id:
          description: Model identifier the agent runs on.
          type: string
        role_name:
          description: Optional role label.
          type: string
          nullable: true
        app_access:
          additionalProperties: false
          description: App access changes. Omitted fields keep their value.
          properties:
            connection_ids:
              description: >-
                Connections chosen for this agent, or null for every shared
                connection in the vault.
              items:
                description: App connection identifier.
                type: string
              type: array
              nullable: true
            excluded_connection_ids:
              description: Shared connections this agent opts out of.
              items:
                description: App connection identifier.
                type: string
              type: array
            enabled_connection_tools:
              description: >-
                Per-connection tool allowlists, or null to clear stored
                allowlists and allow each connection's default tools. When an
                array is set, every chosen connection needs an entry.
              items:
                $ref: '#/components/schemas/AgentConfigurationToolGrant'
              type: array
              nullable: true
            github_repository_ids:
              description: Workspace GitHub repositories the agent can work in.
              items:
                description: Workspace GitHub repository identifier.
                type: string
              type: array
          type: object
      type: object
    AgentConfigurationResponse:
      additionalProperties: false
      description: Agent configuration response.
      properties:
        data:
          $ref: '#/components/schemas/AgentConfiguration'
      required:
        - data
      type: object
    AgentConfigurationToolGrant:
      additionalProperties: false
      description: The tools one app connection lets the agent call.
      properties:
        connection_id:
          description: App connection identifier.
          type: string
          example: 01jzn7e61x3a7v9h2r7t2m3q4p
        tool_names:
          description: Tool names.
          items:
            description: Tool name.
            type: string
          type: array
      required:
        - connection_id
        - tool_names
      type: object
    AgentConfiguration:
      additionalProperties: false
      description: An agent's configuration as set in Settings > Members > Agents.
      properties:
        object:
          description: Always "agent_configuration".
          type: string
          enum:
            - agent_configuration
        agent_id:
          description: Agent workspace membership identifier.
          type: string
          example: 01jzn7e61x3a7v9h2r7t2m3q4p
        instructions:
          description: The agent's instructions.
          type: string
        model_id:
          description: Model identifier the agent runs on.
          type: string
        role_name:
          description: Optional role label.
          type: string
          nullable: true
        app_access:
          allOf:
            - $ref: '#/components/schemas/AgentConfigurationAppAccess'
          description: >-
            App access, or null when the agent does not run on the Ando app
            gateway.
          nullable: true
        updated_at:
          description: Last configuration change.
          type: string
          example: '2026-05-14T08:00:00.000Z'
          format: date-time
      required:
        - object
        - agent_id
        - instructions
        - model_id
        - role_name
        - app_access
        - updated_at
      type: object
    LegacyErrorResponse:
      additionalProperties: false
      description: Current compatibility error envelope used by legacy /api/v1 routes.
      properties:
        error:
          description: Error message.
          type: string
        error_code:
          description: Optional machine-readable error code.
          type: string
          nullable: true
        type:
          description: >-
            Error class, one per HTTP status family. rate_limit_error,
            api_error, overloaded_error and timeout_error are worth retrying;
            the others need a different request. Retry a write only with the
            same Idempotency-Key: an api_error can mean it committed.
          enum:
            - invalid_request_error
            - authentication_error
            - permission_error
            - not_found_error
            - conflict_error
            - request_too_large
            - rate_limit_error
            - api_error
            - overloaded_error
            - timeout_error
          type: string
        request_id:
          description: >-
            The request id, also sent as the x-request-id header. Quote it when
            reporting a problem.
          type: string
        missing_scopes:
          description: Missing scopes.
          items:
            description: Scope.
            type: string
          type: array
      required:
        - error
      type: object
    PublicApiErrorResponse:
      additionalProperties: false
      description: Target public API error envelope.
      properties:
        error:
          additionalProperties: false
          description: Error details.
          properties:
            code:
              description: Machine-readable error code.
              type: string
            message:
              description: Human-readable error message.
              type: string
            request_id:
              description: Request identifier.
              type: string
              nullable: true
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    AgentConfigurationAppAccess:
      additionalProperties: false
      description: Which app connections, tools and GitHub repositories the agent can use.
      properties:
        connection_ids:
          description: >-
            Connections chosen for this agent, or null for every shared
            connection in the workspace's app vault.
          items:
            description: App connection identifier.
            type: string
          type: array
          nullable: true
        excluded_connection_ids:
          description: Connections shared with every agent that this agent opted out of.
          items:
            description: App connection identifier.
            type: string
          type: array
        enabled_connection_tools:
          description: Per-connection tool allowlists, or null when none is stored.
          items:
            $ref: '#/components/schemas/AgentConfigurationToolGrant'
          type: array
          nullable: true
        github_repository_ids:
          description: Workspace GitHub repositories the agent can work in.
          items:
            description: Workspace GitHub repository identifier.
            type: string
          type: array
        apps:
          description: 'Read only: what the agent can reach with this access.'
          items:
            $ref: '#/components/schemas/AgentConfigurationApp'
          type: array
      required:
        - connection_ids
        - excluded_connection_ids
        - enabled_connection_tools
        - github_repository_ids
        - apps
      type: object
    AgentConfigurationApp:
      additionalProperties: false
      description: An app connection the agent can reach now.
      properties:
        connection_id:
          description: App connection identifier.
          type: string
          example: 01jzn7e61x3a7v9h2r7t2m3q4p
        display_name:
          description: Connection display name.
          type: string
        tool_names:
          description: >-
            Tools the agent may call, or null when no allowlist is stored and it
            may call every tool the connection offers.
          items:
            description: Tool name.
            type: string
          type: array
          nullable: true
      required:
        - connection_id
        - display_name
        - tool_names
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Bad request.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Missing or invalid API key.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Forbidden.
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Not found.
    Conflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Conflict.
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiErrorResponse'
      description: Rate limit or quota exceeded.
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Internal server error.
  securitySchemes:
    AndoApiKey:
      description: Workspace API key. Current accepted keys use the ando_sk_ prefix.
      in: header
      name: x-api-key
      type: apiKey
    BearerApiKey:
      bearerFormat: ando_sk
      description: Compatibility transport for workspace API keys.
      scheme: bearer
      type: http

````

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