Leer la cobertura de fuentes de Listening

Descripción general

Leer la cobertura de fuentes compatibles con Listening, las reglas de consulta literal y los límites de recopilación; solo metadatos. Requiere agent:research.

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:research

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

current authorized Listening data; indexed public sample is partial and is not a verified account mention

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.

{
  "$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)$"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Respuesta y finalización

Estados HTTP de éxito: 200. Cuando la operación se completa: current authorized Listening data; indexed public sample is partial and is not a verified account mention.

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.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "const": "hacker_news"
    },
    "query_mode": {
      "type": "string",
      "const": "literal_phrase"
    },
    "include_mode": {
      "type": "string",
      "const": "all_literal_substrings"
    },
    "exclude_mode": {
      "type": "string",
      "const": "any_literal_substring"
    },
    "item_types": {
      "type": "array",
      "prefixItems": [
        {
          "type": "string",
          "const": "story"
        },
        {
          "type": "string",
          "const": "comment"
        }
      ],
      "items": false,
      "minItems": 2,
      "maxItems": 2
    },
    "coverage": {
      "type": "string",
      "const": "partial_indexed_sample"
    },
    "exhaustive": {
      "type": "boolean",
      "const": false
    },
    "limits": {
      "type": "object",
      "properties": {
        "streams_per_workspace": {
          "type": "number",
          "const": 5
        },
        "minimum_cadence_minutes": {
          "type": "number",
          "const": 30
        },
        "lookback_days": {
          "type": "number",
          "const": 7
        },
        "content_retention_days": {
          "type": "number",
          "const": 7
        },
        "results_per_run": {
          "type": "number",
          "const": 20
        },
        "provider_gets_per_run": {
          "type": "number",
          "const": 21
        },
        "workspace_provider_gets_per_day": {
          "type": "number",
          "const": 500
        },
        "shared_searches_per_hour": {
          "type": "number",
          "const": 5000
        }
      },
      "required": [
        "streams_per_workspace",
        "minimum_cadence_minutes",
        "lookback_days",
        "content_retention_days",
        "results_per_run",
        "provider_gets_per_run",
        "workspace_provider_gets_per_day",
        "shared_searches_per_hour"
      ]
    }
  },
  "required": [
    "source",
    "query_mode",
    "include_mode",
    "exclude_mode",
    "item_types",
    "coverage",
    "exhaustive",
    "limits"
  ]
}

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.

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 de IA, 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/listening-api/capabilities" \
  -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/listening-api/capabilities", {
  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 /listening-api/capabilities < request.json

Ejemplo de respuesta sintética

{
  "source": "hacker_news",
  "query_mode": "literal_phrase",
  "include_mode": "all_literal_substrings",
  "exclude_mode": "any_literal_substring",
  "item_types": [
    "story",
    "comment"
  ],
  "coverage": "partial_indexed_sample",
  "exhaustive": false,
  "limits": {
    "streams_per_workspace": 5,
    "minimum_cadence_minutes": 30,
    "lookback_days": 7,
    "content_retention_days": 7,
    "results_per_run": 20,
    "provider_gets_per_run": 21,
    "workspace_provider_gets_per_day": 500,
    "shared_searches_per_hour": 5000
  }
}

Herramientas y guías relacionadas

MCP: sosoapi_listening_capabilities