Core Concepts
Origins
Identify source systems where interactions originate.
Origins identify where an interaction came from — which service, application, or pipeline recorded it.
Creating an origin
POST /api/origins{
"title": "Web Application",
"description": "Main web application",
"mnemonic": "WEBAPP",
"icon": "🌐",
"fontColorHex": "#ffffff",
"bgColorHex": "#8b5cf6"
}Fields
| Field | Required | Description |
|---|---|---|
title | Yes | Human-readable name |
mnemonic | Yes | Short uppercase code |
description | No | What this origin represents |
icon | No | Emoji or icon identifier for UI display |
fontColorHex | No | Text color for UI badges |
bgColorHex | No | Background color for UI badges |
Response
{
"originId": "i9j0k1l2-m3n4-5678-opqr-stuvwxyz1234",
"title": "Web Application",
"description": "Main web application",
"mnemonic": "WEBAPP",
"icon": "🌐",
"fontColorHex": "#ffffff",
"bgColorHex": "#8b5cf6",
"createdDate": "2024-01-15T10:00:00.000Z"
}Filtering
# Filter by origin ID
GET /api/origins?originId=i9j0k1l2-...API reference
| Method | Endpoint | Description |
|---|---|---|
GET | /api/origins | List all (supports originId param) |
GET | /api/origins/:id | Get by ID |
POST | /api/origins | Create |
PUT | /api/origins/:id | Update |
DELETE | /api/origins/:id | Delete |
Common origins
| Mnemonic | Description |
|---|---|
WEBAPP | Web application frontend |
MOBILE | Mobile application |
API | Direct API calls |
CLI | Provenance CLI |
SDK | Provenance SDK |
GITHUB_ACTIONS | GitHub Actions CI/CD |
GITLAB_CI | GitLab CI/CD |
JENKINS | Jenkins pipelines |
CRON | Scheduled jobs |
Design tips
- Create one origin per service or deployment pipeline
- Origins help you answer "where did this interaction come from?" when debugging
- Use the CLI's default origin config (
provenance config set origin MY-SERVICE) so every interaction from that service is automatically tagged