Projektek és tartalom
Projektprofil lekérése
A projekt márkaprofiljának olvasása (jelmondat, hangvétel, célközönség, célok, paletta és más adatok); a profile null, ha nem létezik.
POST /studio-api/projects/profile/getSzerződés ellenőrizve: · sha256:563d2d581da0ad29
Áttekintés
A projekt márkaprofiljának olvasása (jelmondat, hangvétel, célközönség, célok, paletta és más adatok); a profile null, ha nem létezik.
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ő |
|
project_id | stringA szülőn belül kötelező |
|
Teljes 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)$"
}
},
"required": [
"project_id"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.
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ő | — |
contract_version | stringA szülőn belül kötelező |
|
profile | object | nullA szülőn belül kötelező | — |
profileanyOf 1 | objectA szülőn belül kötelező | — |
profile.project_idanyOf 1 | stringA szülőn belül kötelező |
|
profile.workspace_idanyOf 1 | stringA szülőn belül kötelező |
|
profile.taglineanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.taglineanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.taglineanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.descriptionanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.descriptionanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.descriptionanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.voiceanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.voiceanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.voiceanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.target_audienceanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.target_audienceanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.target_audienceanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.color_paletteanyOf 1 | arrayA szülőn belül kötelező | — |
profile.color_palette[]anyOf 1 | stringOpcionális / elem | — |
profile.goalsanyOf 1 | arrayA szülőn belül kötelező | — |
profile.goals[]anyOf 1 | stringOpcionális / elem | — |
profile.no_go_topicsanyOf 1 | arrayA szülőn belül kötelező | — |
profile.no_go_topics[]anyOf 1 | stringOpcionális / elem | — |
profile.language_primaryanyOf 1 | stringA szülőn belül kötelező | — |
profile.positioninganyOf 1 | string | nullA szülőn belül kötelező | — |
profile.positioninganyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.positioninganyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.uspanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.uspanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.uspanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.visual_identityanyOf 1 | object | nullA szülőn belül kötelező | — |
profile.visual_identityanyOf 1 / anyOf 1 | objectA szülőn belül kötelező |
|
profile.visual_identity.*anyOf 1 / anyOf 1 | any JSON valueOpcionális / elem | — |
profile.visual_identityanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.forbidden_claimsanyOf 1 | arrayA szülőn belül kötelező | — |
profile.forbidden_claims[]anyOf 1 | stringOpcionális / elem | — |
profile.north_star_metricanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.north_star_metricanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.north_star_metricanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.posting_cadenceanyOf 1 | object | nullA szülőn belül kötelező | — |
profile.posting_cadenceanyOf 1 / anyOf 1 | objectA szülőn belül kötelező |
|
profile.posting_cadence.*anyOf 1 / anyOf 1 | any JSON valueOpcionális / elem | — |
profile.posting_cadenceanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.app_store_url_iosanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.app_store_url_iosanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.app_store_url_iosanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.app_store_url_androidanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.app_store_url_androidanyOf 1 / anyOf 1 | stringA szülőn belül kötelező | — |
profile.app_store_url_androidanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.app_metadataanyOf 1 | objectA szülőn belül kötelező |
|
profile.app_metadata.*anyOf 1 | any JSON valueOpcionális / elem | — |
profile.profile_versionanyOf 1 | integerA szülőn belül kötelező |
|
profile.updated_byanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.updated_byanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
profile.updated_byanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.updated_by_kindanyOf 1 | stringA szülőn belül kötelező |
|
profile.updated_by_api_key_idanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.updated_by_api_key_idanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
profile.updated_by_api_key_idanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.updated_by_delegated_grant_idanyOf 1 | string | nullA szülőn belül kötelező | — |
profile.updated_by_delegated_grant_idanyOf 1 / anyOf 1 | stringA szülőn belül kötelező |
|
profile.updated_by_delegated_grant_idanyOf 1 / anyOf 2 | nullA szülőn belül kötelező | — |
profile.created_atanyOf 1 | stringA szülőn belül kötelező |
|
profile.updated_atanyOf 1 | stringA szülőn belül kötelező |
|
profileanyOf 2 | nullA szülőn belül kötelező | — |
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "project/v1"
},
"profile": {
"anyOf": [
{
"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"
]
},
{
"type": "null"
}
]
}
},
"required": [
"contract_version",
"profile"
]
}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
{
"project_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/projects/profile/get" \
-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/get", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"project_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/projects/profile/get < request.jsonSzintetikus válaszpélda
{
"contract_version": "project/v1",
"profile": null
}