Help center
Read the Ceyo help center, including the Business help, the Partner playbook and the Developer docs, to host it in your own help center or support tools. The content is the same for every workspace.
workspace:read. Project and location keys receive 403 forbidden.updated_at is when an article was edited, which can be a few days before the edit is published. The simplest sync is a daily fetch of all articles, comparing each updated_at with the one you stored. If you use updated_since, go back a few days from your last sync. Articles that are no longer returned were removed.ETag header. Send it back in If-None-Match: when nothing changed you get 304 Not Modified with no body, which is the cheapest daily check. On a 200, store the new ETag and compare each article's updated_at. Send Accept-Encoding: gzip to receive compressed responses.GETGet help center
/helpReturns the help categories and the glossary.
Get help center
/helpResponse envelope
categories:HelpCategory[]glossary:GlossaryTerm[]categoriesHelpCategory[]All categories.
glossaryGlossaryTerm[]All glossary terms.
HelpCategory
idstringStable category identifier.
productmerchant | playbook | developerHelp section the category belongs to. See product on HelpArticle.
namestringDisplay name.
descriptionstringOne-line summary.
GlossaryTerm
termstringThe term. Unique, and used as its identifier.
aliasesstring[]Other spellings and plural forms of the term.
articlestring | nullID of the article that explains the term in depth.
definitionstringOne-sentence definition.
created_atdatetimeWhen the term was added.
updated_atdatetimeWhen the term was last edited.
Request and response
curl --request GET \
--url 'https://api.signal.ceyo.ai/v1/help' \
--header 'Authorization: Bearer ceyo_platform_...'{
"categories": [
{
"id": "getting-started",
"product": "merchant",
"name": "Getting started",
"description": "What it is, how it works and the first week."
}
],
"glossary": [
{
"term": "Prompt",
"aliases": [
"prompts",
"tracked prompt",
"tracked prompts"
],
"article": "prompt-vs-topic",
"definition": "A prompt is one request a customer might type into an AI model, tracked for a business and asked exactly as written.",
"created_at": "2026-10-26T09:35:34Z",
"updated_at": "2026-10-26T09:35:34Z"
}
]
}ErrorsResponse format and status codes
Error response envelope
errorErrorStructured error payload.
Error
codestringStable snake_case code suitable for programmatic handling.
messagestringHuman-readable explanation of the failure.
detailsobject | array | nullStructured validation or request context when available.
request_idstringIdentifier to provide when requesting support.
{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid.",
"details": [
{
"field": "name",
"message": "must be present"
}
],
"request_id": "req_01K1GP6J8QQFZ4D2B6C5A9V3TS"
}
}Status codes
401invalid_api_keyThe API key is absent, invalid, expired, or revoked.
403forbidden | workspace_suspended | workspace_archivedThe key is not workspace-scoped, lacks workspace:read, or the workspace is suspended or archived.
GETList help articles
/help/articlesReturns help articles in help center order, with optional filters.
List help articles
/help/articlesQuery parameters
productmerchant | playbook | developerOnly return articles from one help section.
categorystringOnly return articles from one category. Categories can change, so an unknown category returns no articles instead of an error.
typequestion | guideOnly return questions or only guides.
updated_sincedatetimeOnly return articles updated at or after this ISO 8601 time, such as 2026-11-01T00:00:00Z. URL-encode a + in a time zone offset.
pageintegerOne-based page number.
per_pageintegerArticles per page, from 1 to 200.
Response envelope
articles:HelpArticle[]pagination:PaginationarticlesHelpArticle[]Articles on this page.
paginationPaginationpage, per_page, total and total_pages.
HelpArticle
idstringStable article identifier.
categorystringID of the category, from Get help center.
productmerchant | playbook | developerHelp section: merchant is the Business help for businesses and their staff, playbook is the Partner playbook for selling and supporting the product, and developer is the Developer docs for integration teams.
typequestion | guidequestion is a frequently asked question; guide is a longer walkthrough. Filter on type=question for an FAQ.
audienceboth | partners | agenciesWho the article is written for.
orderintegerPosition of the article within its category.
titlestringArticle title.
shortstringThe answer in one paragraph of plain text.
detailstringThe full article in Markdown, with ### subheadings, lists and bold text. References to other articles read "(See: Article title)".
variantsstring[]Other ways people ask the same question. Useful as keywords in your own search.
relatedstring[]IDs of related articles.
featuresstring[] | nullProduct features the article is about, such as actions. Null when it applies to the whole product.
playbook_notestring | nullExtra advice for partners who sell or support the product.
developer_notestring | nullExtra technical detail for integration teams.
created_atdatetimeWhen the article was added.
updated_atdatetimeWhen the article was last edited.
Request and response
curl --request GET \
--url 'https://api.signal.ceyo.ai/v1/help/articles?product=merchant&type=question' \
--header 'Authorization: Bearer ceyo_platform_...'{
"articles": [
{
"id": "cadence",
"category": "account",
"product": "merchant",
"type": "question",
"audience": "both",
"order": 2,
"title": "How often are my prompts measured?",
"short": "How often your prompts are measured depends on your package; ask our support team which cadence you have. A steady reading comes from enough different prompts per topic, more than from how often they run.",
"detail": "Cadence is how often your prompts are run on the AI models. Each round is called a scan.\n\n### Why the number of prompts matters most\n\nAnswers vary from one run to the next, so a single prompt says little. ...",
"variants": [
"How often are results updated, and is that often enough?",
"Is a weekly scan enough?"
],
"related": [
"reliability",
"history",
"why-many"
],
"features": null,
"playbook_note": "A package's cost grows with the number of answers it collects, so more prompts at a lower cadence is often better value than fewer prompts at a higher one.",
"developer_note": null,
"created_at": "2026-10-26T09:35:34Z",
"updated_at": "2026-10-26T16:52:57Z"
}
],
"pagination": {
"page": 1,
"per_page": 100,
"total": 1,
"total_pages": 1
}
}ErrorsResponse format and status codes
Error response envelope
errorErrorStructured error payload.
Error
codestringStable snake_case code suitable for programmatic handling.
messagestringHuman-readable explanation of the failure.
detailsobject | array | nullStructured validation or request context when available.
request_idstringIdentifier to provide when requesting support.
{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid.",
"details": [
{
"field": "name",
"message": "must be present"
}
],
"request_id": "req_01K1GP6J8QQFZ4D2B6C5A9V3TS"
}
}Status codes
401invalid_api_keyThe API key is absent, invalid, expired, or revoked.
403forbidden | workspace_suspended | workspace_archivedThe key is not workspace-scoped, lacks workspace:read, or the workspace is suspended or archived.
422validation_failedA query parameter is missing or invalid.
GETGet help article
/help/articles/{id}Returns one help article.
Get help article
/help/articles/{id}Path parameters
idstringArticle identifier, such as cadence.
Response envelope
article:HelpArticleThe article.
Request and response
curl --request GET \
--url 'https://api.signal.ceyo.ai/v1/help/articles/cadence' \
--header 'Authorization: Bearer ceyo_platform_...'{
"article": {
"id": "cadence",
"category": "account",
"product": "merchant",
"type": "question",
"audience": "both",
"order": 2,
"title": "How often are my prompts measured?",
"short": "How often your prompts are measured depends on your package; ask our support team which cadence you have. A steady reading comes from enough different prompts per topic, more than from how often they run.",
"detail": "Cadence is how often your prompts are run on the AI models. Each round is called a scan.\n\n### Why the number of prompts matters most\n\nAnswers vary from one run to the next, so a single prompt says little. ...",
"variants": [
"How often are results updated, and is that often enough?",
"Is a weekly scan enough?"
],
"related": [
"reliability",
"history",
"why-many"
],
"features": null,
"playbook_note": "A package's cost grows with the number of answers it collects, so more prompts at a lower cadence is often better value than fewer prompts at a higher one.",
"developer_note": null,
"created_at": "2026-10-26T09:35:34Z",
"updated_at": "2026-10-26T16:52:57Z"
}
}ErrorsResponse format and status codes
Error response envelope
errorErrorStructured error payload.
Error
codestringStable snake_case code suitable for programmatic handling.
messagestringHuman-readable explanation of the failure.
detailsobject | array | nullStructured validation or request context when available.
request_idstringIdentifier to provide when requesting support.
{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid.",
"details": [
{
"field": "name",
"message": "must be present"
}
],
"request_id": "req_01K1GP6J8QQFZ4D2B6C5A9V3TS"
}
}Status codes
401invalid_api_keyThe API key is absent, invalid, expired, or revoked.
403forbidden | workspace_suspended | workspace_archivedThe key is not workspace-scoped, lacks workspace:read, or the workspace is suspended or archived.
404not_foundNo article has this ID.
GETSearch help articles
/help/searchReturns up to 10 articles that match a question or keywords, best match first.
Search help articles
/help/searchQuery parameters
qstringWhat the person is looking for, up to 500 characters.
productmerchant | playbook | developerOnly return articles from one help section.
categorystringOnly return articles from one category. Categories can change, so an unknown category returns no articles instead of an error.
typequestion | guideOnly return questions or only guides.
Response envelope
articles:HelpArticle[]Matching articles, best match first. Empty when nothing matches.
Request and response
curl --request GET \
--url 'https://api.signal.ceyo.ai/v1/help/search?q=how%20often%20are%20prompts%20measured' \
--header 'Authorization: Bearer ceyo_platform_...'{
"articles": [
{
"id": "cadence",
"category": "account",
"product": "merchant",
"type": "question",
"audience": "both",
"order": 2,
"title": "How often are my prompts measured?",
"short": "How often your prompts are measured depends on your package; ask our support team which cadence you have. A steady reading comes from enough different prompts per topic, more than from how often they run.",
"detail": "Cadence is how often your prompts are run on the AI models. Each round is called a scan.\n\n### Why the number of prompts matters most\n\nAnswers vary from one run to the next, so a single prompt says little. ...",
"variants": [
"How often are results updated, and is that often enough?",
"Is a weekly scan enough?"
],
"related": [
"reliability",
"history",
"why-many"
],
"features": null,
"playbook_note": "A package's cost grows with the number of answers it collects, so more prompts at a lower cadence is often better value than fewer prompts at a higher one.",
"developer_note": null,
"created_at": "2026-10-26T09:35:34Z",
"updated_at": "2026-10-26T16:52:57Z"
}
]
}ErrorsResponse format and status codes
Error response envelope
errorErrorStructured error payload.
Error
codestringStable snake_case code suitable for programmatic handling.
messagestringHuman-readable explanation of the failure.
detailsobject | array | nullStructured validation or request context when available.
request_idstringIdentifier to provide when requesting support.
{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid.",
"details": [
{
"field": "name",
"message": "must be present"
}
],
"request_id": "req_01K1GP6J8QQFZ4D2B6C5A9V3TS"
}
}Status codes
401invalid_api_keyThe API key is absent, invalid, expired, or revoked.
403forbidden | workspace_suspended | workspace_archivedThe key is not workspace-scoped, lacks workspace:read, or the workspace is suspended or archived.
422validation_failedA query parameter is missing or invalid.