Documentación
Busca en la documentación oficial de Platica: producto, interfaz y API. La tool MCP search_product_docs es la misma llamada.
GET https://api.platica.mx/v1/docs/search Ejemplo:
GET https://api.platica.mx/v1/docs/search?q=webhook&limit=3 No está atada a un módulo del workspace y no acepta workspace. La credencial solo autoriza la llamada; el corpus es el mismo para todas.
Acepta las dos credenciales Bearer: un access token OAuth (pl_at_…) o una API Key (pl_key_…). Ver Autenticación .
Parámetros
| Parámetro | Tipo | Default | Descripción |
|---|---|---|---|
q | string, 1-200 | — | Texto a buscar. Obligatorio. |
limit | integer 1-8 | 5 | Cuántos resultados devolver. |
Respuesta
{
"results": [
{
"id": "get_obtener_webhook1aade1",
"name": "get_obtener_webhook1aade1",
"topic": "Obtener Webhook",
"snippet": "GET https://api.platica.mx/v1/webhooks/{webhookId} devuelve un webhook del workspace."
}
],
"returned": 1,
"found": 18
} | Campo | Tipo | Descripción |
|---|---|---|
results | object[] | Coincidencias, de la más relevante a la menos. |
results[].id | string | Identificador del fragmento. |
results[].name | string | Nombre del documento. |
results[].topic | string | Tema. |
results[].snippet | string | Extracto, como máximo 240 caracteres. No incluye el documento completo. |
returned | number | Resultados incluidos en results. |
found | number | Coincidencias totales. Puede ser mayor que returned. |
Una búsqueda sin coincidencias responde 200 con results: [], returned: 0 y found: 0.
Nota
Esta ruta responde dudas sobre cómo funciona Platica. Para operar un workspace — mensajes, clientes, campañas — usa el endpoint de ese recurso.
Errores
| Status | Causa |
|---|---|
400 | Falta q, q supera 200 caracteres, o limit no es un entero entre 1 y 8. |
401 | Falta el Bearer, o el token/key no es válido. |
502 | La búsqueda no pudo completarse. |
503 | La búsqueda de documentación no está disponible. |