Quick Start

Get up and running with Cipres in under 5 minutes. This guide walks you through creating your first project, building a pipeline, defining segmentation rules, and sending data via the API.

1. Get Access

Cipres is currently in a private early access program. If you're part of the program, you'll have received credentials from our team to access the dashboard.

2. Create a Project

In the Cipres dashboard, create a new Project. Projects are the top-level container for your pipelines and data sources.

3. Create a Pipeline

Inside your project, create a new Pipeline. This is where you'll define your segmentation logic visually — connecting nodes, setting conditions, and configuring outputs.

4. Define Segmentation Rules

Add segmentation nodes to your pipeline. You can combine attribute-based rules with semantic conditions using natural language:

Semantic condition: "users expressing frustration, complaints, or negative experiences"

Upload sample data to test your pipeline until you're satisfied with the results. When ready, deploy the pipeline to production as a versioned release.

5. Get Your API Key

Navigate to Settings → API Keys and create a new API key. Keep this key safe — you'll need it to authenticate API requests.

sk_a1b2c3d4...

Security Note: Never expose your API key in client-side code. Always make API calls from your backend.

6. Send Data via HTTP

Your engineering team sends real user data to Cipres using the REST API. Segmentation rules apply in real-time against the deployed pipeline:

cURL 
curl -X POST https://cipres.tech/api/v1/users \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_a1b2c3d4..." \
  -d '{
    "project_id": 1,
    "users": [
      {
        "user_id": "user_001",
        "text": "Love the new feature! Makes my workflow easier.",
        "attributes": {"plan": "pro"}
      },
      {
        "user_id": "user_002",
        "text": "The app keeps crashing when I export. Frustrating.",
        "attributes": {"plan": "free"}
      }
    ]
  }'

The API returns 202 Accepted immediately. Users are processed in the background and matched against your segments.

7. Set Up a Webhook

Add a webhook to get notified when users match your segment. In the pipeline settings, configure a webhook URL:

https://your-app.com/webhooks/cipres

When user_002 matches the "Frustrated Users" segment, you'll receive:

Webhook Payload 
{
  "event_type": "user_added",
  "timestamp": "2024-01-22T17:30:00Z",
  "pipeline_id": 1,
  "segment": {
    "id": "seg_abc123",
    "name": "Frustrated Users"
  },
  "user": {
    "id": "user_002",
    "score": 0.89
  }
}

Next Steps