API v2
Help Center
Search and read Optiverse Academy articles from your code or agent.
These operations search the Optiverse Academy, the documentation you are reading now. They are useful for agents that answer "how do I…" questions about Optiverse. Both count toward the read limit and are also MCP tools.
Search the Help Center
GET /v2/help/search (search_help_center)
| Parameter | Type | Default | Description |
|---|---|---|---|
query | string | required | Question or keywords, for example connect HubSpot |
limit | integer | 5 | Sections to return, 1 to 10 |
curl "https://developer.optiverse.ai/api/v2/help/search?query=connect%20HubSpot" \
-H "Authorization: Bearer optiuser_v1_your_key_here"{
"data": {
"results": [
{
"pageTitle": "HubSpot",
"sectionHeading": "Connect your account",
"url": "https://academy.optiverse.ai/docs/integrations-and-workflows/integrations/hubspot",
"slug": "integrations-and-workflows/integrations/hubspot",
"snippet": "Open Settings, Integrations, and choose HubSpot..."
}
]
}
}Read an Article
GET /v2/help/articles (get_help_article)
The full Markdown of one Academy page. Long pages are truncated at about 6,000 characters.
| Parameter | Type | Description |
|---|---|---|
slug | string | Required. The slug from a search result, for example desktop-app/capture |
{
"data": {
"title": "HubSpot",
"url": "https://academy.optiverse.ai/docs/integrations-and-workflows/integrations/hubspot",
"content": "# HubSpot\n\nConnect HubSpot to..."
}
}