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

# Upsert role config

> **Auth:** organization API key with `write` scope, or a signed-in user.

Roles are 1–64 characters and match the `x-xenovia-agent-role` request header.



## OpenAPI

````yaml https://cp.xenovia.io/openapi.json put /api/v1/proxies/{proxy_id}/role-configs/{role}
openapi: 3.1.0
info:
  title: Xenovia Control Plane API
  version: 1.0.0
  description: >-
    Management API for proxies, providers, policies, telemetry, alerts and
    organization settings.
servers:
  - url: https://cp.xenovia.io
    description: Production
security:
  - BearerAuth: []
paths:
  /api/v1/proxies/{proxy_id}/role-configs/{role}:
    put:
      tags:
        - proxies
      summary: Upsert role config
      description: >-
        **Auth:** organization API key with `write` scope, or a signed-in user.


        Roles are 1–64 characters and match the `x-xenovia-agent-role` request
        header.
      operationId: >-
        upsert_role_config_route_api_v1_proxies__proxy_id__role_configs__role__put
      parameters:
        - name: role
          in: path
          required: true
          schema:
            type: string
            title: Role
        - name: proxy_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Proxy Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyRoleConfigUpsert'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyRoleConfigRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProxyRoleConfigUpsert:
      properties:
        intent:
          anyOf:
            - type: string
            - type: 'null'
          title: Intent
      type: object
      title: ProxyRoleConfigUpsert
    ProxyRoleConfigRead:
      properties:
        agent_role:
          type: string
          title: Agent Role
        intent:
          anyOf:
            - type: string
            - type: 'null'
          title: Intent
      type: object
      required:
        - agent_role
        - intent
      title: ProxyRoleConfigRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token: an organization API key (`ak_…`) created under Settings →
        API Keys, or a dashboard user session token. Proxy keys (`xe_…`) are not
        accepted here. Endpoints marked as user-only in their description reject
        organization keys with `403`.

````