Get a random hint

GET

/api/v1/hints/random

const url = 'http://localhost:11044/api/v1/hints/random';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/hints/random \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns an empty body when every hint is excluded.

Authorizations

apiKeyAuth
basicAuth

Parameters

Query Parameters

exclude

Array<string>

Hint ids to suppress, so a client can avoid repeating recently shown hints

surface

string

Asking surface: ‘me’ or ‘console’. Omit for every surface’s hints.

Responses

200

One hint, or an empty body when every hint is excluded

*/*

One tip for a UI to show, from the installation, the world’s config or an installed realm. Returned by the /hints endpoints.

object

action

A one-click follow-up that fills the host surface’s chat input. Null when the tip has none

object

chatInput

required

Text to put in the chat input, not sent automatically. Empty when the hint file gives none

string

label

required

Button text for the follow-up; Do It when the hint file gives none

string

body

required

The tip itself, as Markdown. Empty when its file gives none

string

category

required

Grouping the tip belongs to; the stock set uses hint, did-you-know and fun-fact, and a file that names none gets hint

string

icon

Icon name as the hint file gives it, passed through uninterpreted. Null when the file gives none

string

required

Identifier built from the hint file’s name and the tip’s position in it: stable while the file is unchanged, unique across files. What GET /hints/random takes in exclude

string

realm

Name of the realm that shipped the tip. Null for a tip from the installation or the world’s own config

string

surface

required

Which UI the tip is for: me (the chat surfaces), console (the worlds console) or all

string

title

required

Short heading for the tip. Empty when its file gives none

string

401

Basic-auth challenge failed