Connect a Pexafy account
connect_accountAsks the host to offer its own flow for connecting a Pexafy account, when none is attached. Use it when the person asks to connect, link or sign in to a Pexafy account — including from the account button in the Pexafy grid — or wants more searches than the daily allowance available without an account.
When no account is attached, it returns an error result that carries an account-connection request for the host: the error is how that request is delivered, not a failure. A host that supports it shows its own account-connection prompt, which the person completes or dismisses; other hosts show only the result's text. Calling it again returns the same request. When an account is already attached, it says so and starts nothing.
It does not search, and searching does not require calling it. check_only is set by the Pexafy grid to read the state without opening a prompt; leave it unset when the person wants to connect or sign in.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| check_only | No | Set by the Pexafy results grid: `true` reports whether an account is connected — and the allowance in force — without opening the connection prompt. Leave it unset when the person wants to connect or sign in. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budget | No | What is left of the current allowance, or null when it is not worth saying. | |
| connected | No | Whether an account is attached to this conversation. |