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

# Patch apime



## OpenAPI

````yaml /api-reference/openapi.yaml patch /api/me/
openapi: 3.0.3
info:
  title: Console API
  version: 1.0.0
  description: Central control plane API for the Dataerai platform.
servers:
  - url: https://{server}
    description: Your Dataerai deployment (the API is served under /api)
    variables:
      server:
        default: your-deployment.dataerai.com
        description: Host of your Dataerai deployment
security: []
paths:
  /api/me/:
    patch:
      tags:
        - api
      operationId: api_me_partial_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMeUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMeUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMeUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
          description: ''
      security:
        - cookieAuthCsrfExempt: []
components:
  schemas:
    PatchedMeUpdate:
      type: object
      description: |-
        Updatable non-email profile fields. Email changes are handled
        through a separate flow and are not accepted here.
      properties:
        name:
          type: string
          maxLength: 255
        visible_outside_org:
          type: boolean
        custom_ollama_url:
          type: string
          maxLength: 255
        custom_ollama_model:
          type: string
          maxLength: 128
        custom_clip_service_url:
          type: string
          maxLength: 255
        custom_clip_service_token:
          type: string
          writeOnly: true
          maxLength: 4096
        ai_search_enabled:
          type: boolean
        embeddings_enabled:
          type: boolean
        default_project_geobound_enabled:
          type: boolean
        default_project_geobound_basis:
          $ref: '#/components/schemas/GeoboundBasisEnum'
        default_project_geobound_allowed_countries:
          type: array
          items:
            type: string
        default_project_geobound_allowed_country_set:
          type: string
          format: uuid
          nullable: true
        default_project_geobound_denied_country_set:
          type: string
          format: uuid
          nullable: true
        default_project_geobound_block_vpn:
          type: boolean
        default_project_geobound_fail_closed:
          type: boolean
        avatar_variant:
          oneOf:
            - $ref: '#/components/schemas/AvatarVariantEnum'
            - $ref: '#/components/schemas/BlankEnum'
        avatar_color:
          type: string
          maxLength: 7
        default_bibliometric_format:
          $ref: '#/components/schemas/BibliometricFormatEnum'
    Me:
      type: object
      description: |-
        Resolve ``user.person`` once per serialization pass.

        ``user.person`` memoizes per instance, but distinct users in a list are
        distinct instances — so a list serializer would still issue one
        ``Person`` query per row. When used ``many=True`` this mixin routes
        through :class:`_PersonReadThroughListSerializer`, which calls
        ``User.attach_persons`` to batch the whole page into a single query;
        the per-render ``context`` cache below then dedups the name+email
        double-read for each user.

        The context cache lives only for the lifetime of the serializer tree,
        so one ``.data`` render resolves each distinct user's ``Person`` at
        most once and re-batches fresh on the next render.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        is_system_admin:
          type: boolean
          readOnly: true
        is_repository_admin:
          type: boolean
          readOnly: true
        person_id:
          type: string
          format: uuid
          readOnly: true
        visible_outside_org:
          type: boolean
          readOnly: true
        email_pending_verification:
          type: string
          nullable: true
          readOnly: true
        root_collection_id:
          type: string
          format: uuid
          readOnly: true
        sole_organization_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        admin_organizations:
          type: array
          items:
            $ref: '#/components/schemas/Organization'
          readOnly: true
        memberships:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationMembership'
          readOnly: true
        avatar_url:
          type: string
          nullable: true
          readOnly: true
        avatar_variant:
          allOf:
            - $ref: '#/components/schemas/AvatarVariantEnum'
          readOnly: true
        avatar_color:
          type: string
          readOnly: true
        custom_ollama_url:
          type: string
          readOnly: true
        custom_ollama_model:
          type: string
          readOnly: true
        custom_clip_service_url:
          type: string
          readOnly: true
        has_custom_clip_service_token:
          type: boolean
          readOnly: true
        ai_search_enabled:
          type: boolean
          readOnly: true
        embeddings_enabled:
          type: boolean
          readOnly: true
        default_project_geobound_enabled:
          type: boolean
          readOnly: true
        default_project_geobound_basis:
          allOf:
            - $ref: '#/components/schemas/GeoboundBasisEnum'
          readOnly: true
        default_project_geobound_allowed_countries:
          type: array
          items:
            type: string
            pattern: ^[A-Z]{2}$
            maxLength: 2
          readOnly: true
        default_project_geobound_allowed_country_set:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        default_project_geobound_denied_country_set:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        default_project_geobound_block_vpn:
          type: boolean
          readOnly: true
        default_project_geobound_fail_closed:
          type: boolean
          readOnly: true
        collection_projection_enabled:
          type: boolean
          readOnly: true
        default_bibliometric_format:
          allOf:
            - $ref: '#/components/schemas/BibliometricFormatEnum'
          readOnly: true
      required:
        - admin_organizations
        - ai_search_enabled
        - avatar_color
        - avatar_url
        - avatar_variant
        - collection_projection_enabled
        - custom_clip_service_url
        - custom_ollama_model
        - custom_ollama_url
        - default_bibliometric_format
        - default_project_geobound_allowed_countries
        - default_project_geobound_allowed_country_set
        - default_project_geobound_basis
        - default_project_geobound_block_vpn
        - default_project_geobound_denied_country_set
        - default_project_geobound_enabled
        - default_project_geobound_fail_closed
        - email
        - email_pending_verification
        - embeddings_enabled
        - has_custom_clip_service_token
        - id
        - is_repository_admin
        - is_system_admin
        - memberships
        - name
        - person_id
        - root_collection_id
        - sole_organization_id
        - visible_outside_org
    GeoboundBasisEnum:
      enum:
        - ip
        - affiliation
        - ip_or_affiliation
        - ip_and_affiliation
      type: string
      description: |-
        * `ip` - IP country
        * `affiliation` - Affiliation country
        * `ip_or_affiliation` - IP or affiliation country
        * `ip_and_affiliation` - IP and affiliation country
    AvatarVariantEnum:
      enum:
        - orbit
        - beam
        - spark
        - pixel
        - halo
        - ribbon
        - stack
        - wave
        - prism
        - nova
        - dash
        - corner
        - sunrise
        - signal
        - capsule
        - arc
        - gem
        - mesh
        - comet
        - portal
      type: string
      description: |-
        * `orbit` - Orbit
        * `beam` - Beam
        * `spark` - Spark
        * `pixel` - Pixel
        * `halo` - Halo
        * `ribbon` - Ribbon
        * `stack` - Stack
        * `wave` - Wave
        * `prism` - Prism
        * `nova` - Nova
        * `dash` - Dash
        * `corner` - Corner
        * `sunrise` - Sunrise
        * `signal` - Signal
        * `capsule` - Capsule
        * `arc` - Arc
        * `gem` - Gem
        * `mesh` - Mesh
        * `comet` - Comet
        * `portal` - Portal
    BlankEnum:
      enum:
        - ''
    BibliometricFormatEnum:
      enum:
        - bibtex
        - ris
        - apa
        - mla
        - chicago
      type: string
      description: |-
        * `bibtex` - BibTeX
        * `ris` - RIS
        * `apa` - APA
        * `mla` - MLA
        * `chicago` - Chicago
    Organization:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        description:
          type: string
        whitelisted_email_domains:
          type: array
          items:
            type: string
            maxLength: 255
        globus_identity_provider_id:
          type: string
          format: uuid
          nullable: true
          description: Globus institutional IdP UUID for auto-join on SSO signup.
        allow_external_ai:
          type: boolean
        allow_user_agent_config:
          type: boolean
        llm_provider_tier_preference:
          $ref: '#/components/schemas/LlmProviderTierPreferenceEnum'
        custom_ollama_url:
          type: string
          maxLength: 255
        custom_ollama_model:
          type: string
          maxLength: 128
        custom_clip_service_url:
          type: string
          maxLength: 255
        has_custom_clip_service_token:
          type: boolean
          readOnly: true
        default_repository_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        default_project_geobound_configured:
          type: boolean
        default_project_geobound_enabled:
          type: boolean
        default_project_geobound_basis:
          $ref: '#/components/schemas/GeoboundBasisEnum'
        default_project_geobound_allowed_countries:
          type: array
          items:
            type: string
            pattern: ^[A-Z]{2}$
            maxLength: 2
        default_project_geobound_allowed_country_set:
          type: string
          format: uuid
          nullable: true
        default_project_geobound_denied_country_set:
          type: string
          format: uuid
          nullable: true
        default_project_geobound_block_vpn:
          type: boolean
        default_project_geobound_fail_closed:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        member_count:
          type: integer
          readOnly: true
          default: 0
      required:
        - created_at
        - default_repository_id
        - has_custom_clip_service_token
        - id
        - member_count
        - name
        - updated_at
    OrganizationMembership:
      type: object
      description: |-
        Summary of a user's organization membership: the organization
        (``id`` + ``name``) and the user's role in it.
      properties:
        organization:
          allOf:
            - $ref: '#/components/schemas/_SlimOrg'
          readOnly: true
        role:
          allOf:
            - $ref: '#/components/schemas/OrgMemberRoleEnum'
          readOnly: true
      required:
        - organization
        - role
    LlmProviderTierPreferenceEnum:
      enum:
        - zdr
        - private_endpoint
      type: string
      description: |-
        * `zdr` - ZDR (Zero Data Retention)
        * `private_endpoint` - Private Endpoint
    _SlimOrg:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
      required:
        - id
        - name
    OrgMemberRoleEnum:
      enum:
        - member
        - admin
      type: string
      description: |-
        * `member` - Member
        * `admin` - Admin

````