Pearl
Get Pearl Settings
Retrieves the Settings for the specified Pearl. The shape of the response depends on the Pearl: the Pearl section is a Simple Pearl configuration (opening sentence + flow script) or a Pearl configuration (node graph), and the Inbound/Outbound section carries the voice or the text settings according to the AgentType field (1 = Voice, 2 = Text). AgentType also tells you which update endpoint to use: Update Pearl (Simple Pearl), Update Voice Pearl, or Update Text Pearl.
get/v2/Pearl/{pearlId}/Settings
Request
- Base URLhttps://api.nlpearl.ai
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
pearlIdstring required
The unique identifier of the Pearl.
Response
The settings for the specified Pearl: a Simple Pearl, a voice Pearl, or a text Pearl configuration depending on the Pearl.
Changes
No recorded changes to this operation across all 1 revision of this API.