Advice Batch

Evaluates up to 25 Dialogues. The same set may repeat: Dialogues with identical IDs and inputs share one evaluation and report the same result, and every other Dialogue is evaluated independently, a few at a time. The analytics headers apply to every slot. A slot reuses a singular response-cache entry only when API key, Accept, cmfy-taffrail-version, and viewing base match. The default per-slot deadline is two seconds and starts when evaluation begins.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
state
object

Optional shared inputs for every Dialogue. Each Dialogue's state and options are merged over these. Send a Date as YYYY-MM-DD.

string

Optional identifier for the advice recipient (the investor, not the advisor or the integrating client), recorded in the audit row for every slot and kept out of params.

dialogues
array of objects
required
length between 1 and 25

Advice Sets to evaluate.

dialogues*
string
required
^[A-Z]{2}[A-Za-z0-9_-]+$

Fully qualified Advice Set identifier.

state
object

Optional inputs for this Dialogue, deep-merged over the shared state: nested objects merge member by member, arrays and values of a different type replace the shared value whole, and this Dialogue wins where both set a value. A null drops that key, including one inherited from the shared state. Send a Date as YYYY-MM-DD.

options
object

Optional display options for this Dialogue, applied over its merged state. An unsupported option fails only this slot, with a slot 400.

Optional singular Advice API output expansions.

fields
object

Optional singular Advice API sparse fieldsets.

Optional singular Advice API output filters.

string
enum

Adds transformed.text from non-blank advice headlines and, for +html content types, transformed.html from HTML headlines. The advice array is unchanged. When fields.advice is set, it must include headline; omitting fields entirely is fine.

Allowed:
Headers
integer
enum
Defaults to 2
Allowed:
string

Opaque session identifier for the end user, for analytics. Reuse the same value across a visitor's requests so they correlate into one session. Also accepted as taffrail-sid; when both arrive, cmfy-taffrail-sid wins.

string

The end user's IPv4 or IPv6 address, for analytics. Forward this when calling server-to-server on a user's behalf so usage is attributed to the person rather than your server; values that don't parse as a real IP address are ignored. Also accepted as taffrail-client-ip; when both arrive, cmfy-taffrail-client-ip wins.

string

URL of the page that originated the request, for analytics. Takes precedence over the standard Referer header. Also accepted as taffrail-api-referrer; when both arrive, cmfy-taffrail-api-referrer wins.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json