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

# Write a config revision

> Write a new revision onto a channel. Writing production creates the key when it does not exist; writing staging stages a candidate that only Roark-recognized simulation sessions will read. Every write is a new revision; nothing is overwritten.



## OpenAPI

````yaml /api-reference/openapi.documented.json put /v1/agent-config/{key}
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/agent-config/{key}:
    put:
      tags:
        - Autoimprove
      summary: Write a config revision
      description: >-
        Write a new revision onto a channel. Writing production creates the key
        when it does not exist; writing staging stages a candidate that only
        Roark-recognized simulation sessions will read. Every write is a new
        revision; nothing is overwritten.
      operationId: putV1Agent-configByKey
      parameters:
        - in: path
          name: key
          schema:
            type: string
            pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$
            minLength: 1
            maxLength: 120
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteManagedConfigRequest'
      responses:
        '200':
          description: The config with its updated channel pointers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ManagedAgentConfig'
                required:
                  - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Staging write on an unknown key
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const agentConfig = await client.agentConfig.update('x', {
              channel: 'production',
              document: { foo: 'string' },
            });

            console.log(agentConfig.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            agent_config = client.agent_config.update(
                key="x",
                channel="production",
                document={
                    "foo": "string",
                },
            )
            print(agent_config.data)
components:
  schemas:
    WriteManagedConfigRequest:
      type: object
      properties:
        channel:
          type: string
          enum:
            - production
            - staging
          description: Which channel to write.
        document:
          type: object
          additionalProperties: {}
          description: The full config JSON for the new revision.
        summary:
          type: string
          maxLength: 500
          description: One-line story of the change.
        agentId:
          type: string
          format: uuid
          description: >-
            Link this config to a Roark agent (the one your calls report).
            Required before Autoimprove can run on it: the link is how a fix
            finds the config channel.
      required:
        - channel
        - document
    ManagedAgentConfig:
      type: object
      properties:
        id:
          type: string
          format: uuid
        key:
          type: string
          description: The stable handle your code fetches by.
          example: support-agent
        agentId:
          type:
            - string
            - 'null'
          format: uuid
          description: The linked Roark agent, when one exists.
        productionRevisionId:
          type:
            - string
            - 'null'
          format: uuid
          description: The revision real traffic reads.
        stagingRevisionId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The candidate revision Roark test calls read. Null when nothing is
            staged.
        createdAt:
          type: string
          description: ISO 8601.
        updatedAt:
          type: string
          description: ISO 8601.
      required:
        - id
        - key
        - agentId
        - productionRevisionId
        - stagingRevisionId
        - createdAt
        - updatedAt
      description: >-
        A managed config for a code-first agent (LiveKit, Pipecat, or any stack
        using the SDK): your agent fetches its tunable surface from Roark at
        session start. Two channels: production for real traffic, staging for
        candidates under test.
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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