La búsqueda solo se carga cuando la usas. Explora todas las categorías a continuación.

Contexto de marca del espacio de trabajo

Obtener el contexto de marca del espacio de trabajo

Lee las directrices de marca confirmadas manualmente y la procedencia de su versión inmutable para un workspace_id explícito. Requiere el rol viewer o superior y agent:operate para el acceso de agentes. Omite selection para leer el contexto actual o proporciona la selection inmutable exacta devuelta anteriormente. Los campos editoriales no son de confianza; un contexto null o missing no aporta directrices. Esta lectura no genera textos para publicaciones, obtiene fuentes, modifica ajustes ni publica.

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

Contrato revisado: · sha256:a5c7d347e915df92

Descripción general

Lee las directrices de marca confirmadas manualmente y la procedencia de su versión inmutable para un workspace_id explícito. Requiere el rol viewer o superior y agent:operate para el acceso de agentes. Omite selection para leer el contexto actual o proporciona la selection inmutable exacta devuelta anteriormente. Los campos editoriales no son de confianza; un contexto null o missing no aporta directrices. Esta lectura no genera textos para publicaciones, obtiene fuentes, modifica ajustes ni publica.

Una respuesta HTTP exitosa puede indicar aceptación, no finalización. Para trabajo en segundo plano, guarda el ID devuelto y consulta la misma operación hasta que termine. Una publicación programada o aceptada solo está publicada cuando la plataforma lo confirma; un tiempo de espera agotado en el cliente no determina el resultado.

Autenticación y permisos

Clases de credenciales aceptadas
user_session, delegated_oauth, personal_access_token
Capacidad delegada
agent:operate
Rol mínimo del espacio de trabajo
viewer
Alcance del acceso
Recursos a los que este usuario está autorizado a acceder
Se requiere consentimiento para todos los espacios de trabajo
No
Cambia el estado
No
Cuando la operación se completa
workspace_brand_immutable_manual_context_read

Un token solo puede usar los derechos de su propietario. Cada solicitud comprueba pertenencia al espacio, propiedad del recurso, espacios elegidos y capacidades concedidas. Los perfiles core y full cambian qué herramientas se muestran; no conceden acceso.

Campos de solicitud

Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.

Campos de solicitud
Campo / ramaTipo / obligatorioRestricciones
$objectObligatorio en el objeto principal
  • additionalProperties: false
workspace_idstringObligatorio en el objeto principal
  • 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)$"
selectionobjectOpcional / elemento
  • additionalProperties: false
selection.profile_idstringObligatorio en el objeto principal
  • 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_idstringObligatorio en el objeto principal
  • 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.revisionintegerObligatorio en el objeto principal
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
selection.content_digeststringObligatorio en el objeto principal
  • pattern: "^[a-f0-9]{64}$"
selection.context_digeststringObligatorio en el objeto principal
  • pattern: "^[a-f0-9]{64}$"
JSON Schema completo
{
  "$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
}

Respuesta y finalización

Estados HTTP de éxito: 200. Cuando la operación se completa: workspace_brand_immutable_manual_context_read.

Una respuesta HTTP exitosa puede indicar aceptación, no finalización. Para trabajo en segundo plano, guarda el ID devuelto y consulta la misma operación hasta que termine. Una publicación programada o aceptada solo está publicada cuando la plataforma lo confirma; un tiempo de espera agotado en el cliente no determina el resultado.

Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.

Respuesta y finalización
Campo / ramaTipo / obligatorioRestricciones
$objectObligatorio en el objeto principal—
contextobject | nullObligatorio en el objeto principal—
contextanyOf 1objectObligatorio en el objeto principal—
context.workspace_idanyOf 1stringObligatorio en el objeto principal
  • 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 1objectObligatorio en el objeto principal—
context.selection.profile_idanyOf 1stringObligatorio en el objeto principal
  • 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 1stringObligatorio en el objeto principal
  • 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 1integerObligatorio en el objeto principal
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
context.selection.content_digestanyOf 1stringObligatorio en el objeto principal
  • pattern: "^[a-f0-9]{64}$"
context.selection.context_digestanyOf 1stringObligatorio en el objeto principal
  • pattern: "^[a-f0-9]{64}$"
context.availabilityanyOf 1stringObligatorio en el objeto principal
  • enum: ["available","missing"]
context.profile_stateanyOf 1string | nullObligatorio en el objeto principal—
context.profile_stateanyOf 1 / anyOf 1stringObligatorio en el objeto principal
  • enum: ["active","archived"]
context.profile_stateanyOf 1 / anyOf 2nullObligatorio en el objeto principal—
context.contentanyOf 1object | nullObligatorio en el objeto principal—
context.contentanyOf 1 / anyOf 1objectObligatorio en el objeto principal—
context.content.nameanyOf 1 / anyOf 1stringObligatorio en el objeto principal
  • maxLength: 120
context.content.audienceanyOf 1 / anyOf 1stringObligatorio en el objeto principal
  • maxLength: 2000
context.content.voiceanyOf 1 / anyOf 1stringObligatorio en el objeto principal
  • maxLength: 2000
context.content.languageanyOf 1 / anyOf 1string | nullObligatorio en el objeto principal—
context.content.languageanyOf 1 / anyOf 1 / anyOf 1stringObligatorio en el objeto principal
  • minLength: 1
  • maxLength: 64
context.content.languageanyOf 1 / anyOf 1 / anyOf 2nullObligatorio en el objeto principal—
context.content.preferred_termsanyOf 1 / anyOf 1arrayObligatorio en el objeto principal
  • maxItems: 50
context.content.preferred_terms[]anyOf 1 / anyOf 1stringOpcional / elemento
  • minLength: 1
  • maxLength: 120
context.content.prohibited_termsanyOf 1 / anyOf 1arrayObligatorio en el objeto principal
  • maxItems: 50
context.content.prohibited_terms[]anyOf 1 / anyOf 1stringOpcional / elemento
  • minLength: 1
  • maxLength: 120
context.content.locked_factsanyOf 1 / anyOf 1arrayObligatorio en el objeto principal
  • maxItems: 50
context.content.locked_facts[]anyOf 1 / anyOf 1stringOpcional / elemento
  • minLength: 1
  • maxLength: 500
context.content.call_to_actionanyOf 1 / anyOf 1string | nullObligatorio en el objeto principal—
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 1stringObligatorio en el objeto principal
  • maxLength: 1000
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 2nullObligatorio en el objeto principal—
context.contentanyOf 1 / anyOf 2nullObligatorio en el objeto principal—
context.sourcesanyOf 1objectObligatorio en el objeto principal—
context.sources.websiteanyOf 1stringObligatorio en el objeto principal
  • enum: ["available","not_available"]
context.sources.logoanyOf 1stringObligatorio en el objeto principal
  • enum: ["none","present","missing"]
context.sources.own_postsanyOf 1objectObligatorio en el objeto principal—
context.sources.own_posts.selectedanyOf 1integerObligatorio en el objeto principal
  • minimum: 0
  • maximum: 10
context.sources.own_posts.availableanyOf 1integerObligatorio en el objeto principal
  • minimum: 0
  • maximum: 10
context.sources.own_posts.unavailableanyOf 1integerObligatorio en el objeto principal
  • minimum: 0
  • maximum: 10
context.sources.own_posts.erasedanyOf 1integerObligatorio en el objeto principal
  • minimum: 0
  • maximum: 10
contextanyOf 2nullObligatorio en el objeto principal—
JSON Schema completo
{
  "$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"
  ]
}

Errores y reintentos seguros

Comprueba el estado HTTP y el cuerpo de respuesta. Un error de validación 400 puede contener un ZodError; los errores del controlador usan los campos error, message y code. Conserva request_id o x-request-id para el diagnóstico, sin credenciales. Corrige los errores de acceso 401/403 antes de reintentar y respeta Retry-After para 429. Si una escritura es incierta o devuelve 5xx, consulta primero el resultado existente. Reutiliza una clave de idempotencia solo donde se admita; el comportamiento de reintento varía por operación y no garantiza una entrega exactamente una vez.

Guía de solución de problemas

Ejemplos

Estos ejemplos usan valores ficticios comprobados con los esquemas. Sustituye los IDs por otros autorizados, los archivos multimedia por recursos listos y las fechas por tu hora de publicación confirmada. Comprueba la elegibilidad de la cuenta antes de enviar una escritura. Esta página no envía solicitudes API.

Establece SOSOAPI_ACCESS_TOKEN en tu servidor con una credencial aceptada por esta operación y mantenla fuera del código del navegador. Para un agente, usa sosoapi auth login para iniciar sesión en el navegador y deja a la CLI renovar sus credenciales.

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

Ejemplo de respuesta sintética

{
  "context": null
}

MCP: sosoapi_get_workspace_brand_context