Skip to main content
POST
Test an AI filter on a sample message

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Body

application/json

An AI filter and a sample message to test it on. Nothing is saved and no run starts; the model call is billed like any other.

classifier
object
required

The AI filter to test, as it would be saved on the trigger.

Example:
message
object
required

A sample message: its text and up to four screenshots.

Response

What the AI filter decided for the sample message.

What the AI filter decided for the sample message.

decision
object
required

The filter's decision, as a run would record it.

wouldWake
boolean
required

Whether this message would wake the agent with the filter saved as given. In preview mode the agent always wakes; this says what mode on would do.