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

# Set or show an agent runtime permission profile



## OpenAPI

````yaml /openapi.json post /api/v1/agents/permissions
openapi: 3.1.0
info:
  description: >-
    OpenAPI 3.1 spec auto-generated from the Ravi CLI registry. Each operation
    maps 1:1 to a `ravi <group> <command>` invocation.
  title: Ravi API
  version: 974aebaaf457a15f
servers:
  - description: Local Ravi gateway (default)
    url: http://localhost:3000
security: []
tags:
  - description: Ask a Ravi Page's managers for access and follow the request
    name: access
  - description: Inspect session adapters and their debug snapshots
    name: adapters
  - description: >-
      The operator's calendar in the Ravi Console: meetings, recording and
      briefings
    name: agenda
  - description: Agent management
    name: agents
  - description: Discover and validate Ravi app manifests
    name: apps
  - description: Generic artifact ledger and lineage tools
    name: artifacts
  - description: Audio generation tools (TTS)
    name: audio
  - description: Typed project databases (Bases) in Ravi Console
    name: bases
  - description: Manage Ravi MCP bridges through Console
    name: bridges
  - description: File, comment on, and track global Ravi bug reports on Console
    name: bug
  - description: Manage local-first Ravi calendars
    name: calendars
  - description: Manage native Ravi channel runner
    name: channels
  - description: Inspect canonical chats, messages, and reading queues
    name: chats
  - name: cloud
  - description: Manage Ravi prompt commands
    name: commands
  - description: >-
      Connect and manage your own accounts (Gmail, Calendar, ...) through Ravi
      Console
    name: connectors
  - description: Contact management
    name: contacts
  - description: Runtime context registry and introspection
    name: context
  - description: Inspect token and cost tracking
    name: costs
  - name: credentials
  - description: CRM relationship surface
    name: crm
  - description: Scheduled job management
    name: cron
  - description: Manage ravi via PM2
    name: daemon
  - description: Inspect ravi.db state (locks, WAL, holders)
    name: db
  - name: devin
  - description: Run reproducible evaluation tasks against Ravi
    name: eval
  - description: Stream live NATS events
    name: events
  - description: Send structured feedback to Ravi Console
    name: feedback
  - description: >-
      Operate Gmail through a connected Google account (yours, the person
      asking's, or a shared one)
    name: gmail
  - description: Heartbeat scheduling management
    name: heartbeat
  - description: Generic runtime hooks
    name: hooks
  - description: Link chat people to their Ravi Console account
    name: identity
  - description: Image generation tools
    name: image
  - description: Local Ravi inbox and Console delivery compatibility commands
    name: inbox
  - description: Operational insights with explicit lineage
    name: insights
  - description: Instance management (channels, policies, routes)
    name: instances
  - description: Invite people into the Console organization by email
    name: invites
  - description: Execução de chamada longa em background, com desfecho entregue na sessão
    name: jobs
  - description: Search what the org said and published, with sources
    name: knowledge
  - description: Use local-first Ravi mail
    name: mail
  - description: Media sending
    name: media
  - description: Meeting artifact and provider operations
    name: meetings
  - description: Daily metrics rollup and reporting
    name: metrics
  - description: Inspect Observation Plane bindings
    name: observers
  - description: Manage project-owned Ravi Pages and publish content through Console
    name: pages
  - description: Inspect provider-runtime authorization
    name: permissions
  - description: List and create the organization's projects in Ravi Console
    name: projects
  - name: prox
  - description: Emoji reactions
    name: react
  - description: Inspect route config and live routing without drilling into instances
    name: routes
  - description: Manage Ravi runtime prompt rules
    name: rules
  - name: runtime
  - description: Run one Ravi task in a disposable E2B cloud sandbox and collect its patch
    name: sandbox
  - name: sdk
  - description: Read the current Ravi agent/session/chat context
    name: self
  - description: Bot service management
    name: service
  - description: Manage agent sessions
    name: sessions
  - description: Global settings management
    name: settings
  - description: Manage runtime skill gate rules
    name: skill-gates
  - description: Skill discovery, install and inspection tools
    name: skills
  - description: Native Slack workspace operations
    name: slack
  - description: Versioned Ravi specs memory
    name: specs
  - description: Sticker library management and sending
    name: stickers
  - description: Local-first sync outbox, inbox, and Console bridge
    name: sync
  - description: Deterministic tag classification rules
    name: tag-rules
  - description: Unified tags for Ravi assets
    name: tags
  - description: Task runtime for dispatching work to Ravi agents
    name: tasks
  - description: >-
      Org and project themes in the Console Library: check, publish, propose and
      set the active theme
    name: themes
  - description: Manage Ravi threads
    name: threads
  - description: CLI tools inspection and export
    name: tools
  - description: Audio transcription
    name: transcribe
  - description: Event triggers
    name: triggers
  - description: Video analysis tools
    name: video
  - description: Create watches and wire their events to triggers
    name: watch
  - name: whatsapp
  - description: >-
      Widget templates in the Console Library: catalog, check, preview, publish
      and propose
    name: widgets
  - description: Resolve and mutate generic Work Objects through Ravi domain adapters
    name: work-objects
  - name: workflows
  - description: >-
      Operate YouTube Data API v3 and YouTube Analytics API v2 through Ravi
      credentials
    name: yt
paths:
  /api/v1/agents/permissions:
    post:
      tags:
        - agents
      summary: Set or show an agent runtime permission profile
      operationId: agents.permissions
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                capabilities:
                  description: >-
                    Comma-separated explicit capabilities
                    (permission:objectType:objectId)
                  type: string
                clearCapabilities:
                  description: Remove explicit capabilities while preserving profile
                  type: boolean
                execute:
                  description: >-
                    Actually change the runtime permission profile; default is a
                    dry-run that only shows the plan (exit 3)
                  type: boolean
                id:
                  description: Agent ID
                  type: string
                profile:
                  description: >-
                    Profile: bootstrap, chat-only (conversation only),
                    explicit-only (only the listed capabilities, no bootstrap
                    floor), full-access (Bash execute ceiling + admin), none
                    (reset to bootstrap minimum)
                  type: string
              required:
                - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  action:
                    const: permissions
                    type: string
                  after:
                    anyOf:
                      - additionalProperties: false
                        properties:
                          capabilities:
                            items:
                              anyOf:
                                - type: string
                                - additionalProperties: false
                                  properties:
                                    objectId:
                                      type: string
                                    objectType:
                                      type: string
                                    permission:
                                      type: string
                                    source:
                                      type: string
                                  type: object
                            type: array
                          profile:
                            enum:
                              - bootstrap
                              - chat-only
                              - explicit-only
                              - full-access
                            type: string
                        type: object
                      - type: 'null'
                  agent:
                    additionalProperties: false
                    properties:
                      allowedSessions:
                        items:
                          type: string
                        type: array
                      contactScope:
                        type: string
                      cwd:
                        type: string
                      debounceMs:
                        type: number
                      defaults:
                        anyOf:
                          - additionalProperties:
                              $ref: '#/components/schemas/Schema0_b95130a15d1f'
                            propertyNames:
                              type: string
                            type: object
                          - type: 'null'
                      dmScope:
                        enum:
                          - main
                          - per-peer
                          - per-channel-peer
                          - per-account-channel-peer
                        type: string
                      effectiveModel:
                        anyOf:
                          - type: string
                          - type: 'null'
                      effectiveProvider:
                        type: string
                      effort:
                        enum:
                          - none
                          - minimal
                          - low
                          - medium
                          - high
                          - xhigh
                          - max
                          - ultra
                        type: string
                      groupDebounceMs:
                        type: number
                      heartbeat:
                        additionalProperties: false
                        properties:
                          accountId:
                            type: string
                          activeEnd:
                            type: string
                          activeStart:
                            type: string
                          enabled:
                            type: boolean
                          intervalMs:
                            type: number
                          lastRunAt:
                            type: number
                          model:
                            type: string
                        required:
                          - enabled
                          - intervalMs
                        type: object
                      id:
                        type: string
                      isDefault:
                        type: boolean
                      matrixAccount:
                        type: string
                      memoryModel:
                        type: string
                      mode:
                        enum:
                          - active
                          - sentinel
                        type: string
                      model:
                        type: string
                      modelError:
                        anyOf:
                          - type: string
                          - type: 'null'
                      modelPresetId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      modelPresetVersion:
                        anyOf:
                          - type: number
                          - type: 'null'
                      modelSource:
                        anyOf:
                          - enum:
                              - agent_preset
                              - agent_default
                              - global_default
                              - env_fallback
                              - runtime_default
                            type: string
                          - type: 'null'
                      name:
                        type: string
                      provider:
                        type: string
                      providerSource:
                        type: string
                      remote:
                        type: string
                      remoteUser:
                        type: string
                      settingSources:
                        items:
                          enum:
                            - user
                            - project
                          type: string
                        type: array
                      specMode:
                        type: boolean
                      systemPromptAppend:
                        type: string
                      tags:
                        items:
                          additionalProperties: false
                          properties:
                            assetId:
                              type: string
                            assetType:
                              enum:
                                - agent
                                - automation
                                - app
                                - session
                                - task
                                - project
                                - profile
                                - contact
                                - chat
                                - route
                                - instance
                                - artifact
                                - insight
                                - workflow_spec
                                - workflow_run
                                - workflow_node
                                - cron_job
                                - trigger
                                - hook
                                - task_automation
                                - observer_rule
                                - observer_binding
                                - observer_profile
                                - command
                                - skill
                                - skill_gate_rule
                                - context
                                - call_profile
                                - call_request
                                - call_voice_agent
                                - call_tool
                                - outbound_queue
                                - outbound_entry
                                - spec
                                - devin_session
                              type: string
                            createdAt:
                              type: number
                            createdBy:
                              type: string
                            id:
                              type: string
                            metadata:
                              additionalProperties:
                                $ref: '#/components/schemas/Schema0_b95130a15d1f'
                              propertyNames:
                                type: string
                              type: object
                            source:
                              type: string
                            tagId:
                              type: string
                            tagSlug:
                              type: string
                            updatedAt:
                              type: number
                            updatedBy:
                              type: string
                          required:
                            - id
                            - tagId
                            - tagSlug
                            - assetType
                            - assetId
                            - source
                            - createdAt
                            - updatedAt
                          type: object
                        type: array
                    required:
                      - id
                      - cwd
                      - modelPresetId
                      - isDefault
                      - effectiveProvider
                      - providerSource
                      - effectiveModel
                      - modelSource
                      - modelPresetVersion
                      - modelError
                      - tags
                    type: object
                  agentId:
                    type: string
                  authorityLayer:
                    type: string
                  before:
                    anyOf:
                      - additionalProperties: false
                        properties:
                          capabilities:
                            items:
                              anyOf:
                                - type: string
                                - additionalProperties: false
                                  properties:
                                    objectId:
                                      type: string
                                    objectType:
                                      type: string
                                    permission:
                                      type: string
                                    source:
                                      type: string
                                  type: object
                            type: array
                          profile:
                            enum:
                              - bootstrap
                              - chat-only
                              - explicit-only
                              - full-access
                            type: string
                        type: object
                      - type: 'null'
                  breakGlassCommand:
                    type: string
                  changed:
                    type: boolean
                  chatOnlyCommand:
                    type: string
                  command:
                    type: string
                  defaults:
                    anyOf:
                      - additionalProperties:
                          $ref: '#/components/schemas/Schema0_b95130a15d1f'
                        propertyNames:
                          type: string
                        type: object
                      - type: 'null'
                  effectiveOn:
                    type: string
                  inspectCommand:
                    type: string
                  leastPrivilegeExample:
                    type: string
                  profile:
                    type: string
                  recurringAccessCommand:
                    type: string
                  resetToBootstrapCommand:
                    type: string
                  runtimePermissions:
                    anyOf:
                      - additionalProperties: false
                        properties:
                          capabilities:
                            items:
                              anyOf:
                                - type: string
                                - additionalProperties: false
                                  properties:
                                    objectId:
                                      type: string
                                    objectType:
                                      type: string
                                    permission:
                                      type: string
                                    source:
                                      type: string
                                  type: object
                            type: array
                          profile:
                            enum:
                              - bootstrap
                              - chat-only
                              - explicit-only
                              - full-access
                            type: string
                        type: object
                      - type: 'null'
                required:
                  - action
                  - changed
                  - agentId
                type: object
          description: Success — body conforms to the `@Returns` schema.
        '400':
          description: Bad request — body failed schema validation.
        '401':
          description: Unauthorized — bearer token missing or invalid.
        '403':
          description: Forbidden — caller lacks the required scope.
        '500':
          description: Internal error.
      security:
        - bearerAuth: []
components:
  schemas:
    Schema0_b95130a15d1f:
      anyOf:
        - anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
        - items:
            $ref: '#/components/schemas/Schema0_b95130a15d1f'
          type: array
        - additionalProperties:
            $ref: '#/components/schemas/Schema0_b95130a15d1f'
          propertyNames:
            type: string
          type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: rctx
      description: >-
        Runtime context-key (`rctx_*`) issued by the Ravi gateway. Required for
        every non-`open` scope. Bootstrap the first key with `ravi daemon
        init-admin-key`; rotate, derive, and revoke via the `ravi context`
        family. Specs: `runtime/context-keys`, `sdk/auth`.
      scheme: bearer
      type: http

````

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