> ## 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.

# Add a property to a base



## OpenAPI

````yaml /openapi.json post /api/v1/bases/props/add
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/bases/props/add:
    post:
      tags:
        - bases
      summary: Add a property to a base
      operationId: bases.props.add
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                agent:
                  description: 'Agent column: the agent that fills it (a label, max 64)'
                  type: string
                approvers:
                  description: >-
                    Approval: who decides, comma-separated
                    role:<viewer|developer|project_admin> or user:<userId>
                    (1-20)
                  type: string
                base:
                  description: Base id or slug
                  type: string
                config:
                  description: Property config JSON (options, format, includeTime...)
                  type: string
                console:
                  description: Console base URL
                  type: string
                description:
                  description: Property description
                  type: string
                expectedSchemaVersion:
                  description: >-
                    Schema version you read (default: read the current one
                    first)
                  type: string
                idempotencyKey:
                  description: >-
                    Idempotency key: a retry with the same key and request
                    returns the created object (default: generated)
                  type: string
                inputs:
                  description: 'Agent column: property keys the agent reads (1-20)'
                  type: string
                instructions:
                  description: 'Agent column: what the agent fills (1-4000 chars)'
                  type: string
                key:
                  description: >-
                    API key, ^[a-z][a-z0-9_]{0,62}$ (default: derived from the
                    name)
                  type: string
                name:
                  description: Property display name
                  type: string
                options:
                  description: >-
                    Select/status options (or an agent column's select output),
                    comma-separated; status groups as Name:todo|in_progress|done
                  type: string
                output:
                  description: >-
                    Agent column: value type
                    text|number|checkbox|select|multi_select|url|date
                  type: string
                position:
                  description: Column position
                  type: string
                project:
                  description: >-
                    Console project id or slug; overrides the saved Console
                    scope
                  type: string
                required:
                  description: Require a value on create and on updates that touch it
                  type: boolean
                resetOn:
                  description: >-
                    Approval: property keys whose change sends a decided
                    approval back to pending
                  type: string
                type:
                  description: >-
                    text|number|checkbox|date|select|multi_select|status|url|email|phone|person|ref|approval|agent
                    (default: text)
                  type: string
              required:
                - base
                - name
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  base:
                    additionalProperties: false
                    properties:
                      capabilities:
                        additionalProperties: false
                        properties:
                          manage:
                            type: boolean
                          readDirect:
                            type: boolean
                          writeDirect:
                            type: boolean
                        required:
                          - manage
                          - readDirect
                          - writeDirect
                        type: object
                      createdAt:
                        type: string
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      icon:
                        anyOf:
                          - type: string
                          - type: 'null'
                      id:
                        type: string
                      name:
                        type: string
                      organizationId:
                        type: string
                      projectId:
                        type: string
                      rowCount:
                        anyOf:
                          - type: number
                          - type: 'null'
                      schemaVersion:
                        type: number
                      slug:
                        type: string
                      status:
                        type: string
                      timezone:
                        type: string
                      updatedAt:
                        type: string
                      version:
                        type: number
                    required:
                      - id
                      - organizationId
                      - projectId
                      - slug
                      - name
                      - description
                      - icon
                      - timezone
                      - schemaVersion
                      - version
                      - status
                      - rowCount
                      - createdAt
                      - updatedAt
                      - capabilities
                    type: object
                  consoleUrl:
                    type: string
                  idempotencyKey:
                    type: string
                  projectRef:
                    type: string
                  property:
                    additionalProperties: false
                    properties:
                      config:
                        additionalProperties: false
                        properties:
                          agent:
                            anyOf:
                              - type: string
                              - type: 'null'
                          approvers:
                            items:
                              additionalProperties: false
                              properties:
                                kind:
                                  type: string
                                minRole:
                                  type: string
                                userId:
                                  type: string
                              required:
                                - kind
                              type: object
                            type: array
                          currency:
                            type: string
                          format:
                            type: string
                          includeTime:
                            type: boolean
                          inputs:
                            items:
                              type: string
                            type: array
                          instructions:
                            type: string
                          options:
                            items:
                              additionalProperties: false
                              properties:
                                archived:
                                  type: boolean
                                color:
                                  type: string
                                group:
                                  type: string
                                id:
                                  type: string
                                name:
                                  type: string
                              required:
                                - id
                                - name
                                - color
                              type: object
                            type: array
                          output:
                            type: string
                          precision:
                            type: number
                          resetOn:
                            items:
                              type: string
                            type: array
                        type: object
                      deletedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      id:
                        type: string
                      key:
                        type: string
                      name:
                        type: string
                      position:
                        type: number
                      required:
                        type: boolean
                      type:
                        type: string
                    required:
                      - id
                      - key
                      - name
                      - description
                      - type
                      - config
                      - position
                      - required
                      - deletedAt
                    type: object
                  report:
                    anyOf:
                      - additionalProperties: false
                        properties:
                          activeRows:
                            type: number
                          cleared:
                            type: number
                          converted:
                            type: number
                          dependents:
                            additionalProperties: false
                            properties:
                              charts:
                                items:
                                  additionalProperties: false
                                  properties:
                                    id:
                                      type: string
                                    name:
                                      type: string
                                  required:
                                    - id
                                    - name
                                  type: object
                                type: array
                              views:
                                items:
                                  additionalProperties: false
                                  properties:
                                    id:
                                      type: string
                                    name:
                                      type: string
                                  required:
                                    - id
                                    - name
                                  type: object
                                type: array
                            required:
                              - views
                              - charts
                            type: object
                          dryRun:
                            type: boolean
                          missing:
                            type: number
                        required:
                          - dryRun
                          - activeRows
                          - converted
                          - cleared
                          - missing
                          - dependents
                        type: object
                      - type: 'null'
                  success:
                    const: true
                    type: boolean
                required:
                  - success
                  - consoleUrl
                  - projectRef
                  - base
                  - property
                  - report
                  - idempotencyKey
                type: object
          description: Success — body conforms to the `@Returns` schema.
        '400':
          description: Bad request — body failed schema validation.
        '500':
          description: Internal error.
      security: []

````

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