Guides
API reference
MCP server
Changelogcurl --request PATCH \
--url https://api-prod.heliyos.ai/v1/auth/organizations/current \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"knowledgeBase": {
"productsInformation": "Wholesale catalogue of 1,200 specialty foods, with next-day delivery in 40 metro areas.",
"painPoints": "Independent grocers lose margin to stockouts and juggle too many small suppliers.",
"valueProposition": "One supplier, one invoice and next-day restocking for the long tail of the shelf.",
"qualificationCriteria": "Independent grocers or cafe groups with 3 or more locations and a buyer we can reach.",
"entries": [
{
"label": "Pricing",
"content": "Volume pricing starts at $5,000 a month. Net 30 terms after the first order."
},
{
"label": "Competitors",
"content": "Regional distributors and direct-from-brand programs. We win on breadth and delivery speed."
},
{
"label": "Delivery areas",
"content": "Next-day delivery in 40 metro areas across the US and Canada. Two-day delivery elsewhere."
}
]
}
}
'{
"meta": {
"message": "Organization details successfully updated."
},
"data": {}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Update the knowledge base
Changes the knowledge base, the business context and the workspace profile. Send only the fields you want to change. Fields you leave out keep their values.
knowledgeBase is replaced whole. When you send it, the stored knowledge base becomes
exactly what you sent: a fixed text or an entry you leave out is removed. To change one text
or add one entry, call Get the knowledge base, change what you need, and send the whole
object back.
- An empty string clears a text.
- Top-level fields this page does not list are ignored without an error.
- Keys inside
knowledgeBaseand its entries that are not listed here are stored as you send them. - Entry labels are not checked for duplicates. Keep them unique so people and workers can tell them apart.
Workers read the new knowledge base on their next run. Only workspace owners and admins can call this. API keys act as an admin, so every key can.
curl --request PATCH \
--url https://api-prod.heliyos.ai/v1/auth/organizations/current \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"knowledgeBase": {
"productsInformation": "Wholesale catalogue of 1,200 specialty foods, with next-day delivery in 40 metro areas.",
"painPoints": "Independent grocers lose margin to stockouts and juggle too many small suppliers.",
"valueProposition": "One supplier, one invoice and next-day restocking for the long tail of the shelf.",
"qualificationCriteria": "Independent grocers or cafe groups with 3 or more locations and a buyer we can reach.",
"entries": [
{
"label": "Pricing",
"content": "Volume pricing starts at $5,000 a month. Net 30 terms after the first order."
},
{
"label": "Competitors",
"content": "Regional distributors and direct-from-brand programs. We win on breadth and delivery speed."
},
{
"label": "Delivery areas",
"content": "Next-day delivery in 40 metro areas across the US and Canada. Two-day delivery elsewhere."
}
]
}
}
'{
"meta": {
"message": "Organization details successfully updated."
},
"data": {}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}knowledgeBase replaces it whole. Leaving out a text or an entry deletes it, and
it cannot be recovered. Read the knowledge base first and send every text and entry you
want to keep.heliyos_knowledge_entries_delete, heliyos_knowledge_entries_set, heliyos_knowledge_get, heliyos_knowledge_update.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Body
What the business does, in your team's words. Plain text or Markdown. An empty string clears it.
The whole knowledge base. Replaces the stored one. Each text is plain text, Markdown or HTML, and an empty string clears it.
Show child attributes
Show child attributes
The workspace's name, 1 to 200 characters after trimming.
1 - 200The company website, an http or https URL. An empty string clears it.
The industry, as free text. An empty string clears it.
The workspace's time zone, as an IANA name such as America/New_York. Not checked against a list. An empty string clears it.
Street address. An empty string clears it.
City. An empty string clears it.
State or region. An empty string clears it.
Postal code. An empty string clears it.
Country. An empty string clears it.
The logo: the id of a file uploaded with Upload a file, or the https URL Heliyos returned for it. Other URLs are refused. An empty string clears it.
Was this page helpful?