Create a segment

Creates a new segment in the active project. Segment names are unique per project and case-insensitive.

POST /api/v1/segments

Body parameters

Name	Type	Required	Description
name	string	Required	A label for the segment. May be up to 64 characters. Segment names are unique per project and case-insensitive, so `Direct Competitors` and `direct competitors` will collide.

Response

The segment object

Field	Type	Description
id	integer	The unique ID of the segment.
project_id	integer	The ID of the project this segment belongs to.
name	string	The display label of the segment.
created_at	datetime	When the segment was created.
updated_at	datetime	When the segment was last updated.

curl -X POST https://pineprompt.com/api/v1/segments \ -H "Authorization: Bearer $PINEPROMPT_TOKEN" \ -H "Pineprompt-Project-Id: 1" \ -H "Content-Type: application/json" \ -d '{ "name": "Enterprise Competitors" }'

import os import requests response = requests.post( "https://pineprompt.com/api/v1/segments", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", "Content-Type": "application/json", }, json={ "name": "Enterprise Competitors", }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->post('https://pineprompt.com/api/v1/segments', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], 'json' => [ 'name' => 'Enterprise Competitors', ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);