Skip to content

Show a consumer's assistant grant

GET
/api/v1/channels/consumers/{realmName}/{consumerName}/assistant
curl --request GET \
--url http://localhost:11044/api/v1/channels/consumers/example/example/assistant \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Whether the realm declared it, whether the owner granted it, and the paired sender threads.

realmName
required
string

Name of the captured realm installed in the signed-in owner’s world; non-blank, at most 256 UTF-8 bytes, no control characters and not all * (400 otherwise). 404 when it has no live installation

consumerName
required
string

Name of a consumer the realm declares; same text rules as the realm name. 404 when the installation declares none by that name

OK

Media type*/*

Whether a captured realm consumer may answer through the owner’s assistant, and which sender threads it answers; returned by the /channels/consumers/{realmName}/{consumerName}/assistant routes

object
consumerName
required

Name of the consumer, as the realm declares it

string
declared
required

Whether the realm declared the consumer with assistant: true; only such a consumer can be granted

boolean
granted
required

Whether the owner has granted the consumer leave to answer through the assistant

boolean
installationId
required

The live installation of that realm this was read from; send it back as installationId on a change

string
paired
required

The sender threads paired with the consumer, which it answers, sorted; empty when none, or when not granted

Array<string>
realmName
required

Name of the realm the consumer belongs to

string
revision
required

That installation’s revision; send it back as expectedRevision on a change. Pairing and unpairing do not move it

integer format: int64