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

# Whether this organisation agreed to the copilot, whose key it spends, and what is left of today's ceiling.



## OpenAPI

````yaml /api-reference/openapi.json get /copilot_settings
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes (ADR-014). Reads are security_invoker
    views; writes are SECURITY DEFINER functions. Rebuilt wholesale on every
    deploy — it holds no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: Assets
  - name: Asset lifecycle
  - name: Work lifecycle
  - name: Maintenance
  - name: Inventory
  - name: Inventory detail
  - name: Procurement
  - name: Contracts
  - name: Workforce
  - name: Capacity
  - name: Dispatch
  - name: Routing
  - name: Tools
  - name: Inspections
  - name: Verification
  - name: Reliability
  - name: Parts demand
  - name: Sensors and meters
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Root cause analysis
  - name: Reports
  - name: Audit center
  - name: Activity
  - name: Notifications
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Files
  - name: Sync
  - name: Support
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Platform
  - name: Self verification
  - name: Setup
  - name: Tools on a job, and who has them out
  - name: Vendors and contracts
  - name: Work order execution
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /copilot_settings:
    get:
      tags:
        - Copilot
      summary: >-
        Whether this organisation agreed to the copilot, whose key it spends,
        and what is left of today's ceiling.
      parameters:
        - $ref: '#/components/parameters/rowFilter.copilot_settings.organization_id'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.id'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.is_enabled'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.agreed_by_user_id'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.agreed_by_name'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.agreed_at'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.capabilities'
        - $ref: >-
            #/components/parameters/rowFilter.copilot_settings.daily_question_limit
        - $ref: >-
            #/components/parameters/rowFilter.copilot_settings.questions_left_today
        - $ref: '#/components/parameters/rowFilter.copilot_settings.provider'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.api_key_hint'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.model_code'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.has_api_key'
        - $ref: >-
            #/components/parameters/rowFilter.copilot_settings.voice_api_key_hint
        - $ref: '#/components/parameters/rowFilter.copilot_settings.voice_model_code'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.has_voice_key'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.key_set_at'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.key_set_by_name'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.key_last_used_at'
        - $ref: '#/components/parameters/rowFilter.copilot_settings.key_last_failure'
        - $ref: >-
            #/components/parameters/rowFilter.copilot_settings.key_last_failure_at
        - $ref: '#/components/parameters/rowFilter.copilot_settings.row_version'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/copilot_settings'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/copilot_settings'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/copilot_settings'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/copilot_settings'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.copilot_settings.organization_id:
      in: query
      name: organization_id
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.is_enabled:
      in: query
      name: is_enabled
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.agreed_by_user_id:
      in: query
      name: agreed_by_user_id
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.agreed_by_name:
      in: query
      name: agreed_by_name
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.agreed_at:
      in: query
      name: agreed_at
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.capabilities:
      in: query
      name: capabilities
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.daily_question_limit:
      in: query
      name: daily_question_limit
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.questions_left_today:
      in: query
      name: questions_left_today
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.provider:
      in: query
      name: provider
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.api_key_hint:
      in: query
      name: api_key_hint
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.model_code:
      in: query
      name: model_code
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.has_api_key:
      in: query
      name: has_api_key
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.voice_api_key_hint:
      in: query
      name: voice_api_key_hint
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.voice_model_code:
      in: query
      name: voice_model_code
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.has_voice_key:
      in: query
      name: has_voice_key
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.key_set_at:
      in: query
      name: key_set_at
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.key_set_by_name:
      in: query
      name: key_set_by_name
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.key_last_used_at:
      in: query
      name: key_last_used_at
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.key_last_failure:
      in: query
      name: key_last_failure
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.key_last_failure_at:
      in: query
      name: key_last_failure_at
      required: false
      schema:
        type: string
    rowFilter.copilot_settings.row_version:
      in: query
      name: row_version
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    copilot_settings:
      description: >-
        Whether this organisation agreed to the copilot, whose key it spends,
        and what is left of today's ceiling.
      properties:
        agreed_at:
          format: timestamp with time zone
          type: string
        agreed_by_name:
          format: character varying
          maxLength: 200
          type: string
        agreed_by_user_id:
          description: >-
            Note:

            This is a Foreign Key to `my_profile.user_id`.<fk table='my_profile'
            column='user_id'/>
          format: uuid
          type: string
        api_key_hint:
          format: character varying
          maxLength: 12
          type: string
        capabilities:
          format: jsonb
        daily_question_limit:
          format: integer
          type: integer
        has_api_key:
          format: boolean
          type: boolean
        has_voice_key:
          format: boolean
          type: boolean
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_enabled:
          format: boolean
          type: boolean
        key_last_failure:
          format: text
          type: string
        key_last_failure_at:
          format: timestamp with time zone
          type: string
        key_last_used_at:
          format: timestamp with time zone
          type: string
        key_set_at:
          format: timestamp with time zone
          type: string
        key_set_by_name:
          format: character varying
          maxLength: 200
          type: string
        model_code:
          format: character varying
          maxLength: 60
          type: string
        organization_id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        provider:
          format: character varying
          maxLength: 20
          type: string
        questions_left_today:
          format: integer
          type: integer
        row_version:
          format: bigint
          type: integer
        voice_api_key_hint:
          format: character varying
          maxLength: 12
          type: string
        voice_model_code:
          format: character varying
          maxLength: 60
          type: string
      type: object

````

## Related topics

- [Copilot activity](/analytics/copilot.md)
- [AI settings](/config/ai.md)
- [Signing in on the handset](/field/sign-in.md)
- [Inside a work order](/work/work-order-detail.md)
- [Inside an asset](/assets/detail.md)