Create segment
POST
/v1/api/sites/{site_id}/segments- Scope
sites:write- Token
- OAuth access token only
- Role
- Editor, owner or admin
- MCP tool
create_segment· preview: MCP write tools are in preview- What scopes, tokens and roles mean →
Request
cURL
curl -X POST "https://api.crawle.io/v1/api/sites/11111111-1111-1111-1111-111111111111/segments" \
-H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Example","conditions":[{"negate":false,"pattern":"example","pattern_type":"contains"}]}'JavaScript
const response = await fetch("https://api.crawle.io/v1/api/sites/11111111-1111-1111-1111-111111111111/segments", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Example",
"conditions": [
{
"negate": false,
"pattern": "example",
"pattern_type": "contains"
}
]
}),
});
const data = await response.json();Python
import os
import uuid
import requests
response = requests.request(
"POST",
"https://api.crawle.io/v1/api/sites/11111111-1111-1111-1111-111111111111/segments",
headers={
"Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
"Idempotency-Key": str(uuid.uuid4()),
},
json={
"name": "Example",
"conditions": [
{
"negate": False,
"pattern": "example",
"pattern_type": "contains"
}
]
},
)
data = response.json()$CRAWLE_ACCESS_TOKEN- is an OAuth access token from your integration's sign-in.
Idempotency-Key- is a new unique value for each new request.
Response 201: a JSON object. Its fields are not described in the API contract yet, so no example is shown.
Parameters
site_idpath · string (uuid)requiredIdempotency-Keyheader · stringrequired- 1–180 characters
Request body
conditionsarray of SegmentConditionInputrequired- up to 50 items
negateboolean- default false
patternstringrequired- 1–500 characters
pattern_typeenum- one of "contains", "prefix", "suffix", "regex" · default "contains"
namestringrequired- 1–100 characters
colorstring- default "#3b82f6"
descriptionstring or null- up to 500 characters
match_modeenum- one of "all", "any" · default "all"
Response 201
Returns a JSON object. Its fields are not described in the API contract yet.
Errors
401
- When
- Missing, invalid, or expired token.
403
- When
- The token has none of the accepted scopes (
sites:write).
403
- When
- Called with an API key. This endpoint needs an OAuth access token.
403
- When
- The person's workspace role is below editor.
422
- When
- The request did not match the schema.
detaillists each problem.
429
- When
- Rate limited. Wait for
Retry-Afterseconds.
Generated from the API contract at 7e7039b0b, synced October 30, 2026.