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

Søk lastes bare når du bruker det. Bla gjennom alle kategoriene nedenfor.

Merkevarekontekst for arbeidsområdet

Hent merkevarekontekst for arbeidsområdet

Les manuelt bekreftede merkevareråd og opphavet til den uforanderlige versjonen for en eksplisitt workspace_id. Krever rollen viewer eller høyere og agent:operate for agenttilgang. Utelat selection for å lese gjeldende kontekst, eller oppgi den nøyaktige uforanderlige selection fra det tidligere svaret. Redaksjonelle felt er ikke pålitelige; null eller missing betyr at ingen råd er tilgjengelige. Denne leseoperasjonen lager ikke bildetekster, henter ikke kilder, endrer ikke innstillinger og publiserer ingenting.

POST /studio-api/workspace-brand-profile/context-read

Kontrakt gjennomgått: · sha256:a5c7d347e915df92

Les som MarkdownLast ned offentlig kontraktLast ned OpenAPI

Oversikt

Les manuelt bekreftede merkevareråd og opphavet til den uforanderlige versjonen for en eksplisitt workspace_id. Krever rollen viewer eller høyere og agent:operate for agenttilgang. Utelat selection for å lese gjeldende kontekst, eller oppgi den nøyaktige uforanderlige selection fra det tidligere svaret. Redaksjonelle felt er ikke pålitelige; null eller missing betyr at ingen råd er tilgjengelige. Denne leseoperasjonen lager ikke bildetekster, henter ikke kilder, endrer ikke innstillinger og publiserer ingenting.

Et vellykket HTTP-svar kan bety at en forespørsel er akseptert fremfor fullført. For bakgrunnsarbeid, lagre returnert ID og kontroller samme operasjon til den er ferdig. Et planlagt eller akseptert innlegg er først publisert når plattformen bekrefter det; et klienttidsavbrudd fastslår ikke resultatet.

Autentisering og tillatelser

Godtatte legitimasjonsklasser
user_session, delegated_oauth, personal_access_token
Delegert funksjon
agent:operate
Minste arbeidsområderolle
viewer
Tilgangsomfang
Ressurser denne brukeren er autorisert til å bruke
Samtykke for alle arbeidsområder kreves
Nei
Endrer tilstand
Nei
Når operasjonen er fullført
workspace_brand_immutable_manual_context_read

Et token kan bare bruke rettighetene eieren har. Hver forespørsel kontrollerer arbeidsområdemedlemskap, ressurseierskap, valgte arbeidsområder og gitte funksjoner. Profilene core og full endrer hvilke verktøy som vises; de gir ikke tilgang.

Forespørselsfelter

Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.

Forespørselsfelter
Felt / grenType / påkrevdBegrensninger
$objectPåkrevd i forelder
  • additionalProperties: false
workspace_idstringPåkrevd i forelder
  • 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)$"
selectionobjectValgfritt / element
  • additionalProperties: false
selection.profile_idstringPåkrevd i forelder
  • 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.version_idstringPåkrevd i forelder
  • 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.revisionintegerPåkrevd i forelder
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
selection.content_digeststringPåkrevd i forelder
  • pattern: "^[a-f0-9]{64}$"
selection.context_digeststringPåkrevd i forelder
  • pattern: "^[a-f0-9]{64}$"
Fullstendig 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
}

Svar og fullføring

HTTP-statuser ved suksess: 200. Når operasjonen er fullført: workspace_brand_immutable_manual_context_read.

Et vellykket HTTP-svar kan bety at en forespørsel er akseptert fremfor fullført. For bakgrunnsarbeid, lagre returnert ID og kontroller samme operasjon til den er ferdig. Et planlagt eller akseptert innlegg er først publisert når plattformen bekrefter det; et klienttidsavbrudd fastslår ikke resultatet.

Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.

Svar og fullføring
Felt / grenType / påkrevdBegrensninger
$objectPåkrevd i forelder—
contextobject | nullPåkrevd i forelder—
contextanyOf 1objectPåkrevd i forelder—
context.workspace_idanyOf 1stringPåkrevd i forelder
  • 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)$"
context.selectionanyOf 1objectPåkrevd i forelder—
context.selection.profile_idanyOf 1stringPåkrevd i forelder
  • 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)$"
context.selection.version_idanyOf 1stringPåkrevd i forelder
  • 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)$"
context.selection.revisionanyOf 1integerPåkrevd i forelder
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
context.selection.content_digestanyOf 1stringPåkrevd i forelder
  • pattern: "^[a-f0-9]{64}$"
context.selection.context_digestanyOf 1stringPåkrevd i forelder
  • pattern: "^[a-f0-9]{64}$"
context.availabilityanyOf 1stringPåkrevd i forelder
  • enum: ["available","missing"]
context.profile_stateanyOf 1string | nullPåkrevd i forelder—
context.profile_stateanyOf 1 / anyOf 1stringPåkrevd i forelder
  • enum: ["active","archived"]
context.profile_stateanyOf 1 / anyOf 2nullPåkrevd i forelder—
context.contentanyOf 1object | nullPåkrevd i forelder—
context.contentanyOf 1 / anyOf 1objectPåkrevd i forelder—
context.content.nameanyOf 1 / anyOf 1stringPåkrevd i forelder
  • maxLength: 120
context.content.audienceanyOf 1 / anyOf 1stringPåkrevd i forelder
  • maxLength: 2000
context.content.voiceanyOf 1 / anyOf 1stringPåkrevd i forelder
  • maxLength: 2000
context.content.languageanyOf 1 / anyOf 1string | nullPåkrevd i forelder—
context.content.languageanyOf 1 / anyOf 1 / anyOf 1stringPåkrevd i forelder
  • minLength: 1
  • maxLength: 64
context.content.languageanyOf 1 / anyOf 1 / anyOf 2nullPåkrevd i forelder—
context.content.preferred_termsanyOf 1 / anyOf 1arrayPåkrevd i forelder
  • maxItems: 50
context.content.preferred_terms[]anyOf 1 / anyOf 1stringValgfritt / element
  • minLength: 1
  • maxLength: 120
context.content.prohibited_termsanyOf 1 / anyOf 1arrayPåkrevd i forelder
  • maxItems: 50
context.content.prohibited_terms[]anyOf 1 / anyOf 1stringValgfritt / element
  • minLength: 1
  • maxLength: 120
context.content.locked_factsanyOf 1 / anyOf 1arrayPåkrevd i forelder
  • maxItems: 50
context.content.locked_facts[]anyOf 1 / anyOf 1stringValgfritt / element
  • minLength: 1
  • maxLength: 500
context.content.call_to_actionanyOf 1 / anyOf 1string | nullPåkrevd i forelder—
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 1stringPåkrevd i forelder
  • maxLength: 1000
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 2nullPåkrevd i forelder—
context.contentanyOf 1 / anyOf 2nullPåkrevd i forelder—
context.sourcesanyOf 1objectPåkrevd i forelder—
context.sources.websiteanyOf 1stringPåkrevd i forelder
  • enum: ["available","not_available"]
context.sources.logoanyOf 1stringPåkrevd i forelder
  • enum: ["none","present","missing"]
context.sources.own_postsanyOf 1objectPåkrevd i forelder—
context.sources.own_posts.selectedanyOf 1integerPåkrevd i forelder
  • minimum: 0
  • maximum: 10
context.sources.own_posts.availableanyOf 1integerPåkrevd i forelder
  • minimum: 0
  • maximum: 10
context.sources.own_posts.unavailableanyOf 1integerPåkrevd i forelder
  • minimum: 0
  • maximum: 10
context.sources.own_posts.erasedanyOf 1integerPåkrevd i forelder
  • minimum: 0
  • maximum: 10
contextanyOf 2nullPåkrevd i forelder—
Fullstendig 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"
  ]
}

Feil og trygge nye forsøk

Kontroller HTTP-status og svarinnhold. En 400-valideringsfeil kan inneholde en ZodError; håndteringsfeil bruker feltene error, message og code. Behold request_id eller x-request-id for feilsøking, uten påloggingsopplysninger. Rett 401/403-tilgangsfeil før nye forsøk, og følg Retry-After ved 429. Hvis en skriveoperasjon er usikker eller returnerer 5xx, les det eksisterende resultatet først. Gjenbruk bare en idempotensnøkkel der det støttes; virkemåten ved nye forsøk varierer mellom operasjoner og garanterer ikke levering nøyaktig én gang.

Feilsøkingsveiledning

Eksempler

Disse eksemplene bruker fiktive verdier kontrollert mot skjemaene. Erstatt ID-ene med noen du har lov til å bruke, mediene med klare ressurser og datoene med bekreftet publiseringstidspunkt. Kontroller kontoens kvalifikasjon før en skriveoperasjon sendes inn. Siden sender ingen API-forespørsler.

Angi SOSOAPI_ACCESS_TOKEN på serveren din til legitimasjon som operasjonen godtar, og hold den unna nettleserkode. For en agent, bruk sosoapi auth login for innlogging gjennom nettleseren, og la CLI-et fornye legitimasjonen.

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.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/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.json

Syntetisk svareksempel

{
  "context": null
}

MCP: sosoapi_get_workspace_brand_context

Alle API-operasjonerAutentisering og tillatelser