Save segment
save_segmentAdd a segment (a market and language to track), or with segment edit one or pause and resume it. A segment can carry an audience on the Business plan: a buyer described by situation (budget, role, company size, home, priorities) that is sent with every prompt as an 'About me' line, so answers show what the engines tell that buyer; Google AI Overviews and AI Mode are not collected for it. To compare an audience with an existing segment, create a new segment with copy_prompts_from and an audience. Cost: an active segment is plan capacity and collects daily from every plan model, using model budget; copied prompts each use one prompt of plan capacity.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"brand": "<brand>",
"idempotency_key": "<idempotency_key>"
},
"name": "save_segment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| geo | No | Country code, for example GB, or global: where this segment's answers are collected from. | |
| name | No | ||
| brand | Yes | Brand or study: its ID from list_brands, or its exact name. A partial name is refused. | |
| status | No | ||
| segment | No | Edit this segment (ID or name). Leave out to add one. | |
| audience | No | The buyer this segment's prompts are asked as. Replaces the current audience. Describe needs and situation: age and gender alone rarely change answers. | |
| language | No | Language code, for example en. | |
| prompt_limit | No | ||
| idempotency_key | Yes | A unique key for this intended action. Reuse it with identical arguments when retrying: the write is not made again, and the reply is the first call's resource as saved (replayed: true) with current status; read tools show the resource's current state. Use a new key for another action. | |
| audience_template | No | Start from a built-in audience instead of passing audience; none removes the audience. | |
| copy_prompts_from | No | New segments only: copy this segment's (ID or name) active prompts, market and language into the new segment, so the two can be compared. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| generated_at | Yes | RFC 3339 time the response was made. | |
| schema_version | Yes |