Patch apime

cURL

curl --request PATCH \
  --url https://{server}/api/me/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "visible_outside_org": true,
  "custom_ollama_url": "<string>",
  "custom_ollama_model": "<string>",
  "custom_clip_service_url": "<string>",
  "custom_clip_service_token": "<string>",
  "ai_search_enabled": true,
  "embeddings_enabled": true,
  "default_project_geobound_enabled": true,
  "default_project_geobound_allowed_countries": [
    "<string>"
  ],
  "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_block_vpn": true,
  "default_project_geobound_fail_closed": true,
  "avatar_color": "<string>"
}
'

import requests

url = "https://{server}/api/me/"

payload = {
    "name": "<string>",
    "visible_outside_org": True,
    "custom_ollama_url": "<string>",
    "custom_ollama_model": "<string>",
    "custom_clip_service_url": "<string>",
    "custom_clip_service_token": "<string>",
    "ai_search_enabled": True,
    "embeddings_enabled": True,
    "default_project_geobound_enabled": True,
    "default_project_geobound_allowed_countries": ["<string>"],
    "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_project_geobound_block_vpn": True,
    "default_project_geobound_fail_closed": True,
    "avatar_color": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    visible_outside_org: true,
    custom_ollama_url: '<string>',
    custom_ollama_model: '<string>',
    custom_clip_service_url: '<string>',
    custom_clip_service_token: '<string>',
    ai_search_enabled: true,
    embeddings_enabled: true,
    default_project_geobound_enabled: true,
    default_project_geobound_allowed_countries: ['<string>'],
    default_project_geobound_allowed_country_set: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    default_project_geobound_denied_country_set: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    default_project_geobound_block_vpn: true,
    default_project_geobound_fail_closed: true,
    avatar_color: '<string>'
  })
};

fetch('https://{server}/api/me/', 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://{server}/api/me/",
  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([
    'name' => '<string>',
    'visible_outside_org' => true,
    'custom_ollama_url' => '<string>',
    'custom_ollama_model' => '<string>',
    'custom_clip_service_url' => '<string>',
    'custom_clip_service_token' => '<string>',
    'ai_search_enabled' => true,
    'embeddings_enabled' => true,
    'default_project_geobound_enabled' => true,
    'default_project_geobound_allowed_countries' => [
        '<string>'
    ],
    'default_project_geobound_allowed_country_set' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'default_project_geobound_denied_country_set' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'default_project_geobound_block_vpn' => true,
    'default_project_geobound_fail_closed' => true,
    'avatar_color' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://{server}/api/me/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"visible_outside_org\": true,\n  \"custom_ollama_url\": \"<string>\",\n  \"custom_ollama_model\": \"<string>\",\n  \"custom_clip_service_url\": \"<string>\",\n  \"custom_clip_service_token\": \"<string>\",\n  \"ai_search_enabled\": true,\n  \"embeddings_enabled\": true,\n  \"default_project_geobound_enabled\": true,\n  \"default_project_geobound_allowed_countries\": [\n    \"<string>\"\n  ],\n  \"default_project_geobound_allowed_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_denied_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_block_vpn\": true,\n  \"default_project_geobound_fail_closed\": true,\n  \"avatar_color\": \"<string>\"\n}")

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

	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://{server}/api/me/")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"visible_outside_org\": true,\n  \"custom_ollama_url\": \"<string>\",\n  \"custom_ollama_model\": \"<string>\",\n  \"custom_clip_service_url\": \"<string>\",\n  \"custom_clip_service_token\": \"<string>\",\n  \"ai_search_enabled\": true,\n  \"embeddings_enabled\": true,\n  \"default_project_geobound_enabled\": true,\n  \"default_project_geobound_allowed_countries\": [\n    \"<string>\"\n  ],\n  \"default_project_geobound_allowed_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_denied_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_block_vpn\": true,\n  \"default_project_geobound_fail_closed\": true,\n  \"avatar_color\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server}/api/me/")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"visible_outside_org\": true,\n  \"custom_ollama_url\": \"<string>\",\n  \"custom_ollama_model\": \"<string>\",\n  \"custom_clip_service_url\": \"<string>\",\n  \"custom_clip_service_token\": \"<string>\",\n  \"ai_search_enabled\": true,\n  \"embeddings_enabled\": true,\n  \"default_project_geobound_enabled\": true,\n  \"default_project_geobound_allowed_countries\": [\n    \"<string>\"\n  ],\n  \"default_project_geobound_allowed_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_denied_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_block_vpn\": true,\n  \"default_project_geobound_fail_closed\": true,\n  \"avatar_color\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "name": "<string>",
  "is_system_admin": true,
  "is_repository_admin": true,
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visible_outside_org": true,
  "email_pending_verification": "<string>",
  "root_collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sole_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "admin_organizations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "has_custom_clip_service_token": true,
      "default_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "member_count": 0,
      "description": "<string>",
      "whitelisted_email_domains": [
        "<string>"
      ],
      "globus_identity_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allow_external_ai": true,
      "allow_user_agent_config": true,
      "custom_ollama_url": "<string>",
      "custom_ollama_model": "<string>",
      "custom_clip_service_url": "<string>",
      "default_project_geobound_configured": true,
      "default_project_geobound_enabled": true,
      "default_project_geobound_allowed_countries": [
        "<string>"
      ],
      "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "default_project_geobound_block_vpn": true,
      "default_project_geobound_fail_closed": true
    }
  ],
  "memberships": [
    {
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "avatar_url": "<string>",
  "avatar_color": "<string>",
  "custom_ollama_url": "<string>",
  "custom_ollama_model": "<string>",
  "custom_clip_service_url": "<string>",
  "has_custom_clip_service_token": true,
  "ai_search_enabled": true,
  "embeddings_enabled": true,
  "default_project_geobound_enabled": true,
  "default_project_geobound_allowed_countries": [
    "<string>"
  ],
  "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_block_vpn": true,
  "default_project_geobound_fail_closed": true,
  "collection_projection_enabled": true
}

PATCH

api

cURL

curl --request PATCH \
  --url https://{server}/api/me/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "visible_outside_org": true,
  "custom_ollama_url": "<string>",
  "custom_ollama_model": "<string>",
  "custom_clip_service_url": "<string>",
  "custom_clip_service_token": "<string>",
  "ai_search_enabled": true,
  "embeddings_enabled": true,
  "default_project_geobound_enabled": true,
  "default_project_geobound_allowed_countries": [
    "<string>"
  ],
  "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_block_vpn": true,
  "default_project_geobound_fail_closed": true,
  "avatar_color": "<string>"
}
'

import requests

url = "https://{server}/api/me/"

payload = {
    "name": "<string>",
    "visible_outside_org": True,
    "custom_ollama_url": "<string>",
    "custom_ollama_model": "<string>",
    "custom_clip_service_url": "<string>",
    "custom_clip_service_token": "<string>",
    "ai_search_enabled": True,
    "embeddings_enabled": True,
    "default_project_geobound_enabled": True,
    "default_project_geobound_allowed_countries": ["<string>"],
    "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_project_geobound_block_vpn": True,
    "default_project_geobound_fail_closed": True,
    "avatar_color": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    visible_outside_org: true,
    custom_ollama_url: '<string>',
    custom_ollama_model: '<string>',
    custom_clip_service_url: '<string>',
    custom_clip_service_token: '<string>',
    ai_search_enabled: true,
    embeddings_enabled: true,
    default_project_geobound_enabled: true,
    default_project_geobound_allowed_countries: ['<string>'],
    default_project_geobound_allowed_country_set: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    default_project_geobound_denied_country_set: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    default_project_geobound_block_vpn: true,
    default_project_geobound_fail_closed: true,
    avatar_color: '<string>'
  })
};

fetch('https://{server}/api/me/', 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://{server}/api/me/",
  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([
    'name' => '<string>',
    'visible_outside_org' => true,
    'custom_ollama_url' => '<string>',
    'custom_ollama_model' => '<string>',
    'custom_clip_service_url' => '<string>',
    'custom_clip_service_token' => '<string>',
    'ai_search_enabled' => true,
    'embeddings_enabled' => true,
    'default_project_geobound_enabled' => true,
    'default_project_geobound_allowed_countries' => [
        '<string>'
    ],
    'default_project_geobound_allowed_country_set' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'default_project_geobound_denied_country_set' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'default_project_geobound_block_vpn' => true,
    'default_project_geobound_fail_closed' => true,
    'avatar_color' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://{server}/api/me/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"visible_outside_org\": true,\n  \"custom_ollama_url\": \"<string>\",\n  \"custom_ollama_model\": \"<string>\",\n  \"custom_clip_service_url\": \"<string>\",\n  \"custom_clip_service_token\": \"<string>\",\n  \"ai_search_enabled\": true,\n  \"embeddings_enabled\": true,\n  \"default_project_geobound_enabled\": true,\n  \"default_project_geobound_allowed_countries\": [\n    \"<string>\"\n  ],\n  \"default_project_geobound_allowed_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_denied_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_block_vpn\": true,\n  \"default_project_geobound_fail_closed\": true,\n  \"avatar_color\": \"<string>\"\n}")

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

	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://{server}/api/me/")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"visible_outside_org\": true,\n  \"custom_ollama_url\": \"<string>\",\n  \"custom_ollama_model\": \"<string>\",\n  \"custom_clip_service_url\": \"<string>\",\n  \"custom_clip_service_token\": \"<string>\",\n  \"ai_search_enabled\": true,\n  \"embeddings_enabled\": true,\n  \"default_project_geobound_enabled\": true,\n  \"default_project_geobound_allowed_countries\": [\n    \"<string>\"\n  ],\n  \"default_project_geobound_allowed_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_denied_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_block_vpn\": true,\n  \"default_project_geobound_fail_closed\": true,\n  \"avatar_color\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server}/api/me/")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"visible_outside_org\": true,\n  \"custom_ollama_url\": \"<string>\",\n  \"custom_ollama_model\": \"<string>\",\n  \"custom_clip_service_url\": \"<string>\",\n  \"custom_clip_service_token\": \"<string>\",\n  \"ai_search_enabled\": true,\n  \"embeddings_enabled\": true,\n  \"default_project_geobound_enabled\": true,\n  \"default_project_geobound_allowed_countries\": [\n    \"<string>\"\n  ],\n  \"default_project_geobound_allowed_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_denied_country_set\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_project_geobound_block_vpn\": true,\n  \"default_project_geobound_fail_closed\": true,\n  \"avatar_color\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "name": "<string>",
  "is_system_admin": true,
  "is_repository_admin": true,
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visible_outside_org": true,
  "email_pending_verification": "<string>",
  "root_collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sole_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "admin_organizations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "has_custom_clip_service_token": true,
      "default_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "member_count": 0,
      "description": "<string>",
      "whitelisted_email_domains": [
        "<string>"
      ],
      "globus_identity_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allow_external_ai": true,
      "allow_user_agent_config": true,
      "custom_ollama_url": "<string>",
      "custom_ollama_model": "<string>",
      "custom_clip_service_url": "<string>",
      "default_project_geobound_configured": true,
      "default_project_geobound_enabled": true,
      "default_project_geobound_allowed_countries": [
        "<string>"
      ],
      "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "default_project_geobound_block_vpn": true,
      "default_project_geobound_fail_closed": true
    }
  ],
  "memberships": [
    {
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "avatar_url": "<string>",
  "avatar_color": "<string>",
  "custom_ollama_url": "<string>",
  "custom_ollama_model": "<string>",
  "custom_clip_service_url": "<string>",
  "has_custom_clip_service_token": true,
  "ai_search_enabled": true,
  "embeddings_enabled": true,
  "default_project_geobound_enabled": true,
  "default_project_geobound_allowed_countries": [
    "<string>"
  ],
  "default_project_geobound_allowed_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_denied_country_set": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_project_geobound_block_vpn": true,
  "default_project_geobound_fail_closed": true,
  "collection_projection_enabled": true
}

Body

Updatable non-email profile fields. Email changes are handled through a separate flow and are not accepted here.

name

string

Maximum string length: 255

visible_outside_org

boolean

custom_ollama_url

string

Maximum string length: 255

custom_ollama_model

string

Maximum string length: 128

custom_clip_service_url

string

Maximum string length: 255

custom_clip_service_token

string

write-only

Maximum string length: 4096

ai_search_enabled

boolean

embeddings_enabled

boolean

default_project_geobound_enabled

boolean

default_project_geobound_basis

enum<string>

ip - IP country
affiliation - Affiliation country
ip_or_affiliation - IP or affiliation country
ip_and_affiliation - IP and affiliation country

Available options:

ip,

affiliation,

ip_or_affiliation,

ip_and_affiliation

default_project_geobound_allowed_countries

string[]

default_project_geobound_allowed_country_set

string<uuid> | null

default_project_geobound_denied_country_set

string<uuid> | null

default_project_geobound_block_vpn

boolean

default_project_geobound_fail_closed

boolean

avatar_variant

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

Available options:

orbit,

beam,

spark,

pixel,

halo,

ribbon,

stack,

wave,

prism,

nova,

dash,

corner,

sunrise,

signal,

capsule,

arc,

gem,

mesh,

comet,

portal

avatar_color

string

Maximum string length: 7

default_bibliometric_format

enum<string>

bibtex - BibTeX
ris - RIS
apa - APA
mla - MLA
chicago - Chicago

Available options:

bibtex,

ris,

apa,

mla,

chicago

Response

200 - application/json

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.

string<uuid>

required

read-only

string

required

read-only

name

string

required

read-only

is_system_admin

boolean

required

read-only

is_repository_admin

boolean

required

read-only

person_id

string<uuid>

required

read-only

visible_outside_org

boolean

required

read-only

email_pending_verification

string | null

required

read-only

root_collection_id

string<uuid>

required

read-only

sole_organization_id

string<uuid> | null

required

read-only

admin_organizations

object[]

required

read-only

Show child attributes

memberships

object[]

required

read-only

Show child attributes

avatar_url

string | null

required

read-only

avatar_variant

enum<string>

required

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

Available options:

orbit,

beam,

spark,

pixel,

halo,

ribbon,

stack,

wave,

prism,

nova,

dash,

corner,

sunrise,

signal,

capsule,

arc,

gem,

mesh,

comet,

portal

avatar_color

string

required

read-only

custom_ollama_url

string

required

read-only

custom_ollama_model

string

required

read-only

custom_clip_service_url

string

required

read-only

has_custom_clip_service_token

boolean

required

read-only

ai_search_enabled

boolean

required

read-only

embeddings_enabled

boolean

required

read-only

default_project_geobound_enabled

boolean

required

read-only

default_project_geobound_basis

enum<string>

required

ip - IP country
affiliation - Affiliation country
ip_or_affiliation - IP or affiliation country
ip_and_affiliation - IP and affiliation country

Available options:

ip,

affiliation,

ip_or_affiliation,

ip_and_affiliation

default_project_geobound_allowed_countries

string[]

required

read-only

Maximum string length: 2

Pattern: ^[A-Z]{2}$

default_project_geobound_allowed_country_set

string<uuid> | null

required

read-only

default_project_geobound_denied_country_set

string<uuid> | null

required

read-only

default_project_geobound_block_vpn

boolean

required

read-only

default_project_geobound_fail_closed

boolean

required

read-only

collection_projection_enabled

boolean

required

read-only

default_bibliometric_format

enum<string>

required

bibtex - BibTeX
ris - RIS
apa - APA
mla - MLA
chicago - Chicago

Available options:

bibtex,

ris,

apa,

mla,

chicago

⌘I

Get started

Endpoints

Body

Response