# Cancelar una ejecución de recopilación de Listening URL canónica: https://sosoapi.ai/es/docs/api/listening-api-runs-cancel Contrato: sha256:ab393e91e9b7f18a Cancelar una ejecución de recopilación por ID y mutation_id; los resultados tardíos de fuentes no pueden confirmarse. Requiere agent:research. POST /listening-api/runs/cancel ## 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:** editor - **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:** Sí - **Cuando la operación se completa:** versión confirmada de recurso Listening o barrera de cancelación; sin escrituras en plataformas sociales 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 ```json { "$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)$" }, "mutation_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)$" }, "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", "mutation_id", "id" ], "additionalProperties": false } ``` ## Respuesta y finalización Estados HTTP de éxito: 200 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. ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "run": { "type": "object", "properties": { "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)$" }, "stream_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)$" }, "stream_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "query_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "generation": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string", "const": "hacker_news" }, "status": { "type": "string", "enum": [ "queued", "running", "partial", "succeeded", "deferred", "cancelled", "failed" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "collection_paused", "authorization_expired", "authorization_revoked", "stream_changed", "stream_paused", "stream_deleted", "cancelled", "workspace_budget", "source_budget", "run_budget", "source_rate_limited", "source_unavailable", "source_invalid", "execution_exhausted" ] }, { "type": "null" } ] }, "requested_at": { "type": "string", "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)))$", "format": "date-time" }, "completed_at": { "anyOf": [ { "type": "string", "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)))$", "format": "date-time" }, { "type": "null" } ] }, "retry_after": { "anyOf": [ { "type": "string", "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)))$", "format": "date-time" }, { "type": "null" } ] }, "result_count": { "type": "integer", "minimum": 0, "maximum": 20 }, "provider_gets": { "type": "integer", "minimum": 0, "maximum": 21 }, "coverage": { "type": "string", "const": "partial_indexed_sample" }, "exhaustive": { "type": "boolean", "const": false }, "method_version": { "type": "string", "const": "hn-indexed-literal-sample/v1" }, "observation_counts": { "type": "object", "properties": { "source_items": { "type": "integer", "minimum": 0, "maximum": 20 }, "matched_items": { "type": "integer", "minimum": 0, "maximum": 20 }, "removed_items": { "type": "integer", "minimum": 0, "maximum": 20 }, "unavailable_items": { "type": "integer", "minimum": 0, "maximum": 20 } }, "required": [ "source_items", "matched_items", "removed_items", "unavailable_items" ] }, "window_since": { "type": "string", "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)))$", "format": "date-time" }, "window_until": { "type": "string", "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)))$", "format": "date-time" }, "page": { "type": "integer", "minimum": 0, "maximum": 49 }, "next_page_available": { "type": "boolean" } }, "required": [ "id", "workspace_id", "stream_id", "stream_revision", "query_revision", "generation", "source", "status", "reason", "requested_at", "completed_at", "retry_after", "result_count", "provider_gets", "coverage", "exhaustive", "method_version", "observation_counts", "window_since", "window_until", "page", "next_page_available" ] } }, "required": [ "run" ] } ``` ## 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 ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "mutation_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/runs/cancel" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // 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/runs/cancel", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "mutation_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /listening-api/runs/cancel < request.json ``` Ejemplo de respuesta sintética ```json { "run": { "id": "11111111-1111-4111-8111-111111111111", "workspace_id": "11111111-1111-4111-8111-111111111111", "stream_id": "11111111-1111-4111-8111-111111111111", "stream_revision": 1, "query_revision": 1, "generation": 1, "source": "hacker_news", "status": "queued", "reason": null, "requested_at": "2099-01-15T09:00:00Z", "completed_at": null, "retry_after": null, "result_count": 0, "provider_gets": 0, "coverage": "partial_indexed_sample", "exhaustive": false, "method_version": "hn-indexed-literal-sample/v1", "observation_counts": { "source_items": 0, "matched_items": 0, "removed_items": 0, "unavailable_items": 0 }, "window_since": "2099-01-15T09:00:00Z", "window_until": "2099-01-15T09:00:00Z", "page": 0, "next_page_available": false } } ``` ## Herramientas y guías relacionadas MCP: sosoapi_listening_runs_cancel [Referencia de API](https://sosoapi.ai/es/docs/api)