Skip to main content
POST
Create a new goal

Authorizations

Authorization
string
header
required

API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.

Body

application/json
name
string
required

Name of the goal

Maximum string length: 100
description
string

Detailed description of the goal

instructions
string

Instructions for achieving the goal

metrics
object

JSON object containing goal metrics

scenario_id
string

ID of the scenario this goal is directly linked to (optional)

active
boolean

Whether this goal is active for the scenario (default true)

scenarios
string[]

Array of scenario IDs to associate with this goal (legacy support)

Response

Goal created successfully