SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Launchpad

Add text about the business to the client chatbot knowledge base

Saved as a note in the knowledge base the build created; the chatbot can answer from it once it has been read, usually within a minute. Sending the same title and text again is recognised (duplicate true). Errors: 400 title_required or text_required, 413 text_too_long (over 50,000 characters, split it), 409 no_knowledge_base (the client has no chatbot), 409 client_not_ready.

POSThttps://app.softsolz.uk/api/v1/services/launchpad/clients/{id}/knowledge

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

titlestringrequired

Note title. Longer titles are cut to 200 characters.

textstringrequired

What the chatbot should learn.

Response

Response Body

addedbooleanTrue when a new note was stored.
duplicatebooleanTrue when the same note already existed.
document_idstringThe note in the knowledge base.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/launchpad/clients/{id}/knowledge \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"title": "Opening hours",
"text": "Open Tuesday to Sunday, 12:00 to 22:00. The kitchen closes at 21:30. Closed on Mondays and bank holidays."
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"added": true,
"duplicate": false,
"document_id": "c4a1e8f2-6b3d-4c7a-9e5f-1d2b3a4c5e6f"
}
}