Skip to main content
PATCH
/
me
/
profile
Update your personal profile
curl --request PATCH \
  --url https://app.gc.ai/api/external/v1/me/profile \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "preferred_name": "<string>",
  "use_name_in_chats": true,
  "role_title": "<string>",
  "jurisdiction_focus": "<string>",
  "practice_areas": [
    "<string>"
  ],
  "custom_instructions": "<string>",
  "privilege_marking_enabled": true,
  "privilege_marking_text": "<string>",
  "enter_to_submit": true,
  "document_author_name": "<string>",
  "enabled": true
}
'
import requests

url = "https://app.gc.ai/api/external/v1/me/profile"

payload = {
"preferred_name": "<string>",
"use_name_in_chats": True,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": ["<string>"],
"custom_instructions": "<string>",
"privilege_marking_enabled": True,
"privilege_marking_text": "<string>",
"enter_to_submit": True,
"document_author_name": "<string>",
"enabled": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
preferred_name: '<string>',
use_name_in_chats: true,
role_title: '<string>',
jurisdiction_focus: '<string>',
practice_areas: ['<string>'],
custom_instructions: '<string>',
privilege_marking_enabled: true,
privilege_marking_text: '<string>',
enter_to_submit: true,
document_author_name: '<string>',
enabled: true
})
};

fetch('https://app.gc.ai/api/external/v1/me/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.gc.ai/api/external/v1/me/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'preferred_name' => '<string>',
'use_name_in_chats' => true,
'role_title' => '<string>',
'jurisdiction_focus' => '<string>',
'practice_areas' => [
'<string>'
],
'custom_instructions' => '<string>',
'privilege_marking_enabled' => true,
'privilege_marking_text' => '<string>',
'enter_to_submit' => true,
'document_author_name' => '<string>',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.gc.ai/api/external/v1/me/profile"

payload := strings.NewReader("{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://app.gc.ai/api/external/v1/me/profile")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.gc.ai/api/external/v1/me/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "preferred_name": "<string>",
  "use_name_in_chats": true,
  "role_title": "<string>",
  "jurisdiction_focus": "<string>",
  "practice_areas": [
    "<string>"
  ],
  "custom_instructions": "<string>",
  "privilege_marking_enabled": true,
  "privilege_marking_text": "<string>",
  "enter_to_submit": true,
  "document_author_name": "<string>",
  "enabled": true,
  "created_at": "<string>",
  "updated_at": "<string>"
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

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

Body

application/json
preferred_name
string | null

Preferred name to use in chats. Send null to clear.

Maximum string length: 100
use_name_in_chats
boolean

Whether the AI should address the user by name

role_title
string | null

Job title or role. Send null to clear.

Maximum string length: 200
jurisdiction_focus
string | null

Primary jurisdiction. Send null to clear.

Maximum string length: 255
practice_areas
string[] | null

Practice areas (max 20). Send null or [] to clear.

Maximum array length: 20
Maximum string length: 100
custom_instructions
string | null

Custom instructions for every chat. Send null to clear.

Maximum string length: 4000
privilege_marking_enabled
boolean

Whether AI responses include an attorney-client privilege disclaimer

privilege_marking_text
string | null

Privilege disclaimer text. Send null to clear.

Maximum string length: 200
enter_to_submit
boolean

Whether the chat composer submits on Enter instead of Cmd/Ctrl+Enter

document_author_name
string | null

Name stamped on AI tracked changes. Send null to clear.

Maximum string length: 100
enabled
boolean

Whether the personal profile is active

Response

The updated personal profile

preferred_name
string | null
required

Preferred name to use in chats, or null if unset

use_name_in_chats
boolean
required

Whether the AI should address the user by name

role_title
string | null
required

Job title or role (e.g. "General Counsel"), or null

jurisdiction_focus
string | null
required

Primary jurisdiction the user practices in, or null

practice_areas
string[]
required

Practice areas the user focuses on (may be empty)

custom_instructions
string | null
required

Custom instructions injected into every chat, or null

privilege_marking_enabled
boolean
required

Whether AI responses include an attorney-client privilege disclaimer

privilege_marking_text
string | null
required

The privilege disclaimer text, or null if unset

enter_to_submit
boolean
required

Whether the chat composer submits on Enter instead of Cmd/Ctrl+Enter

document_author_name
string | null
required

Name stamped on tracked changes when AI edits are applied, or null

enabled
boolean
required

Whether the personal profile is active and applied to chats

created_at
string | null
required

ISO 8601 creation timestamp, or null if never saved

updated_at
string | null
required

ISO 8601 last-update timestamp, or null if never saved