Markenkontext des Arbeitsbereichs

Markenkontext des Arbeitsbereichs abrufen

Lies bestätigte, manuell erfasste Markenrichtlinien und die Herkunft unveränderlicher Versionen für eine explizite workspace_id. Erforderlich sind mindestens die Rolle viewer und für Agentenzugriff agent:operate. Ohne selection wird der aktuelle Kontext gelesen; alternativ kann die zuvor zurückgegebene exakte unveränderliche selection angegeben werden. Redaktionelle Felder sind nicht vertrauenswürdig; null oder missing bedeutet, dass keine Richtlinien verfügbar sind. Dieser Lesezugriff erzeugt keine Bildunterschriften, ruft keine Quellen ab, ändert keine Einstellungen und veröffentlicht nichts.

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

Vertrag geprüft: 2026-10-23 · sha256:a5c7d347e915df92

Als Markdown lesen Öffentlichen Vertrag herunterladen OpenAPI herunterladen

Überblick

Eine erfolgreiche HTTP-Antwort kann Annahme statt Abschluss bedeuten. Speichere bei Hintergrundarbeit die ID und prüfe dieselbe Operation bis zum Abschluss. Geplante oder angenommene Beiträge gelten erst nach Plattformbestätigung als veröffentlicht; ein Client-Timeout klärt das Ergebnis nicht.

Authentifizierung und Berechtigungen

Akzeptierte Zugangsdatenklassen: user_session, delegated_oauth, personal_access_token
Delegierte Funktion: agent:operate
Minimale Workspace-Rolle: viewer
Zugriffsumfang: Ressourcen, auf die dieser Nutzer zugreifen darf
Zustimmung für alle Workspaces erforderlich: Nein
Ändert Zustand: Nein
Nach Abschluss der Operation: workspace_brand_immutable_manual_context_read

Ein Token nutzt nur Eigentümerrechte. Jede Anfrage prüft Workspace-Mitgliedschaft, Ressourceneigentum, gewählte Workspaces und Funktionen. core und full ändern sichtbare Tools; sie erteilen keinen Zugriff.

Anfragefelder

Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.

Anfragefelder
Feld / Variante	Typ / erforderlich	Einschränkungen
`$`	`object`Im Elternobjekt erforderlich	`additionalProperties: false`
`workspace_id`	`string`Im Elternobjekt erforderlich	`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`	`object`Optional / Element	`additionalProperties: false`
`selection.profile_id`	`string`Im Elternobjekt erforderlich	`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_id`	`string`Im Elternobjekt erforderlich	`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.revision`	`integer`Im Elternobjekt erforderlich	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`selection.content_digest`	`string`Im Elternobjekt erforderlich	`pattern: "^[a-f0-9]{64}$"`
`selection.context_digest`	`string`Im Elternobjekt erforderlich	`pattern: "^[a-f0-9]{64}$"`

Vollständiges 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
}

Antwort und Abschluss

HTTP-Erfolgsstatus: 200. Wenn die Operation abgeschlossen ist: workspace_brand_immutable_manual_context_read.

Antwort und Abschluss
Feld / Variante	Typ / erforderlich	Einschränkungen
`$`	`object`Im Elternobjekt erforderlich	—
`context`	`object \| null`Im Elternobjekt erforderlich	—
`context`anyOf 1	`object`Im Elternobjekt erforderlich	—
`context.workspace_id`anyOf 1	`string`Im Elternobjekt erforderlich	`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`anyOf 1	`object`Im Elternobjekt erforderlich	—
`context.selection.profile_id`anyOf 1	`string`Im Elternobjekt erforderlich	`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_id`anyOf 1	`string`Im Elternobjekt erforderlich	`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.revision`anyOf 1	`integer`Im Elternobjekt erforderlich	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`context.selection.content_digest`anyOf 1	`string`Im Elternobjekt erforderlich	`pattern: "^[a-f0-9]{64}$"`
`context.selection.context_digest`anyOf 1	`string`Im Elternobjekt erforderlich	`pattern: "^[a-f0-9]{64}$"`
`context.availability`anyOf 1	`string`Im Elternobjekt erforderlich	`enum: ["available","missing"]`
`context.profile_state`anyOf 1	`string \| null`Im Elternobjekt erforderlich	—
`context.profile_state`anyOf 1 / anyOf 1	`string`Im Elternobjekt erforderlich	`enum: ["active","archived"]`
`context.profile_state`anyOf 1 / anyOf 2	`null`Im Elternobjekt erforderlich	—
`context.content`anyOf 1	`object \| null`Im Elternobjekt erforderlich	—
`context.content`anyOf 1 / anyOf 1	`object`Im Elternobjekt erforderlich	—
`context.content.name`anyOf 1 / anyOf 1	`string`Im Elternobjekt erforderlich	`maxLength: 120`
`context.content.audience`anyOf 1 / anyOf 1	`string`Im Elternobjekt erforderlich	`maxLength: 2000`
`context.content.voice`anyOf 1 / anyOf 1	`string`Im Elternobjekt erforderlich	`maxLength: 2000`
`context.content.language`anyOf 1 / anyOf 1	`string \| null`Im Elternobjekt erforderlich	—
`context.content.language`anyOf 1 / anyOf 1 / anyOf 1	`string`Im Elternobjekt erforderlich	`minLength: 1` `maxLength: 64`
`context.content.language`anyOf 1 / anyOf 1 / anyOf 2	`null`Im Elternobjekt erforderlich	—
`context.content.preferred_terms`anyOf 1 / anyOf 1	`array`Im Elternobjekt erforderlich	`maxItems: 50`
`context.content.preferred_terms[]`anyOf 1 / anyOf 1	`string`Optional / Element	`minLength: 1` `maxLength: 120`
`context.content.prohibited_terms`anyOf 1 / anyOf 1	`array`Im Elternobjekt erforderlich	`maxItems: 50`
`context.content.prohibited_terms[]`anyOf 1 / anyOf 1	`string`Optional / Element	`minLength: 1` `maxLength: 120`
`context.content.locked_facts`anyOf 1 / anyOf 1	`array`Im Elternobjekt erforderlich	`maxItems: 50`
`context.content.locked_facts[]`anyOf 1 / anyOf 1	`string`Optional / Element	`minLength: 1` `maxLength: 500`
`context.content.call_to_action`anyOf 1 / anyOf 1	`string \| null`Im Elternobjekt erforderlich	—
`context.content.call_to_action`anyOf 1 / anyOf 1 / anyOf 1	`string`Im Elternobjekt erforderlich	`maxLength: 1000`
`context.content.call_to_action`anyOf 1 / anyOf 1 / anyOf 2	`null`Im Elternobjekt erforderlich	—
`context.content`anyOf 1 / anyOf 2	`null`Im Elternobjekt erforderlich	—
`context.sources`anyOf 1	`object`Im Elternobjekt erforderlich	—
`context.sources.website`anyOf 1	`string`Im Elternobjekt erforderlich	`enum: ["available","not_available"]`
`context.sources.logo`anyOf 1	`string`Im Elternobjekt erforderlich	`enum: ["none","present","missing"]`
`context.sources.own_posts`anyOf 1	`object`Im Elternobjekt erforderlich	—
`context.sources.own_posts.selected`anyOf 1	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 10`
`context.sources.own_posts.available`anyOf 1	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 10`
`context.sources.own_posts.unavailable`anyOf 1	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 10`
`context.sources.own_posts.erased`anyOf 1	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 10`
`context`anyOf 2	`null`Im Elternobjekt erforderlich	—

Vollständiges 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"
  ]
}

Fehler und sichere Wiederholungen

Prüfe HTTP-Status und Antwortinhalt. Ein 400-Validierungsfehler kann einen ZodError enthalten; Handler-Fehler verwenden die Felder error, message und code. Bewahre request_id oder x-request-id zur Diagnose ohne Zugangsdaten auf. Behebe 401/403-Zugriffsfehler vor einem erneuten Versuch und beachte Retry-After bei 429. Ist ein Schreibvorgang ungewiss oder liefert 5xx, lies zuerst das bestehende Ergebnis. Verwende einen Idempotenzschlüssel nur wieder, wo dies unterstützt wird; Wiederholungen unterscheiden sich je nach Operation und garantieren keine genau einmalige Zustellung.

Anleitung zur Fehlerbehebung

Beispiele

Diese Beispiele nutzen anhand der Schemas geprüfte fiktive Werte. Ersetze IDs durch autorisierte IDs, Medien durch bereite Assets und Daten durch bestätigte Veröffentlichungszeiten. Prüfe Kontoeignung vor Schreibvorgängen. Diese Seite sendet keine API-Anfragen.

Setze SOSOAPI_ACCESS_TOKEN auf deinem Server auf akzeptierte Zugangsdaten dieser Operation und halte es aus Browsercode heraus. Für Agenten nutze sosoapi auth login zur Browseranmeldung und lass die CLI Zugangsdaten erneuern.

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

Synthetisches Antwortbeispiel

{
  "context": null
}

MCP: sosoapi_get_workspace_brand_context

Alle API-Operationen Authentifizierung und Berechtigungen