Get a knowledge document

GET

/public/v1/knowledge/{topic}

curl --request GET \
  --url https://example.kwickbooking.com/public/v1/knowledge/example \
  --header 'Authorization: Bearer <token>'

• Your deployment

Returns one of the venue’s knowledge-base documents, as published: venue-details, faq, opening-hours, happy-hours, food-menu, drinks-menu, special-hours, kitchen-hours or compendium. Use it for questions such as dress code, parking or accessibility (faq, venue-details).

Authorizations

• IntegrationKey

Parameters

Path Parameters

topic

required

string

Query Parameters

venueId

string format: uuid

Responses

200

OK

Media typeapplication/json

GET /public/v1/knowledge/{topic}: one of the venue’s knowledge-base documents in its stored shape, and a summary.

object

venueId

required

string format: uuid

topic

required

string

source

required

string

document

required

summary

required

string

Example

{
  "venueId": "01920000-0000-7000-8000-000000000001",
  "topic": "faq",
  "source": "knowledge-base",
  "document": {
    "items": [
      {
        "question": "Is there a dress code?",
        "answer": "Smart casual."
      }
    ]
  },
  "summary": "FAQ for Soho: 1 question"
}

400

Venue required (https://developers.kwickblocks.ai/problems/venue-required); Validation failed (https://developers.kwickblocks.ai/problems/validation-failed)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Venue required

{
  "type": "https://developers.kwickblocks.ai/problems/venue-required",
  "title": "Venue required",
  "status": 400,
  "detail": "Please say which venue this is for."
}

Validation failed

{
  "type": "https://developers.kwickblocks.ai/problems/validation-failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "Some of the details weren't valid. Please check them and try again."
}

401

Invalid or missing integration key (https://developers.kwickblocks.ai/problems/invalid-key)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Exampleinvalid-key

Invalid or missing integration key

{
  "type": "https://developers.kwickblocks.ai/problems/invalid-key",
  "title": "Invalid or missing integration key",
  "status": 401,
  "detail": "This integration key isn't valid. Ask the venue's admin for a new one."
}

403

Capability not granted (https://developers.kwickblocks.ai/problems/capability-missing)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Examplecapability-missing

Capability not granted

{
  "type": "https://developers.kwickblocks.ai/problems/capability-missing",
  "title": "Capability not granted",
  "status": 403,
  "detail": "This integration key isn't allowed to do that. Ask the venue's admin to add the capability."
}

404

Venue not found (https://developers.kwickblocks.ai/problems/venue-not-found); Not published (https://developers.kwickblocks.ai/problems/knowledge-not-found)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Venue not found

{
  "type": "https://developers.kwickblocks.ai/problems/venue-not-found",
  "title": "Venue not found",
  "status": 404,
  "detail": "I couldn't find that venue."
}

Not published

{
  "type": "https://developers.kwickblocks.ai/problems/knowledge-not-found",
  "title": "Not published",
  "status": 404,
  "detail": "The venue hasn't published that information yet."
}

429

Too many requests (https://developers.kwickblocks.ai/problems/rate-limited)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Examplerate-limited

Too many requests

{
  "type": "https://developers.kwickblocks.ai/problems/rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "There have been too many requests. Please try again in a minute."
}

503

Temporarily unavailable (https://developers.kwickblocks.ai/problems/service-unavailable)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Exampleservice-unavailable

Temporarily unavailable

{
  "type": "https://developers.kwickblocks.ai/problems/service-unavailable",
  "title": "Temporarily unavailable",
  "status": 503,
  "detail": "That information isn't available right now. Please try again shortly."
}