Skip to main content
POST
Create intent rule
Creates an intent rule. Use status: "DRAFT" for a reviewable draft or status: "PUBLISHED" for a live version.

Headers

string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs write scope.
string
required
application/json

Body parameters

string
required
Rule name.
string
required
Natural-language routing description used by the planner.
string
required
Send intent.
string
DRAFT or PUBLISHED. Defaults to PUBLISHED. ARCHIVED is rejected.
RuleNodeConfig
Rule tree. See the shared RuleNodeConfig shape.
string[]
Agent IDs to assign to a published rule. Drafts cannot include agent assignments.

Response

Returns the created Rule. Draft responses have botIds: [].

Errors

The body is malformed, a draft includes agent assignments, an agent ID is invalid, or flowConfig references a missing action or widget form.
The API key is missing, malformed, revoked, or invalid.
The API key does not include the write scope required for this route.