Documentation
Search Platica's official documentation: product, interface, and API. The MCP tool search_product_docs is the same call.
GET https://api.platica.mx/v1/docs/search Example:
GET https://api.platica.mx/v1/docs/search?q=webhook&limit=3 It is not gated on a workspace module and it does not accept workspace. The credential only authorizes the call; the corpus is the same for everyone.
It accepts both Bearer credentials: an OAuth access token (pl_at_…) or an API Key (pl_key_…). See Authentication .
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
q | string, 1-200 | — | Text to search for. Required. |
limit | integer 1-8 | 5 | How many results to return. |
Response
{
"results": [
{
"id": "get_obtener_webhook1aade1",
"name": "get_obtener_webhook1aade1",
"topic": "Obtener Webhook",
"snippet": "GET https://api.platica.mx/v1/webhooks/{webhookId} returns a workspace webhook."
}
],
"returned": 1,
"found": 18
} | Field | Type | Description |
|---|---|---|
results | object[] | Matches, from most relevant to least. |
results[].id | string | Fragment identifier. |
results[].name | string | Document name. |
results[].topic | string | Topic. |
results[].snippet | string | Excerpt, at most 240 characters. The full document is not included. |
returned | number | Results included in results. |
found | number | Total matches. It can be greater than returned. |
A search with no matches responds 200 with results: [], returned: 0, and found: 0.
Nota
This route answers questions about how Platica works. To operate a workspace — messages, customers, campaigns — use that resource's endpoint.
Errors
| Status | Cause |
|---|---|
400 | q is missing, q is longer than 200 characters, or limit is not an integer between 1 and 8. |
401 | The Bearer is missing, or the token/key is not valid. |
502 | The search could not be completed. |
503 | Product documentation search is unavailable. |