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

# Get Your Personal Profile

> Retrieve the calling user's personal profile: the chat-context fields the web UI exposes under Settings → Profile. A profile that has never been saved is returned with default values.

Display name and avatar are managed by your identity provider, not this API, so they are not included.

Requires a **user-scoped** key (`u:gcai_...`); org-scoped keys carry no user identity and receive 403.



## OpenAPI

````yaml GET /me/profile
openapi: 3.0.3
info:
  title: GC AI External API
  version: 1.0.0
  description: >-
    The GC AI External API allows programmatic access to GC AI's chat
    capabilities. It's designed for integration with workflow automation tools
    like Zapier, Make, n8n, or custom applications.


    ## Authentication


    All API requests must include an API key in the `Authorization` header:


    ```

    Authorization: gcai_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    ```


    API keys can be created in the GC AI app under **Settings → API**.


    ## Multi-turn Conversations


    Conversations can span multiple turns: pass the `chat_id` returned by a
    completion back on your next request to continue the same chat. See
    [Multi-turn Conversations](/api-reference/concepts/multi-turn).


    ## Current Limitations


    The following is not yet available via API:


    - **Interactive clarification**: the model cannot pause to ask the caller a
    follow-up question; the `askUserQuestions` tool is disabled on the API
    surface


    ## Usage


    Usage is tracked and viewable in the GC AI app under **Settings → API → View
    Usage**.


    ## Support


    For API support, contact [support@gc.ai](mailto:support@gc.ai) or reach out
    to your account representative.
  contact:
    email: support@gc.ai
servers:
  - url: https://app.gc.ai/api/external/v1
    description: Production server
security: []
tags:
  - name: Async Jobs
    description: Poll the status and result of asynchronous API jobs
  - name: Chat
    description: AI chat completion endpoints
  - name: Files
    description: File upload and management endpoints
  - name: Folders
    description: Folder management endpoints
  - name: Playbooks
    description: Playbook review endpoints
  - name: Profiles
    description: Personal and company profile endpoints
  - name: Projects
    description: Project management endpoints
  - name: Skills
    description: Skill library management endpoints
  - name: Utility
    description: Health check and connectivity endpoints
  - name: Usage
    description: Usage and credit/billing reporting endpoints
paths:
  /me/profile:
    get:
      tags:
        - Profiles
      summary: Get your personal profile
      description: >-
        Retrieve the calling user's personal profile: the chat-context fields
        the web UI exposes under Settings → Profile. A profile that has never
        been saved is returned with default values.


        Display name and avatar are managed by your identity provider, not this
        API, so they are not included.


        Requires a **user-scoped** key (`u:gcai_...`); org-scoped keys carry no
        user identity and receive 403.
      operationId: getMyProfile
      responses:
        '200':
          description: The personal profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonalProfileResponse'
        '401':
          description: Missing or malformed API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key is not user-scoped, or the API key is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit exceeded. See [Rate
            Limits](/api-reference/concepts/rate-limits) for the tiers, limits,
            and how to back off.
          headers:
            Retry-After:
              schema:
                type: string
                description: Seconds to wait before retrying after a rate-limit block.
                example: '60'
              required: true
              description: Seconds to wait before retrying after a rate-limit block.
            RateLimit-Limit:
              schema:
                type: string
                description: Request quota for the applicable window.
                example: '3'
              required: true
              description: Request quota for the applicable window.
            RateLimit-Remaining:
              schema:
                type: string
                description: Requests remaining in the current window.
                example: '0'
              required: true
              description: Requests remaining in the current window.
            RateLimit-Reset:
              schema:
                type: string
                description: Seconds until the quota resets.
                example: '60'
              required: true
              description: Seconds until the quota resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service temporarily unavailable
          headers:
            Retry-After:
              schema:
                type: string
                description: >-
                  Seconds to wait before retrying after a transient service
                  outage.
                example: '5'
              required: true
              description: >-
                Seconds to wait before retrying after a transient service
                outage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PersonalProfileResponse:
      type: object
      properties:
        preferred_name:
          type: string
          nullable: true
          description: Preferred name to use in chats, or null if unset
        use_name_in_chats:
          type: boolean
          description: Whether the AI should address the user by name
        role_title:
          type: string
          nullable: true
          description: Job title or role (e.g. "General Counsel"), or null
        jurisdiction_focus:
          type: string
          nullable: true
          description: Primary jurisdiction the user practices in, or null
        practice_areas:
          type: array
          items:
            type: string
          description: Practice areas the user focuses on (may be empty)
        custom_instructions:
          type: string
          nullable: true
          description: Custom instructions injected into every chat, or null
        privilege_marking_enabled:
          type: boolean
          description: Whether AI responses include an attorney-client privilege disclaimer
        privilege_marking_text:
          type: string
          nullable: true
          description: The privilege disclaimer text, or null if unset
        enter_to_submit:
          type: boolean
          description: Whether the chat composer submits on Enter instead of Cmd/Ctrl+Enter
        document_author_name:
          type: string
          nullable: true
          description: Name stamped on tracked changes when AI edits are applied, or null
        enabled:
          type: boolean
          description: Whether the personal profile is active and applied to chats
        created_at:
          type: string
          nullable: true
          description: ISO 8601 creation timestamp, or null if never saved
        updated_at:
          type: string
          nullable: true
          description: ISO 8601 last-update timestamp, or null if never saved
      required:
        - preferred_name
        - use_name_in_chats
        - role_title
        - jurisdiction_focus
        - practice_areas
        - custom_instructions
        - privilege_marking_enabled
        - privilege_marking_text
        - enter_to_submit
        - document_author_name
        - enabled
        - created_at
        - updated_at
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: >-
            Machine-readable error code present on some errors (e.g.
            `RATE_LIMITED`, `INSUFFICIENT_CREDITS`, `TRIAL_NOT_STARTED`,
            `BILLING_NOT_CONFIGURED`). Branch on this rather than the
            human-readable `error` string.
        message:
          type: string
          description: Additional error details
        details:
          type: object
          additionalProperties:
            nullable: true
          description: Validation error details (for 400 errors)
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |-
        API key for authentication. Format: `gcai_xxxxxxxxx`

        Create API keys in the GC AI app under Settings → API.

````