# SegmentFlow.ai

> Unified REST API for SegmentFlow.ai — send expected emails, track server-side business events, and manage Profiles, Templates, Catalog Products, Assets, Brand Kit resources, and EmailSends from your own systems.

## Docs

- [Bulk enrich asset metadata](https://segmentflow.ai/docs/api-reference/assets/bulk-enrich-asset-metadata.md)
- [Create asset upload URL](https://segmentflow.ai/docs/api-reference/assets/create-asset-upload-url.md)
- [Delete asset](https://segmentflow.ai/docs/api-reference/assets/delete-asset.md)
- [Enrich asset metadata](https://segmentflow.ai/docs/api-reference/assets/enrich-asset-metadata.md)
- [List assets](https://segmentflow.ai/docs/api-reference/assets/list-assets.md)
- [Post apiv1assets finalize](https://segmentflow.ai/docs/api-reference/assets/post-apiv1assets-finalize.md)
- [Post apiv1assetsupload request](https://segmentflow.ai/docs/api-reference/assets/post-apiv1assetsupload-request.md)
- [Register asset](https://segmentflow.ai/docs/api-reference/assets/register-asset.md)
- [Update asset metadata](https://segmentflow.ai/docs/api-reference/assets/update-asset-metadata.md)
- [Get background job progress](https://segmentflow.ai/docs/api-reference/backgroundjobs/get-background-job-progress.md): Query step-level progress for a Temporal-backed background job owned by the active organization.
- [Delete apiv1brand kit](https://segmentflow.ai/docs/api-reference/brand-kit/delete-apiv1brand-kit.md)
- [Get apiv1brand kit](https://segmentflow.ai/docs/api-reference/brand-kit/get-apiv1brand-kit.md)
- [Get apiv1brand kit 1](https://segmentflow.ai/docs/api-reference/brand-kit/get-apiv1brand-kit-1.md)
- [Get brand kit extraction progress](https://segmentflow.ai/docs/api-reference/brand-kit/get-brand-kit-extraction-progress.md): Query step-level progress for the brand kit extraction workflow. Returns the current step, completed steps, and completion/failure state. Falls back to a DB-derived summary when the workflow has completed and no longer exists in Temporal.
- [Patch apiv1brand kit](https://segmentflow.ai/docs/api-reference/brand-kit/patch-apiv1brand-kit.md)
- [Post apiv1brand kit](https://segmentflow.ai/docs/api-reference/brand-kit/post-apiv1brand-kit.md)
- [Post apiv1brand kit clear](https://segmentflow.ai/docs/api-reference/brand-kit/post-apiv1brand-kit-clear.md)
- [Post apiv1brand kit extract](https://segmentflow.ai/docs/api-reference/brand-kit/post-apiv1brand-kit-extract.md)
- [Post apiv1brand kit set default](https://segmentflow.ai/docs/api-reference/brand-kit/post-apiv1brand-kit-set-default.md)
- [Post apiv1brand kitextract](https://segmentflow.ai/docs/api-reference/brand-kit/post-apiv1brand-kitextract.md)
- [Put apiv1brand kit](https://segmentflow.ai/docs/api-reference/brand-kit/put-apiv1brand-kit.md)
- [Create broadcast](https://segmentflow.ai/docs/api-reference/broadcasts/create-broadcast.md): Create a Broadcast for a Segment. Inline content creates a saved Email Template first; templateId reuses an existing Template. Set send=true to send immediately, or combine send=true with scheduledAt to schedule.
- [Retrieve broadcast](https://segmentflow.ai/docs/api-reference/broadcasts/retrieve-broadcast.md): Retrieve a read-safe Broadcast status handle by id.
- [Retrieve broadcast stats](https://segmentflow.ai/docs/api-reference/broadcasts/retrieve-broadcast-stats.md): Retrieve aggregate delivery and engagement stats for a Broadcast.
- [Bulk enrich catalog product metadata](https://segmentflow.ai/docs/api-reference/catalog-products/bulk-enrich-catalog-product-metadata.md)
- [Enrich catalog product metadata](https://segmentflow.ai/docs/api-reference/catalog-products/enrich-catalog-product-metadata.md)
- [Get catalog product](https://segmentflow.ai/docs/api-reference/catalog-products/get-catalog-product.md)
- [List catalog products](https://segmentflow.ai/docs/api-reference/catalog-products/list-catalog-products.md)
- [Batch send emails](https://segmentflow.ai/docs/api-reference/emails/batch-send-emails.md): Create or replay many independent EmailSend records. Each item has its own recipient identity, one-send data, idempotency key, and result; this is not a Broadcast, Bulk Operation, Carrier, or NewsletterIssue.
- [Retrieve email send](https://segmentflow.ai/docs/api-reference/emails/retrieve-email-send.md): Get the current status handle for an EmailSend.
- [Send email](https://segmentflow.ai/docs/api-reference/emails/send-email.md): Create one EmailSend from either a saved email template or rendered JSX Email content and enqueue delivery. Rendered content must include a request subject.
- [Track event](https://segmentflow.ai/docs/api-reference/events/track-event.md): Accept one server-side identified business event, persist a UserEvent, and trigger matching active Journeys.
- [Retrieve journey run](https://segmentflow.ai/docs/api-reference/journeys/retrieve-journey-run.md): Get the current status handle for a JourneyRun.
- [Trigger journey](https://segmentflow.ai/docs/api-reference/journeys/trigger-journey.md): Trigger one active API-triggerable Journey by stable developer key and return a JourneyRun status handle.
- [Bulk delete profiles](https://segmentflow.ai/docs/api-reference/profiles/bulk-delete-profiles.md): Delete multiple Profiles. Nullifies IdentityBridge rows and cascades to related tables.
- [Delete profile](https://segmentflow.ai/docs/api-reference/profiles/delete-profile.md): Delete a single Profile. Nullifies IdentityBridge rows and cascades to related tables.
- [Get profile](https://segmentflow.ai/docs/api-reference/profiles/get-profile.md): Get a single Profile by ID
- [Get profile subscriptions](https://segmentflow.ai/docs/api-reference/profiles/get-profile-subscriptions.md): Get subscription group statuses for a Profile
- [List profiles](https://segmentflow.ai/docs/api-reference/profiles/list-profiles.md): Get paginated list of Profiles with optional filtering
- [Preview segment](https://segmentflow.ai/docs/api-reference/segments/preview-segment.md): Preview the current matched profile count for a Segment by stable developer key.
- [Retrieve segment](https://segmentflow.ai/docs/api-reference/segments/retrieve-segment.md): Retrieve a read-safe Segment status and membership count by stable developer key.
- [Archive template](https://segmentflow.ai/docs/api-reference/templates/archive-template.md)
- [Create template](https://segmentflow.ai/docs/api-reference/templates/create-template.md)
- [Delete template](https://segmentflow.ai/docs/api-reference/templates/delete-template.md)
- [Duplicate template](https://segmentflow.ai/docs/api-reference/templates/duplicate-template.md): Create an editable copy of an existing template in the current organization
- [Get template](https://segmentflow.ai/docs/api-reference/templates/get-template.md)
- [Get template by key](https://segmentflow.ai/docs/api-reference/templates/get-template-by-key.md)
- [List templates](https://segmentflow.ai/docs/api-reference/templates/list-templates.md): Get all templates for the organization
- [Unarchive template](https://segmentflow.ai/docs/api-reference/templates/unarchive-template.md)
- [Update template](https://segmentflow.ai/docs/api-reference/templates/update-template.md)
- [Authentication](https://segmentflow.ai/docs/authentication.md): Mint an API key in the dashboard and send it on the x-api-key header.
- [Broadcasts](https://segmentflow.ai/docs/broadcasts.md): Create one-time audience emails for a Segment.
- [Catalog products](https://segmentflow.ai/docs/catalog-products.md): List synced product catalog records and understand product image URLs.
- [Emails](https://segmentflow.ai/docs/emails.md): Create durable EmailSend records from saved Email Templates or rendered JSX Email content.
- [Errors](https://segmentflow.ai/docs/errors.md): Status codes and error envelope shape used across the unified API launch surface.
- [Events](https://segmentflow.ai/docs/events.md): Use events.track to record one server-side business event and trigger matching Journeys.
- [Introduction](https://segmentflow.ai/docs/introduction.md): The SegmentFlow.ai unified API lets you send expected emails, track server-side business events, and manage Profiles, Templates, Catalog Products, Assets, Brand Kit resources, and EmailSends from your own systems.
- [Journeys](https://segmentflow.ai/docs/journeys.md): Trigger saved API-entry journeys by stable developer key.
- [Segments](https://segmentflow.ai/docs/segments.md): Read saved audience segments by stable developer key.
- [Sending domain](https://segmentflow.ai/docs/sending-domain.md): Verify your domain with SPF, DKIM, and DMARC so SegmentFlow.ai can send email on your behalf.
- [Templates](https://segmentflow.ai/docs/templates.md): Look up saved email templates by stable developer key.
- [Which API should I use?](https://segmentflow.ai/docs/which-api-should-i-use.md): Choose between emails.send, emails.batchSend, events.track, journeys.trigger, Broadcasts, and Newsletter Issues.

## OpenAPI Specs

- [openapi](https://segmentflow.ai/docs/api-reference/openapi.json)