Back to API Overview

Profile Types & Profiles

Custom entity schemas for structured data extraction, plus management of extracted profiles

Endpoints (11)

GET/api/profile-types
Auth Required

List Profile Types

Get all profile type schemas defined by the user.

POST/api/profile-types
Auth Required

Create Profile Type

Define a new custom entity schema for structured data extraction.

GET/api/profile-types/{id}
Auth Required

Get Profile Type

Get a profile type by ID.

PATCH/api/profile-types/{id}
Auth Required

Update Profile Type

Update a profile type's fields or metadata.

DELETE/api/profile-types/{id}
Auth Required

Delete Profile Type

Delete a profile type schema.

GET/api/profile-types/templates
Auth Required

List Built-in Templates

Get built-in profile type templates (e.g. Private Lender, Restaurant, SaaS Company).

GET/api/profiles
Auth Required

List Profiles

Get extracted profiles with optional filtering.

GET/api/profiles/{id}
Auth Required

Get Profile

Get a single profile by ID.

PATCH/api/profiles/{id}
Auth Required

Update Profile

Update profile data or status.

GET/api/profiles/export
Auth Required

Export Profiles

Export profiles as CSV. Optionally filter by matching rule (includes matchScore + aiReasoning columns).

GET/api/profiles/stats
Auth Required

Profile Stats

Get aggregate statistics across all profiles.