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

# Compare agent configuration versions

> Compare two different version public UUIDs within this account. Changed values are bounded to 20,000 characters; omitted changes are counted.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/accounts/{account_id}/agent_config_versions/diff
openapi: 3.0.4
info:
  title: Tied API
  description: >-
    The Tied REST API. Three families of endpoint, each with its own credential:
    **Application** for everything inside an account, **Platform** for
    provisioning accounts and users, and **Client** for acting as a contact from
    your own surface.
  version: 1.1.0
  termsOfService: https://tied.com/legal
  contact:
    email: hello@tied.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://app.tied.com
    description: Tied cloud
security: []
tags:
  - name: Account AgentBots
    description: Account-specific Agent Bots
  - name: Agents
    description: Agent management APIs
  - name: Canned Responses
    description: Pre-defined responses for common queries
  - name: Contacts
    description: Contact management APIs
  - name: Contact Labels
    description: Manage contact labels
  - name: Conversation Assignments
    description: Manage conversation assignments
  - name: Conversation Labels
    description: Manage conversation labels
  - name: Conversations
    description: Conversation management APIs
  - name: Custom Attributes
    description: Custom fields for contacts and conversations
  - name: Custom Filters
    description: Saved filters for conversations
  - name: Inboxes
    description: Communication channels setup
  - name: Integrations
    description: Third-party integrations
  - name: Messages
    description: Message management APIs
  - name: Profile
    description: User profile APIs
  - name: Reports
    description: Analytics and reporting APIs
  - name: Teams
    description: Team management APIs
  - name: Webhooks
    description: Event notification webhooks
  - name: Automation Rule
    description: Workflow automation rules
  - name: Help Center
    description: Knowledge base management
  - name: Contacts API
    description: Public contact APIs
  - name: Conversations API
    description: Public conversation APIs
  - name: Messages API
    description: Public message APIs
  - name: CSAT Survey Page
    description: Customer satisfaction survey
  - name: Account
    description: >-
      The authenticated user's own account — read and update account settings.
      Distinct from the Platform family's **Accounts**, which provisions
      accounts across an installation.
  - name: Audit Logs
    description: Read the account's audit trail
  - name: Inbox API
    description: Public inbox lookup by channel identifier
  - name: Labels
    description: >-
      Create and manage the account's labels. Applying one to a conversation or
      contact is a separate endpoint under those resources.
  - name: Macros
    description: >-
      Saved multi-step actions an agent — or an integration — can run against
      one or more conversations.
  - name: Campaigns
    description: Ongoing website campaigns and one-off SMS and WhatsApp sends.
  - name: Contact Notes
    description: Internal notes on a contact. Never visible to the contact.
  - name: Help Center Categories
    description: Categories group a portal's articles, one tree per allowed locale.
  - name: Help Center Articles
    description: The articles a portal publishes, and their draft and archived states.
  - name: Summary Reports
    description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON.
  - name: Live Reports
    description: Right-now queue counts. No date range — these describe the present.
  - name: CSAT
    description: >-
      The satisfaction ratings contacts have submitted, and the metrics computed
      from them.
  - name: Notifications
    description: >-
      The per-user notification feed, its read and snooze state, and the
      settings that decide what lands in it.
  - name: Conversation Participants
    description: >-
      The agents watching a conversation. Participants get notified about it
      without being assigned to it.
  - name: Draft Messages
    description: >-
      The unsent reply held for a conversation. Stored in Redis, one per
      conversation.
  - name: Search
    description: >-
      One search service across conversations, contacts, messages and Help
      Center articles.
  - name: Dashboard Apps
    description: Embedded pages that appear as a tab beside a conversation.
  - name: Assignment Policies
    description: How conversations are handed out, and which inbox uses which policy.
  - name: Files
    description: Storing a file so another endpoint can attach it.
  - name: Bot Flows
    description: >-
      Scripted conversation flows, their versions, and the publish and rollback
      that move between them.
  - name: Billing
    description: >-
      Credit balance, usage, invoices, spend controls and the provider-hosted
      payment flows.
  - name: AMB Templates
    description: >-
      Saved Apple Messages primitive payloads an agent can reuse from the
      composer.
  - name: AMB Onboarding
    description: The in-flight Apple Messages for Business registration for an account.
  - name: Widget Session
    description: Starting a widget session and reading the visitor it belongs to.
  - name: Widget Conversation
    description: The visitor's conversation and its messages.
  - name: Widget Context
    description: Campaigns, agents, labels, events and uploads for a widget session.
  - name: CSAT Survey
    description: The public, unauthenticated survey a contact answers from a link.
  - name: Workspace
    description: Scheduling and cancelling deletion of the whole workspace.
  - name: Widget Integrations
    description: Provider actions available to a visitor session in its own conversation.
  - name: Orchestration Studio
    description: >-
      Administrator-only read APIs for Orchestration Studio cases and knowledge
      sources.
  - name: Topic Analytics
    description: Account Topics readiness, labeling health and usage aggregates.
  - name: Analytics V2
    description: >-
      Account-scoped metrics, anonymized benchmarks and audited conversation
      drilldown.
  - name: Knowledge proposals
    description: Administrator-only proposal review and revision decisions.
  - name: Model settings
    description: Administrator-only routing profiles and Tied-hosted catalogue.
  - name: Quality Review
    description: Current quality review queue metadata and manual work state.
paths:
  /api/v1/accounts/{account_id}/agent_config_versions/diff:
    get:
      tags:
        - Orchestration Studio
      summary: Compare agent configuration versions
      description: >-
        Compare two different version public UUIDs within this account. Changed
        values are bounded to 20,000 characters; omitted changes are counted.
      operationId: diff_agent_config_versions
      parameters:
        - name: account_id
          in: path
          required: true
          description: The numeric ID of the account.
          schema:
            type: integer
        - name: base
          in: query
          required: true
          description: Base version public UUID.
          schema:
            type: string
            format: uuid
        - name: target
          in: query
          required: true
          description: Target version public UUID.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent_config_version_diff'
              example:
                base:
                  public_id: 35620285-562e-4ea1-90c5-0555a6edc8c6
                  version_number: 1
                target:
                  public_id: 1dfe9b60-20f7-4b83-94d0-c17f454858e7
                  version_number: 2
                identical: false
                changes:
                  - path:
                      - prompts
                      - worker
                    op: changed
                    old: First synthetic prompt
                    new: Second synthetic prompt
                truncated: false
                omitted_changes: 0
        '400':
          description: More than one credential type was supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_studio_credential_conflict'
        '401':
          description: Authentication or account membership required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_studio_unauthorized'
        '403':
          description: Administrator access is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
        '404':
          description: >-
            The feature is disabled or the requested version is outside this
            account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
        '422':
          description: A version UUID is malformed or both UUIDs identify the same version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent_config_diff_error'
      security:
        - userApiKey: []
components:
  schemas:
    agent_config_version_diff:
      type: object
      properties:
        base:
          $ref: '#/components/schemas/agent_config_version_reference'
          description: Base version used for the comparison.
        target:
          $ref: '#/components/schemas/agent_config_version_reference'
          description: Target version used for the comparison.
        identical:
          type: boolean
          description: Whether the compared configurations have no differences.
        changes:
          type: array
          items:
            $ref: '#/components/schemas/agent_config_diff_change'
          description: >-
            Configuration changes in the comparison, bounded by the response
            limit.
        truncated:
          type: boolean
          description: Whether additional changes were omitted from this response.
        omitted_changes:
          type: integer
          minimum: 0
          description: Number of changes omitted by the response bound.
      required:
        - base
        - target
        - identical
        - changes
        - truncated
        - omitted_changes
    orchestration_studio_credential_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - multiple_credentials
              description: Conflicting credential types were supplied.
          required:
            - code
          description: The authentication error.
      required:
        - error
    orchestration_studio_unauthorized:
      description: >-
        Anonymous requests return errors; an outsider or account bot returns
        error.
      oneOf:
        - type: object
          properties:
            errors:
              type: array
              items:
                type: string
              description: Errors for this response.
          required:
            - errors
        - $ref: '#/components/schemas/error_message'
    error_message:
      type: object
      description: >-
        The shape returned by `render_unauthorized`, `render_not_found_error`
        and `render_could_not_create_error`.
      properties:
        error:
          type: string
          description: A single human-readable message.
          example: Resource could not be found
      required:
        - error
    agent_config_diff_error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable explanation of the refusal.
      required:
        - error
    agent_config_version_reference:
      type: object
      properties:
        public_id:
          type: string
          format: uuid
          description: Public UUID identifying the immutable configuration version.
        version_number:
          type: integer
          minimum: 1
          description: Account-local publication sequence number, starting at one.
      required:
        - public_id
        - version_number
    agent_config_diff_change:
      type: object
      properties:
        path:
          type: array
          items:
            type: string
          description: Sequence of configuration keys locating the changed value.
        op:
          type: string
          enum:
            - added
            - removed
            - changed
          description: 'Change kind: added, removed, or changed.'
        old:
          description: Previous value; null when the path was newly added.
        new:
          description: Current value; null when the path was removed.
        truncated_value:
          type: boolean
          enum:
            - true
          description: >-
            Present and true when a value was omitted because it exceeded the
            response size bound.
      required:
        - path
        - op
        - old
        - new
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        This token can be obtained by visiting the profile page or via rails
        console. Provides access to  endpoints based on the user permissions
        levels. This token can be saved by an external system when user is
        created via API, to perform activities on behalf of the user.

````

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