專案及內容
更新專案內容設定
局部更新專案品牌設定,冇傳嘅欄位保持原樣。需要最新 expected_profile_version、idempotency_key 及 editor 角色。
POST /studio-api/projects/profile/updateContract 核對日期: · sha256:563d2d581da0ad29
概覽
局部更新專案品牌設定,冇傳嘅欄位保持原樣。需要最新 expected_profile_version、idempotency_key 及 editor 角色。
HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID,讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時,都唔代表已發佈。
驗證及權限
憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具,唔會授權。
請求欄位
必填表示喺所屬物件及所選分支內必須提供;子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位/分支 | 類型/必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
project_id | string父物件內必填 |
|
expected_profile_version | integer父物件內必填 |
|
idempotency_key | string父物件內必填 |
|
patch | object父物件內必填 |
|
patch.tagline | string | null可選/陣列項目 | — |
patch.taglineanyOf 1 | string可選/陣列項目 |
|
patch.taglineanyOf 2 | null可選/陣列項目 | — |
patch.description | string | null可選/陣列項目 | — |
patch.descriptionanyOf 1 | string可選/陣列項目 |
|
patch.descriptionanyOf 2 | null可選/陣列項目 | — |
patch.voice | string | null可選/陣列項目 | — |
patch.voiceanyOf 1 | string可選/陣列項目 |
|
patch.voiceanyOf 2 | null可選/陣列項目 | — |
patch.target_audience | string | null可選/陣列項目 | — |
patch.target_audienceanyOf 1 | string可選/陣列項目 |
|
patch.target_audienceanyOf 2 | null可選/陣列項目 | — |
patch.color_palette | array可選/陣列項目 |
|
patch.color_palette[] | string可選/陣列項目 |
|
patch.goals | array可選/陣列項目 |
|
patch.goals[] | string可選/陣列項目 |
|
patch.no_go_topics | array可選/陣列項目 |
|
patch.no_go_topics[] | string可選/陣列項目 |
|
patch.language_primary | string可選/陣列項目 |
|
patch.positioning | string | null可選/陣列項目 | — |
patch.positioninganyOf 1 | string可選/陣列項目 |
|
patch.positioninganyOf 2 | null可選/陣列項目 | — |
patch.usp | string | null可選/陣列項目 | — |
patch.uspanyOf 1 | string可選/陣列項目 |
|
patch.uspanyOf 2 | null可選/陣列項目 | — |
patch.visual_identity | object | null可選/陣列項目 | — |
patch.visual_identityanyOf 1 | object可選/陣列項目 |
|
patch.visual_identity.*anyOf 1 | any JSON value可選/陣列項目 | — |
patch.visual_identityanyOf 2 | null可選/陣列項目 | — |
patch.forbidden_claims | array可選/陣列項目 |
|
patch.forbidden_claims[] | string可選/陣列項目 |
|
patch.north_star_metric | string | null可選/陣列項目 | — |
patch.north_star_metricanyOf 1 | string可選/陣列項目 |
|
patch.north_star_metricanyOf 2 | null可選/陣列項目 | — |
patch.posting_cadence | object | null可選/陣列項目 | — |
patch.posting_cadenceanyOf 1 | object可選/陣列項目 |
|
patch.posting_cadence.*anyOf 1 | any JSON value可選/陣列項目 | — |
patch.posting_cadenceanyOf 2 | null可選/陣列項目 | — |
patch.app_store_url_ios | string | null可選/陣列項目 | — |
patch.app_store_url_iosanyOf 1 | string可選/陣列項目 |
|
patch.app_store_url_iosanyOf 2 | null可選/陣列項目 | — |
patch.app_store_url_android | string | null可選/陣列項目 | — |
patch.app_store_url_androidanyOf 1 | string可選/陣列項目 |
|
patch.app_store_url_androidanyOf 2 | null可選/陣列項目 | — |
patch.app_metadata | object可選/陣列項目 |
|
patch.app_metadata.* | any JSON value可選/陣列項目 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"project_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)$"
},
"expected_profile_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotency_key": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"patch": {
"type": "object",
"properties": {
"tagline": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"voice": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"target_audience": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"color_palette": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 64
}
},
"goals": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 160
}
},
"no_go_topics": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 160
}
},
"language_primary": {
"type": "string",
"minLength": 2,
"maxLength": 35
},
"positioning": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"usp": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"visual_identity": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"forbidden_claims": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 240
}
},
"north_star_metric": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"posting_cadence": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"app_store_url_ios": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"app_store_url_android": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"app_metadata": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"additionalProperties": false
}
},
"required": [
"project_id",
"expected_profile_version",
"idempotency_key",
"patch"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: synchronous_http_response.
HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID,讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時,都唔代表已發佈。
必填表示喺所屬物件及所選分支內必須提供;子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位/分支 | 類型/必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
contract_version | string父物件內必填 |
|
profile | object父物件內必填 | — |
profile.project_id | string父物件內必填 |
|
profile.workspace_id | string父物件內必填 |
|
profile.tagline | string | null父物件內必填 | — |
profile.taglineanyOf 1 | string父物件內必填 | — |
profile.taglineanyOf 2 | null父物件內必填 | — |
profile.description | string | null父物件內必填 | — |
profile.descriptionanyOf 1 | string父物件內必填 | — |
profile.descriptionanyOf 2 | null父物件內必填 | — |
profile.voice | string | null父物件內必填 | — |
profile.voiceanyOf 1 | string父物件內必填 | — |
profile.voiceanyOf 2 | null父物件內必填 | — |
profile.target_audience | string | null父物件內必填 | — |
profile.target_audienceanyOf 1 | string父物件內必填 | — |
profile.target_audienceanyOf 2 | null父物件內必填 | — |
profile.color_palette | array父物件內必填 | — |
profile.color_palette[] | string可選/陣列項目 | — |
profile.goals | array父物件內必填 | — |
profile.goals[] | string可選/陣列項目 | — |
profile.no_go_topics | array父物件內必填 | — |
profile.no_go_topics[] | string可選/陣列項目 | — |
profile.language_primary | string父物件內必填 | — |
profile.positioning | string | null父物件內必填 | — |
profile.positioninganyOf 1 | string父物件內必填 | — |
profile.positioninganyOf 2 | null父物件內必填 | — |
profile.usp | string | null父物件內必填 | — |
profile.uspanyOf 1 | string父物件內必填 | — |
profile.uspanyOf 2 | null父物件內必填 | — |
profile.visual_identity | object | null父物件內必填 | — |
profile.visual_identityanyOf 1 | object父物件內必填 |
|
profile.visual_identity.*anyOf 1 | any JSON value可選/陣列項目 | — |
profile.visual_identityanyOf 2 | null父物件內必填 | — |
profile.forbidden_claims | array父物件內必填 | — |
profile.forbidden_claims[] | string可選/陣列項目 | — |
profile.north_star_metric | string | null父物件內必填 | — |
profile.north_star_metricanyOf 1 | string父物件內必填 | — |
profile.north_star_metricanyOf 2 | null父物件內必填 | — |
profile.posting_cadence | object | null父物件內必填 | — |
profile.posting_cadenceanyOf 1 | object父物件內必填 |
|
profile.posting_cadence.*anyOf 1 | any JSON value可選/陣列項目 | — |
profile.posting_cadenceanyOf 2 | null父物件內必填 | — |
profile.app_store_url_ios | string | null父物件內必填 | — |
profile.app_store_url_iosanyOf 1 | string父物件內必填 | — |
profile.app_store_url_iosanyOf 2 | null父物件內必填 | — |
profile.app_store_url_android | string | null父物件內必填 | — |
profile.app_store_url_androidanyOf 1 | string父物件內必填 | — |
profile.app_store_url_androidanyOf 2 | null父物件內必填 | — |
profile.app_metadata | object父物件內必填 |
|
profile.app_metadata.* | any JSON value可選/陣列項目 | — |
profile.profile_version | integer父物件內必填 |
|
profile.updated_by | string | null父物件內必填 | — |
profile.updated_byanyOf 1 | string父物件內必填 |
|
profile.updated_byanyOf 2 | null父物件內必填 | — |
profile.updated_by_kind | string父物件內必填 |
|
profile.updated_by_api_key_id | string | null父物件內必填 | — |
profile.updated_by_api_key_idanyOf 1 | string父物件內必填 |
|
profile.updated_by_api_key_idanyOf 2 | null父物件內必填 | — |
profile.updated_by_delegated_grant_id | string | null父物件內必填 | — |
profile.updated_by_delegated_grant_idanyOf 1 | string父物件內必填 |
|
profile.updated_by_delegated_grant_idanyOf 2 | null父物件內必填 | — |
profile.created_at | string父物件內必填 |
|
profile.updated_at | string父物件內必填 |
|
receipt_id | string父物件內必填 |
|
applied | boolean父物件內必填 | — |
deduped | boolean父物件內必填 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "project/v1"
},
"profile": {
"type": "object",
"properties": {
"project_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)$"
},
"workspace_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)$"
},
"tagline": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"target_audience": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color_palette": {
"type": "array",
"items": {
"type": "string"
}
},
"goals": {
"type": "array",
"items": {
"type": "string"
}
},
"no_go_topics": {
"type": "array",
"items": {
"type": "string"
}
},
"language_primary": {
"type": "string"
},
"positioning": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"usp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"visual_identity": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"forbidden_claims": {
"type": "array",
"items": {
"type": "string"
}
},
"north_star_metric": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"posting_cadence": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"app_store_url_ios": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"app_store_url_android": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"app_metadata": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"profile_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"updated_by": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"updated_by_kind": {
"type": "string",
"enum": [
"jwt",
"api_key",
"delegated_ai",
"migration"
]
},
"updated_by_api_key_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"updated_by_delegated_grant_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"created_at": {
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"project_id",
"workspace_id",
"tagline",
"description",
"voice",
"target_audience",
"color_palette",
"goals",
"no_go_topics",
"language_primary",
"positioning",
"usp",
"visual_identity",
"forbidden_claims",
"north_star_metric",
"posting_cadence",
"app_store_url_ios",
"app_store_url_android",
"app_metadata",
"profile_version",
"updated_by",
"updated_by_kind",
"updated_by_api_key_id",
"updated_by_delegated_grant_id",
"created_at",
"updated_at"
]
},
"receipt_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)$"
},
"applied": {
"type": "boolean"
},
"deduped": {
"type": "boolean"
}
},
"required": [
"contract_version",
"profile",
"receipt_id",
"applied",
"deduped"
]
}錯誤及安全重試
檢查 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
{
"project_id": "11111111-1111-4111-8111-111111111111",
"expected_profile_version": 1,
"idempotency_key": "example-intent-0001",
"patch": {
"tagline": "A fictional project for the documentation example."
}
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/projects/profile/update" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// 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/studio-api/projects/profile/update", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"project_id": "11111111-1111-4111-8111-111111111111",
"expected_profile_version": 1,
"idempotency_key": "example-intent-0001",
"patch": {
"tagline": "A fictional project for the documentation example."
}
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /studio-api/projects/profile/update < request.json虛構回應範例
{
"contract_version": "project/v1",
"profile": {
"project_id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"tagline": null,
"description": null,
"voice": null,
"target_audience": null,
"color_palette": [],
"goals": [],
"no_go_topics": [],
"language_primary": "example",
"positioning": null,
"usp": null,
"visual_identity": null,
"forbidden_claims": [],
"north_star_metric": null,
"posting_cadence": null,
"app_store_url_ios": null,
"app_store_url_android": null,
"app_metadata": {},
"profile_version": 1,
"updated_by": null,
"updated_by_kind": "jwt",
"updated_by_api_key_id": null,
"updated_by_delegated_grant_id": null,
"created_at": "2099-01-15T09:00:00Z",
"updated_at": "2099-01-15T09:00:00Z"
},
"receipt_id": "11111111-1111-4111-8111-111111111111",
"applied": false,
"deduped": false
}