SosoAPI
繁中
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
登入

使用時先載入搜尋資料。亦可直接瀏覽下方分類。

帳戶及工作空間

讀取個人資料

讀取已登入使用者自己嘅個人資料，包括顯示名稱、時區、頭像及主題；未建立資料時 profile 係 null。

POST /identity-api/user/profile/get

Contract 核對日期: · sha256:563d2d581da0ad29

閱讀 Markdown下載公開 contract下載 OpenAPI

概覽

讀取已登入使用者自己嘅個人資料，包括顯示名稱、時區、頭像及主題；未建立資料時 profile 係 null。

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

驗證及權限

接受嘅憑證類型
user_session, delegated_oauth, personal_access_token
委派權限
agent:operate
最低工作空間角色
此 contract 冇指定工作空間最低角色；仍需符合擁有權及授權檢查。
存取範圍
已登入使用者及獲授權資源範圍
需要所有工作空間同意
唔係
會改動狀態
唔係
完成依據
synchronous_http_response

憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具，唔會授權。

請求欄位

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

請求欄位
欄位／分支類型／必填限制
$object父物件內必填
  • additionalProperties: false
include_versionboolean可選／陣列項目

Optional. true adds the resource version to the answer.

—
完整 JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

回應及完成條件

成功 HTTP 狀態碼: 200. 完成依據: synchronous_http_response.

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

回應及完成條件
欄位／分支類型／必填限制
$object父物件內必填—
actionstring父物件內必填
  • const: "get"
profileobject | null父物件內必填—
profileanyOf 1object父物件內必填—
profile.user_idanyOf 1string父物件內必填
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
profile.display_nameanyOf 1string | null父物件內必填—
profile.display_nameanyOf 1 / anyOf 1string父物件內必填—
profile.display_nameanyOf 1 / anyOf 2null父物件內必填—
profile.timezoneanyOf 1string | null父物件內必填—
profile.timezoneanyOf 1 / anyOf 1string父物件內必填—
profile.timezoneanyOf 1 / anyOf 2null父物件內必填—
profile.avatar_urlanyOf 1string | null父物件內必填—
profile.avatar_urlanyOf 1 / anyOf 1string父物件內必填—
profile.avatar_urlanyOf 1 / anyOf 2null父物件內必填—
profile.avatar_preview_urlanyOf 1string | null可選／陣列項目—
profile.avatar_preview_urlanyOf 1 / anyOf 1string可選／陣列項目
  • format: "uri"
profile.avatar_preview_urlanyOf 1 / anyOf 2null可選／陣列項目—
profile.avatar_preview_expires_atanyOf 1string | null可選／陣列項目—
profile.avatar_preview_expires_atanyOf 1 / anyOf 1string可選／陣列項目
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
profile.avatar_preview_expires_atanyOf 1 / anyOf 2null可選／陣列項目—
profile.themeanyOf 1string | null父物件內必填—
profile.themeanyOf 1 / anyOf 1string父物件內必填
  • enum: ["light","dark","system"]
profile.themeanyOf 1 / anyOf 2null父物件內必填—
profile.created_atanyOf 1string | null父物件內必填—
profile.created_atanyOf 1 / anyOf 1string父物件內必填—
profile.created_atanyOf 1 / anyOf 2null父物件內必填—
profile.updated_atanyOf 1string | null父物件內必填—
profile.updated_atanyOf 1 / anyOf 1string父物件內必填—
profile.updated_atanyOf 1 / anyOf 2null父物件內必填—
profile.deletion_scheduled_atanyOf 1string | null父物件內必填—
profile.deletion_scheduled_atanyOf 1 / anyOf 1string父物件內必填—
profile.deletion_scheduled_atanyOf 1 / anyOf 2null父物件內必填—
profile.hard_delete_atanyOf 1string | null父物件內必填—
profile.hard_delete_atanyOf 1 / anyOf 1string父物件內必填—
profile.hard_delete_atanyOf 1 / anyOf 2null父物件內必填—
profile.versionanyOf 1integer可選／陣列項目
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
profileanyOf 2null父物件內必填—
完整 JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "const": "get"
    },
    "profile": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "user_id": {
              "type": "string",
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
            },
            "display_name": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "timezone": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "avatar_url": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "avatar_preview_url": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uri"
                },
                {
                  "type": "null"
                }
              ]
            },
            "avatar_preview_expires_at": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "theme": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "light",
                    "dark",
                    "system"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "created_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "updated_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "deletion_scheduled_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "hard_delete_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "version": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "user_id",
            "display_name",
            "timezone",
            "avatar_url",
            "theme",
            "created_at",
            "updated_at",
            "deletion_scheduled_at",
            "hard_delete_at"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "action",
    "profile"
  ]
}

錯誤及安全重試

檢查 HTTP 狀態及實際回應格式。驗證400可能回傳 ZodError；handler 錯誤可能係 error／message／code envelope。保留可用嘅 request_id 或 x-request-id，唔好記錄憑證。401／403先修正存取問題；429遵守 Retry-After。寫入結果未明或5xx時，先讀原有結果，再決定重試；只喺操作支援時重用 idempotency key，並冇通用重試或 exactly-once 保證。

問題排解指南

範例

以下虛構值已按 contract 驗證，唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代，寫入前核對平台資格。此頁唔會呼叫 API。

喺伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth，由 CLI 管理憑證更新。

request.json

{}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/get" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/get", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/user/profile/get < request.json

虛構回應範例

{
  "action": "get",
  "profile": null
}

MCP: sosoapi_get_user_profile

所有 API 操作驗證及權限