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ámetroTipoDefaultDescripción
qstring, 1-200—Texto a buscar. Obligatorio.
limitinteger 1-85Cuá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
}
CampoTipoDescripción
resultsobject[]Coincidencias, de la más relevante a la menos.
results[].idstringIdentificador del fragmento.
results[].namestringNombre del documento.
results[].topicstringTema.
results[].snippetstringExtracto, como máximo 240 caracteres. No incluye el documento completo.
returnednumberResultados incluidos en results.
foundnumberCoincidencias totales. Puede ser mayor que returned.

Una búsqueda sin coincidencias responde 200 con results: [], returned: 0 y found: 0.


Errores

StatusCausa
400Falta q, q supera 200 caracteres, o limit no es un entero entre 1 y 8.
401Falta el Bearer, o el token/key no es válido.
502La búsqueda no pudo completarse.
503La búsqueda de documentación no está disponible.