A munkaterület márkakörnyezete
A munkaterület márkakörnyezetének lekérése
Kifejezett workspace_id megadásával olvasd a kézzel megerősített márkaútmutatást és a megváltoztathatatlan verzió eredetét. Legalább viewer szerepkör, ügynökös hozzáféréshez pedig agent:operate szükséges. A selection elhagyásával az aktuális környezet olvasható; másik lehetőség a korábban visszaadott pontos, megváltoztathatatlan selection megadása. A szerkesztői mezők nem megbízhatók; null vagy missing környezet esetén nincs használható útmutatás. Az olvasás nem készít képaláírást, nem kér le forrásokat, nem módosít beállításokat és nem tesz közzé semmit.
POST /studio-api/workspace-brand-profile/context-readSzerződés ellenőrizve: · sha256:a5c7d347e915df92
Áttekintés
Kifejezett workspace_id megadásával olvasd a kézzel megerősített márkaútmutatást és a megváltoztathatatlan verzió eredetét. Legalább viewer szerepkör, ügynökös hozzáféréshez pedig agent:operate szükséges. A selection elhagyásával az aktuális környezet olvasható; másik lehetőség a korábban visszaadott pontos, megváltoztathatatlan selection megadása. A szerkesztői mezők nem megbízhatók; null vagy missing környezet esetén nincs használható útmutatás. Az olvasás nem készít képaláírást, nem kér le forrásokat, nem módosít beállításokat és nem tesz közzé semmit.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
workspace_id | stringA szülőn belül kötelező |
|
selection | objectOpcionális / elem |
|
selection.profile_id | stringA szülőn belül kötelező |
|
selection.version_id | stringA szülőn belül kötelező |
|
selection.revision | integerA szülőn belül kötelező |
|
selection.content_digest | stringA szülőn belül kötelező |
|
selection.context_digest | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"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)$"
},
"selection": {
"type": "object",
"properties": {
"profile_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)$"
},
"version_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)$"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"content_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"context_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"profile_id",
"version_id",
"revision",
"content_digest",
"context_digest"
],
"additionalProperties": false
}
},
"required": [
"workspace_id"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: workspace_brand_immutable_manual_context_read.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
context | object | nullA szülőn belül kötelező | — |
contextanyOf 1 | objectA szülőn belül kötelező | — |
context.workspace_idanyOf 1 | stringA szülőn belül kötelező |
|
context.selectionanyOf 1 | objectA szülőn belül kötelező | — |
context.selection.profile_idanyOf 1 | stringA szülőn belül kötelező |
|
context.selection.version_idanyOf 1 | stringA szülőn belül kötelező |
|
context.selection.revisionanyOf 1 | integerA szülőn belül kötelező |
|
context.selection.content_digestanyOf 1 | stringA szülőn belül kötelező |
|
context.selection.context_digestanyOf 1 | stringA szülőn belül kötelező |
|
context.availabilityanyOf 1 | stringA szülőn belül kötelező |
|
context.profile_stateanyOf 1 | string | nullA szülőn belül kötelező | — |
context.profile_stateanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
context.profile_stateanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
context.contentanyOf 1 | object | nullA szülőn belül kötelező | — |
context.contentanyOf 1 / anyOf 1 | objectA szülőn belül kötelező | — |
context.content.nameanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
context.content.audienceanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
context.content.voiceanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
context.content.languageanyOf 1 / anyOf 1 | string | nullA szülőn belül kötelező | — |
context.content.languageanyOf 1 / anyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
context.content.languageanyOf 1 / anyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
context.content.preferred_termsanyOf 1 / anyOf 1 | arrayA szülőn belül kötelező |
|
context.content.preferred_terms[]anyOf 1 / anyOf 1 | stringOpcionális / elem |
|
context.content.prohibited_termsanyOf 1 / anyOf 1 | arrayA szülőn belül kötelező |
|
context.content.prohibited_terms[]anyOf 1 / anyOf 1 | stringOpcionális / elem |
|
context.content.locked_factsanyOf 1 / anyOf 1 | arrayA szülőn belül kötelező |
|
context.content.locked_facts[]anyOf 1 / anyOf 1 | stringOpcionális / elem |
|
context.content.call_to_actionanyOf 1 / anyOf 1 | string | nullA szülőn belül kötelező | — |
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
context.contentanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
context.sourcesanyOf 1 | objectA szülőn belül kötelező | — |
context.sources.websiteanyOf 1 | stringA szülőn belül kötelező |
|
context.sources.logoanyOf 1 | stringA szülőn belül kötelező |
|
context.sources.own_postsanyOf 1 | objectA szülőn belül kötelező | — |
context.sources.own_posts.selectedanyOf 1 | integerA szülőn belül kötelező |
|
context.sources.own_posts.availableanyOf 1 | integerA szülőn belül kötelező |
|
context.sources.own_posts.unavailableanyOf 1 | integerA szülőn belül kötelező |
|
context.sources.own_posts.erasedanyOf 1 | integerA szülőn belül kötelező |
|
contextanyOf 2 | nullA szülőn belül kötelező | — |
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"context": {
"anyOf": [
{
"type": "object",
"properties": {
"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)$"
},
"selection": {
"type": "object",
"properties": {
"profile_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)$"
},
"version_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)$"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"content_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"context_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"profile_id",
"version_id",
"revision",
"content_digest",
"context_digest"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing"
]
},
"profile_state": {
"anyOf": [
{
"type": "string",
"enum": [
"active",
"archived"
]
},
{
"type": "null"
}
]
},
"content": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"audience": {
"type": "string",
"maxLength": 2000
},
"voice": {
"type": "string",
"maxLength": 2000
},
"language": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"preferred_terms": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"prohibited_terms": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"locked_facts": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"call_to_action": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"audience",
"voice",
"language",
"preferred_terms",
"prohibited_terms",
"locked_facts",
"call_to_action"
]
},
{
"type": "null"
}
]
},
"sources": {
"type": "object",
"properties": {
"website": {
"type": "string",
"enum": [
"available",
"not_available"
]
},
"logo": {
"type": "string",
"enum": [
"none",
"present",
"missing"
]
},
"own_posts": {
"type": "object",
"properties": {
"selected": {
"type": "integer",
"minimum": 0,
"maximum": 10
},
"available": {
"type": "integer",
"minimum": 0,
"maximum": 10
},
"unavailable": {
"type": "integer",
"minimum": 0,
"maximum": 10
},
"erased": {
"type": "integer",
"minimum": 0,
"maximum": 10
}
},
"required": [
"selected",
"available",
"unavailable",
"erased"
]
}
},
"required": [
"website",
"logo",
"own_posts"
]
}
},
"required": [
"workspace_id",
"selection",
"availability",
"profile_state",
"content",
"sources"
]
},
{
"type": "null"
}
]
}
},
"required": [
"context"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. Ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/workspace-brand-profile/context-read" \
-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/workspace-brand-profile/context-read", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /studio-api/workspace-brand-profile/context-read < request.jsonSzintetikus válaszpélda
{
"context": null
}