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

ParameterTypeDefaultDescription
qstring, 1-200—Text to search for. Required.
limitinteger 1-85How 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
}
FieldTypeDescription
resultsobject[]Matches, from most relevant to least.
results[].idstringFragment identifier.
results[].namestringDocument name.
results[].topicstringTopic.
results[].snippetstringExcerpt, at most 240 characters. The full document is not included.
returnednumberResults included in results.
foundnumberTotal matches. It can be greater than returned.

A search with no matches responds 200 with results: [], returned: 0, and found: 0.


Errors

StatusCause
400q is missing, q is longer than 200 characters, or limit is not an integer between 1 and 8.
401The Bearer is missing, or the token/key is not valid.
502The search could not be completed.
503Product documentation search is unavailable.