get_stream
Get Stream
Retrieve detailed information about a specific event stream, including its dataset association, status, and event configuration.
get_stream
Retrieve detailed information about a specific event stream, including its dataset association, status, and event configuration.
get_target
Retrieve detailed information about a specific target, including its scope, connection, representation mode, and processing status.
list_recommenders
Retrieve all recommenders in your Faraday account. Recommenders create product or content recommendation models that suggest next-best-offer or first-best-offer for individuals.
delete_outcome
Permanently delete a prediction outcome. This cannot be undone and may affect dependent scopes.
list_persona_sets
Retrieve all persona sets in your Faraday account. Persona sets segment cohorts into AI-generated persona clusters, with each individual assigned to a persona along with trait breakdowns.
create_target
Create a new target to configure how predictions are exported. Supports three types: - **Lookup API**: Real-time API for retrieving predictions about individuals. Set options type to `lookup_api`. - **Replication**: Export to external connections (databases, warehouses, etc.). Requires a connection ID. - **Hosted CSV**: Faraday-hosted CSV download. Set options type to `hosted_csv`.
get_connection
Retrieve detailed information about a specific data connection, including its type, configuration, and status.
get_outcome
Retrieve detailed information about a specific outcome, including model performance metrics (ROC AUC, lift) and report URL.
list_targets
Retrieve all targets in your Faraday account. Targets define how and where predictions from a scope are delivered — via Lookup API, pipeline export, or CSV download.
list_outcomes
Retrieve all prediction outcomes in your Faraday account. Outcomes represent predictive objectives such as likelihood to convert, churn, or repurchase.
create_scope
Create a new scope to define a prediction deployment. A scope combines a target population (cohorts), optional exclusion cohorts, and a payload of predictions (outcomes, persona sets, recommenders, cohort memberships, traits) into a deployable unit.
list_connections
Retrieve all data connections in your Faraday account. Connections configure external data sources and export destinations including Snowflake, BigQuery, Redshift, Postgres, MySQL, S3, GCS, Shopify, Stripe, Salesforce, and many more.
create_outcome
Create a new predictive outcome. Define which cohort represents attainment (e.g., converted customers) and optionally an attrition cohort and eligible population. Faraday trains ML models using your data and its Identity Graph.
list_streams
Retrieve all event streams in your Faraday account. Streams represent typed sequences of customer actions (e.g., transactions, signups, cancellations) with timestamps and optional values, which feed into cohorts and predictions.
list_cohorts
Retrieve all cohorts in your Faraday account. Cohorts define populations of people based on event stream criteria (e.g., customers, leads, churned customers). Use this to discover available cohorts for building outcomes, scopes, or analysis.
create_persona_set
Create a new persona set to segment a cohort into AI-generated persona clusters. Each individual in the cohort will be assigned to a persona.
delete_connection
Permanently delete a data connection. This cannot be undone and may affect dependent datasets and targets.
delete_dataset
Permanently delete a dataset. This cannot be undone and may affect dependent streams and cohorts.
get_account
Retrieve information about the current Faraday account, including account name, status, and billing details.
create_cohort
Create a new cohort defining a population of people based on event stream criteria, traits, or place conditions. Cohorts serve as inputs for predictions and as population/exclusion filters in scopes.
list_traits
Retrieve all available traits including Faraday-provided traits (1,500+ consumer attributes from the Identity Graph) and custom traits derived from your data. Traits can be included in scope payloads for enrichment and used for cohort filtering.
get_scope
Retrieve detailed information about a specific scope, including its population configuration, payload, and processing status.
get_dataset
Retrieve detailed information about a specific dataset, including its connection, status, and identity mapping configuration.
list_datasets
Retrieve all datasets in your Faraday account. Datasets define how imported data maps to Faraday's identity model and event streams, and can be connected to external data sources or CSV uploads.
get_cohort
Retrieve detailed information about a specific cohort, including its population count, status, and configuration.
delete_cohort
Permanently delete a cohort from your Faraday account. This cannot be undone and may affect dependent resources like outcomes and scopes.
lookup_prediction
Perform a real-time lookup on a Lookup API target to retrieve predictions for an individual. Provide identity information (name, address, email, phone) and Faraday matches against its Identity Graph to return propensity scores, persona assignments, cohort membership, and enriched attributes. Provide as many identity fields as possible to maximize match accuracy. The target must be of type `lookup_api` and in `ready` status.
get_persona_set
Retrieve detailed information about a specific persona set, including its personas, trait breakdowns, and processing status.
get_dependency_graph
Retrieve the complete dependency graph of all resources in your account. Shows how datasets, streams, cohorts, outcomes, scopes, and targets relate to each other. Useful for understanding resource relationships and identifying dependencies before making changes.
list_scopes
Retrieve all scopes in your Faraday account. Scopes combine target populations, exclusion cohorts, and prediction payloads into deployable units that define what predictions are generated for whom.
update_cohort
Update an existing cohort's name, stream conditions, traits, or other filtering criteria.
get_recommender
Retrieve detailed information about a specific recommender, including its configuration, status, and bias mitigation settings.
Build and manage predictive AI pipelines for customer behavior. Ingest first-party data via CSV uploads or connections to external sources (Snowflake, BigQuery, Salesforce, Shopify, etc.). Define cohorts based on customer events, train propensity models (likelihood to convert, churn, repurchase), generate spend/LTV forecasts, and create AI-powered persona segments. Deploy predictions via real-time Lookup API, export to ad platforms (Facebook, Google Ads, LinkedIn, TikTok), databases, or CSV downloads. Build product recommenders, analyze market opportunities, enrich records with 1,500+ consumer attributes from Faraday's Identity Graph. Configure webhook notifications for resource status changes. Manage scopes to control what predictions are generated for which populations, with bias mitigation support.
Common questions about connecting Faraday to AI agents with Metorial.