Skip to content
Staircase

Frequently-asked questions

Products

Answers a borrower's questions from a curated knowledge base rather than from the model's general knowledge, with the source behind each answer.

Used when
At any point in the conversation, alongside whichever subject is open.
Collects
  • The question, and the subject it was asked from.
Returns
  • The answer, and the document it came from.
  • The question itself, recorded, so an unanswered one becomes a knowledge-base gap.
Evidence
  • bot-faq-support
  • chatbot-knowledge-update

Operations

FAQ bot service

GET /

Get Bot Knowledge

getKnowledge

Get knowledge of faq bot

Get extra bot knowledge

Response
application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring
urlstring
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Response 503application/json
1 fields

Service Unavailable

FieldTypeDescription
messagestringError message
Other responses

200

POST /

Update Bot Knowledge

updateBotKnowledge

Update knowledge

Patch bot

Response
application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
Response 400application/json
1 fields

Bad Request

FieldTypeDescription
messagestringError message
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring
urlstring
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Response 503application/json
1 fields

Service Unavailable

FieldTypeDescription
messagestringError message
Other responses

200

DELETE /{knowledge_id}

Delete Bot Knowledge

deleteKnowledge

Delete extra knowledge

Delete extra bot knowdlege from faq-bot-service

Response
application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
Parameters
1
ParameterTypeExampleDescription
knowledge_id required string path id_knowledge Knowledge id
Response 400application/json
1 fields

Bad Request

FieldTypeDescription
messagestringError message
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring
urlstring
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Response 503application/json
1 fields

Service Unavailable

FieldTypeDescription
messagestringError message
Other responses

204

POST /slab

Update Bot Knowledge Slab

updateBotKnowledgeSlab

Update knowledge

Slab webhook for updating bot knowledge

Request
application/json
{
  "type": "post_update",
  "post": {
    "id": "elaykynn",
    "title": "Neuromancer",
    "link_access": "internal",
    "state": "published",
    "version": 1,
    "bannerUrl": null
  },
  "old_post": {
    "state": "archived",
    "link_access": "internal",
    "bannerUrl": null,
    "ownerId": "l7ibj9w0",
    "archiverId": "l7ibj9w0",
    "publisherId": "l7ibj9w0",
    "seriesId": null
  },
  "archiver": null,
  "owner": {
    "id": "l7ibj9w0",
    "name": "William Gibson"
  },
  "publisher": {
    "id": "l7ibj9w0",
    "name": "William Gibson"
  },
  "series": null
}
Response
application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring
urlstring
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Response 503application/json
1 fields

Service Unavailable

FieldTypeDescription
messagestringError message
Other responses

200

POST /sync

Sync Bot Knowledge

syncBotKnowledgeSlab

Sync knowledge

Slab webhook for updating bot knowledge from Slab and knowledge database

Response
application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring
urlstring
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Response 503application/json
1 fields

Service Unavailable

FieldTypeDescription
messagestringError message
Other responses

200

Others in Products

Type to search.