# Faraday

Faraday lets you embed AI in workflows throughout your stack—to make your favorite tools perform even better

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Tools:** 117
- **Triggers:** 0
- **Slug:** `FARADAY`
- **Version:** 00000000_00

## Tools

### Archive Cohort

**Slug:** `FARADAY_ARCHIVE_COHORT`

Tool to archive a cohort in Faraday. Use when you need to stop updates to a cohort while keeping it visible.

### Archive Connection

**Slug:** `FARADAY_ARCHIVE_CONNECTION`

Tool to archive a connection in Faraday. Use when you need to stop updates to a connection while keeping it visible.

### Archive Dataset

**Slug:** `FARADAY_ARCHIVE_DATASET`

Tool to archive a dataset in Faraday. Use when you need to archive a dataset and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

### Archive Outcome

**Slug:** `FARADAY_ARCHIVE_OUTCOME`

Tool to archive an outcome in Faraday. Use when you need to stop updates to an outcome while keeping it visible.

### Archive Persona Set

**Slug:** `FARADAY_ARCHIVE_PERSONA_SET`

Tool to archive a persona set in Faraday. Use when you need to stop updates to a persona set while keeping it visible.

### Archive Place

**Slug:** `FARADAY_ARCHIVE_PLACE`

Tool to archive a place in Faraday. Use when you need to stop updates to a geospatial area or address set while keeping it visible.

### Archive Scope

**Slug:** `FARADAY_ARCHIVE_SCOPE`

Tool to archive a scope in Faraday. Use when you need to stop updates to a scope while keeping it visible.

### Archive Stream

**Slug:** `FARADAY_ARCHIVE_STREAM`

Tool to archive a stream in Faraday. Use when you need to archive a stream and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

### Archive Target

**Slug:** `FARADAY_ARCHIVE_TARGET`

Tool to archive a target in Faraday. Use when you need to archive a target and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

### Archive Trait

**Slug:** `FARADAY_ARCHIVE_TRAIT`

Tool to archive a trait in Faraday. Use when you need to stop updates to a trait while keeping it visible.

### Create Account

**Slug:** `FARADAY_CREATE_ACCOUNTS`

Tool to create a new Faraday account with specified name and branding. Use when you need to provision a new account in Faraday.

### Create Cohorts

**Slug:** `FARADAY_CREATE_COHORTS`

Tool to create a new cohort in Faraday. Cohorts are groups of people that share certain traits or behaviors. Use when you need to define a new cohort from your datasets or from Faraday's US Consumer Graph. At least one of stream_name, traits, or place_conditions must be provided.

### Create Dataset

**Slug:** `FARADAY_CREATE_DATASET`

Tool to create a new dataset in Faraday. Use when you need to define a new data source for analysis and predictions.

### Create Outcome

**Slug:** `FARADAY_CREATE_OUTCOME`

Tool to create a new outcome. Outcomes are predictions about customer behavior such as likelihood to convert, churn, or purchase specific products. Use when you need to create a new predictive model.

### Create Persona Set

**Slug:** `FARADAY_CREATE_PERSONA_SET`

Tool to create a new persona set. Persona sets segment cohorts into distinct customer personas based on shared characteristics and behaviors. Use when you need to generate customer personas for a cohort.

### Create Place

**Slug:** `FARADAY_CREATE_PLACE`

Tool to create a new place in Faraday. Places are geospatial areas or sets of addresses that can be used as spatial filters when defining other resources. Use when you need to define a new geographic area for analysis or targeting.

### Create Scope

**Slug:** `FARADAY_CREATE_SCOPES`

Tool to create a new scope in Faraday. Scopes define the population and payload for predictions, specifying which cohorts to target and what outcomes to include. Use when you need to define output data instructions for a new scope.

### Create Stream

**Slug:** `FARADAY_CREATE_STREAMS`

Tool to create a new stream or find an existing stream by name. Use when you need to initialize a stream for event data collection.

### Create Target Preview

**Slug:** `FARADAY_CREATE_TARGET_PREVIEW`

Tool to start a preview delivery for a target. Use when you need to initiate a preview of target data before full deployment.

### Create Target

**Slug:** `FARADAY_CREATE_TARGETS`

Tool to create a target in Faraday. Use when you need to set up a deployment that exports predictions and cohort data to external destinations like CRMs, ad platforms, or data warehouses.

### Create Trait

**Slug:** `FARADAY_CREATE_TRAIT`

Tool to create a new trait in Faraday. Use when you need to define a new fact about a person or geographic entity that can be used in modeling, analysis, and reporting.

### Create Webhook Endpoint

**Slug:** `FARADAY_CREATE_WEBHOOK_ENDPOINTS`

Tool to create a new webhook endpoint. Use when you need to register a webhook URL to receive notifications when resources are ready or encounter errors.

### Delete Account

**Slug:** `FARADAY_DELETE_ACCOUNT`

Tool to delete an account by its UUID. Use when you need to permanently remove an account from Faraday. The deletion is scheduled asynchronously and returns a 202 status on success.

### Delete All Orphaned Traits

**Slug:** `FARADAY_DELETE_ALL_ORPHANED_TRAITS`

Tool to delete all orphaned traits from Faraday. Use when you need to clean up traits that are not associated with any source dataset.

### Delete Cohort

**Slug:** `FARADAY_DELETE_COHORT`

Tool to permanently delete a cohort from Faraday. Use when you need to remove a cohort that is no longer needed.

### Delete Connection

**Slug:** `FARADAY_DELETE_CONNECTION`

Tool to delete a Faraday connection by its UUID. Use when you need to permanently remove a connection.

### Delete Dataset

**Slug:** `FARADAY_DELETE_DATASET`

Tool to delete a dataset from Faraday. Use when you need to remove a dataset permanently. The operation returns success when the dataset is successfully deleted.

### Delete Outcome

**Slug:** `FARADAY_DELETE_OUTCOME`

Tool to delete an outcome by its UUID. Use when you need to remove an outcome from Faraday.

### Delete Persona Set

**Slug:** `FARADAY_DELETE_PERSONA_SET`

Tool to delete a persona set. Use when you need to permanently remove a persona set from Faraday. Returns success status and HTTP code 204 on successful deletion.

### Delete Place

**Slug:** `FARADAY_DELETE_PLACE`

Tool to delete a place by its UUID. Use when you need to remove a place from the system.

### Delete Scope

**Slug:** `FARADAY_DELETE_SCOPE`

Tool to delete a scope by its UUID. Use when you need to permanently remove a scope from the system. Returns 204 status code on successful deletion.

### Delete Stream

**Slug:** `FARADAY_DELETE_STREAM`

Tool to delete a stream by its UUID or name. Use when you need to remove a stream that is no longer needed.

### Delete Target

**Slug:** `FARADAY_DELETE_TARGET`

Tool to delete a target by its UUID. Use when you need to remove a target from Faraday.

### Delete Upload

**Slug:** `FARADAY_DELETE_UPLOAD`

Permanently deletes a file from a Faraday dataset directory. Use this when you need to remove an uploaded file from a specific directory. This is a destructive operation that cannot be undone - the file will be permanently removed from the specified directory.

### Delete Webhook Endpoint

**Slug:** `FARADAY_DELETE_WEBHOOK_ENDPOINT`

Tool to delete a webhook endpoint by its UUID. Use when you need to remove a webhook endpoint from Faraday. The operation returns 204 No Content on success.

### Force Update Cohort

**Slug:** `FARADAY_FORCE_UPDATE_COHORT`

Tool to trigger a rerun for a cohort. Use when you need to force rebuild a cohort's data.

### Force Update Connection

**Slug:** `FARADAY_FORCE_UPDATE_CONNECTION`

Tool to trigger a rerun for a Faraday connection. Use when you need to force refresh connection data.

### Force Update Dataset

**Slug:** `FARADAY_FORCE_UPDATE_DATASET`

Tool to trigger a rerun for a dataset. Use when you need to force a dataset to update immediately rather than waiting for its normal schedule.

### Force Update Outcome

**Slug:** `FARADAY_FORCE_UPDATE_OUTCOME`

Tool to trigger a rerun for an outcome resource. Use when you need to force rebuild an outcome, causing it to reprocess and update its predictions.

### Force Update Persona Set

**Slug:** `FARADAY_FORCE_UPDATE_PERSONA_SET`

Tool to trigger a rerun for a persona set resource. Use when you need to force rebuild a persona set, causing it to reprocess and update its personas.

### Force Update Place

**Slug:** `FARADAY_FORCE_UPDATE_PLACE`

Tool to trigger a rerun for a place. Use when you need to force rebuild a place's data.

### Force Update Scope

**Slug:** `FARADAY_FORCE_UPDATE_SCOPE`

Tool to trigger a rerun for a scope resource. Use when you need to force rebuild a scope, causing it to reprocess and update its data.

### Force Update Stream

**Slug:** `FARADAY_FORCE_UPDATE_STREAM`

Tool to trigger a rerun for a stream. Use when you need to force rebuild a stream's data.

### Force Update Target

**Slug:** `FARADAY_FORCE_UPDATE_TARGET`

Tool to trigger a rerun for a target. Use when you need to force rebuild a target's data.

### Force Update Trait

**Slug:** `FARADAY_FORCE_UPDATE_TRAIT`

Tool to trigger a rerun for a trait. Use when you need to force rebuild a trait's data.

### Get Account

**Slug:** `FARADAY_GET_ACCOUNT`

Tool to retrieve detailed information about a Faraday account by its UUID. Use when you need to fetch account details, status, branding, or billing information.

### List Accounts

**Slug:** `FARADAY_GET_ACCOUNTS`

Tool to list all Faraday accounts accessible by the current user. Use when you need to retrieve account information, check account status, or get account IDs for other operations.

### Get Accounts Billing

**Slug:** `FARADAY_GET_ACCOUNTS_BILLING`

Tool to get billing information about your account. Use when you need to retrieve invoices, payments, or usage information for a specific account.

### Get Cohort

**Slug:** `FARADAY_GET_COHORT`

Tool to retrieve a specific cohort by ID. Use when you need to fetch details about a specific cohort.

### Get Cohort Membership Analysis

**Slug:** `FARADAY_GET_COHORT_ANALYSIS_MEMBERSHIP`

Tool to get cohort membership counts over time for a specific cohort. Use when you need to analyze how cohort membership has changed over days, weeks, and months.

### List Cohorts

**Slug:** `FARADAY_GET_COHORTS`

Tool to list all cohorts in your Faraday account. Use when you need to retrieve the list of customer groups or segments.

### Get Connection Datasets

**Slug:** `FARADAY_GET_CONNECTION_DATASETS`

Tool to retrieve all datasets that use a specific connection. Use when you need to list datasets associated with a connection ID.

### Get Connection Targets

**Slug:** `FARADAY_GET_CONNECTIONS_TARGETS`

Tool to retrieve all targets that use a specific connection. Use when you need to get a list of all targets associated with a connection ID.

### Get Current Account

**Slug:** `FARADAY_GET_CURRENT_ACCOUNT`

Tool to retrieve the current account information. Use when you need to get details about the authenticated account, including account ID, name, status, and billing information.

### Get Current Account Billing

**Slug:** `FARADAY_GET_CURRENT_ACCOUNT_BILLING`

Tool to retrieve billing information about the current account. Use when you need to check invoices, payments, or usage limits for the authenticated Faraday account.

### Get Dataset

**Slug:** `FARADAY_GET_DATASET`

Tool to retrieve a dataset by its UUID. Use when you need to get details about a specific dataset including its configuration, columns, status, and metadata.

### Get Dataset Ingress Logs

**Slug:** `FARADAY_GET_DATASETS_LOGS_INGRESS`

Tool to retrieve dataset ingress metrics over time. Use when you need to monitor or analyze data ingestion history, track row counts, or review ingress operation status for a specific dataset.

### List Feature Stores

**Slug:** `FARADAY_GET_FEATURE_STORES`

Tool to list all feature stores. Use when you need to retrieve feature stores from your Faraday account.

### Get Dependency Graph

**Slug:** `FARADAY_GET_GRAPH`

Tool to retrieve the complete dependency graph for all resources on an account. Shows relationships between datasets, cohorts, outcomes, targets, connections, and other resources.

### Get Market Opportunity Analyses

**Slug:** `FARADAY_GET_MARKET_OPPORTUNITY_ANALYSES`

Tool to retrieve all market opportunity analyses from Faraday. Use when you need to view penetration and opportunity metrics in your market.

### Get Outcome

**Slug:** `FARADAY_GET_OUTCOME`

Tool to retrieve an outcome by its ID. Use when you need to get details about a specific outcome including its configuration, cohorts, status, and performance metrics.

### List Outcomes

**Slug:** `FARADAY_GET_OUTCOMES`

Tool to list all outcomes for the account. Use when you need to retrieve configured business objectives and their modeling status. Returns complete list without pagination.

### Get Persona Set

**Slug:** `FARADAY_GET_PERSONA_SET`

Tool to retrieve a persona set by its UUID. Use when you need to access details about a specific customer persona set including its status, configuration, and constituent personas.

### Get Persona Set Analysis Flow

**Slug:** `FARADAY_GET_PERSONA_SET_ANALYSIS_FLOW`

Tool to retrieve the flow of persona sets over time, showing how individuals move between different personas. Use when you need to analyze trends in persona membership or understand how your audience segments are evolving over time.

### List Persona Sets

**Slug:** `FARADAY_GET_PERSONA_SETS`

Tool to list all persona sets. Use when you need to retrieve customer persona sets for analysis or selection.

### Get Persona Set Analysis Dimensions

**Slug:** `FARADAY_GET_PERSONA_SETS_ANALYSIS_DIMENSIONS`

Tool to get various trait breakdown information about a persona set. Use when you need to analyze the characteristics and distributions of personas within a set.

### Get Place

**Slug:** `FARADAY_GET_PLACE`

Tool to retrieve a specific place by its UUID. Use when you need to get details about a geospatial area or address set that can be used as a spatial filter.

### List Places

**Slug:** `FARADAY_GET_PLACES`

Tool to list all places in Faraday. Use when you need to retrieve geospatial areas or address sets that can be used as spatial filters. Returns all place resources with their status and configuration.

### List Recommenders

**Slug:** `FARADAY_GET_RECOMMENDERS`

Tool to list all recommenders. Use when you need to retrieve recommender resources that predict future associations based on event streams.

### Get Scope

**Slug:** `FARADAY_GET_SCOPE`

Tool to retrieve detailed information about a Faraday scope by its UUID. Use when you need to fetch scope configuration, population settings, payload details, or status information.

### Get Scope Analysis

**Slug:** `FARADAY_GET_SCOPE_ANALYSIS`

Tool to get analysis for a scope including outcomes and recommenders with probability distributions. Use when you need to analyze scope performance and understand prediction distributions.

### Get Scope Datasets

**Slug:** `FARADAY_GET_SCOPE_DATASETS`

Tool to retrieve all datasets associated with a Faraday scope. Use when you need to list or view all datasets that are connected to a specific scope.

### Get Scope Efficacy

**Slug:** `FARADAY_GET_SCOPE_EFFICACY`

Tool to retrieve efficacy metrics for a scope. Returns model performance metrics and accuracy measurements showing how well predictions performed over time.

### Get Scope Payload Cohorts

**Slug:** `FARADAY_GET_SCOPE_PAYLOAD_COHORTS`

Tool to get payload cohorts for a specific scope. Use when you need to retrieve the list of cohorts included in a scope's payload configuration.

### Get Scope Payload Outcomes

**Slug:** `FARADAY_GET_SCOPE_PAYLOAD_OUTCOMES`

Tool to retrieve payload outcomes for a specific scope. Use when you need to fetch the outcome predictions included in a scope's data payload.

### Get Scope Payload Persona Sets

**Slug:** `FARADAY_GET_SCOPE_PAYLOAD_PERSONA_SETS`

Tool to get payload persona sets for a specific scope. Use when you need to retrieve the list of persona sets included in a scope's payload configuration.

### Get Scope Payload Recommenders

**Slug:** `FARADAY_GET_SCOPE_PAYLOAD_RECOMMENDERS`

Tool to retrieve payload recommenders for a specific scope. Use when you need to fetch recommender resources associated with a scope's payload configuration.

### Get Scope Population Exclusion Cohorts

**Slug:** `FARADAY_GET_SCOPE_POPULATION_EXCLUSION_COHORTS`

Tool to get population exclusion cohorts for a scope. Use when you need to retrieve the cohorts that are excluded from a specific scope's population.

### Get Scope Population Cohorts

**Slug:** `FARADAY_GET_SCOPES_POPULATION_COHORTS`

Tool to get population cohorts for a specific scope. Use when you need to retrieve the list of cohorts associated with a scope's population.

### Get Scope Targets

**Slug:** `FARADAY_GET_SCOPE_TARGETS`

Tool to get all targets for a specific scope. Use when you need to retrieve export configurations and target details for a scope.

### Get Stream

**Slug:** `FARADAY_GET_STREAM`

Tool to retrieve a stream by its UUID or name. Use when you need to fetch stream details including properties, event counts, and metadata.

### List Streams

**Slug:** `FARADAY_GET_STREAMS`

Tool to list all streams in your Faraday account. Use when you need to retrieve event streams associated with the account.

### Get Streams Analysis

**Slug:** `FARADAY_GET_STREAMS_ANALYSIS`

Tool to get the count of stream events emitted over a time period. Use when you need to analyze stream activity patterns and event volume trends.

### Get Target

**Slug:** `FARADAY_GET_TARGET`

Tool to retrieve a specific target by its UUID from Faraday. Use when you need to fetch details about a target including its configuration, status, and export settings.

### Get Target Analysis

**Slug:** `FARADAY_GET_TARGETS_ANALYSIS`

Tool to retrieve a target's analysis including geographic distributions and trait breakdowns. Use when you need to understand the composition and characteristics of individuals within a specific target.

### Get Trait

**Slug:** `FARADAY_GET_TRAIT`

Tool to retrieve a specific trait by ID. Use when you need to get detailed information about a trait including its type, category, statistical properties, and configuration.

### Get Trait Analysis Dimensions

**Slug:** `FARADAY_GET_TRAITS_ANALYSIS_DIMENSIONS`

Tool to retrieve the percentage of the US population that falls into each category of a trait. Use when you need to analyze the distribution of a specific trait across the population.

### Get Traits CSV

**Slug:** `FARADAY_GET_TRAITS_CSV`

Tool to retrieve all user-defined and Faraday-provided traits in CSV format. Use when you need to export or analyze trait data in a spreadsheet-compatible format.

### Get Upload

**Slug:** `FARADAY_GET_UPLOAD`

Tool to download a previously uploaded file from a Faraday dataset directory. Use when you need to retrieve the contents of a specific file.

### List Uploaded Files

**Slug:** `FARADAY_GET_UPLOADS`

Tool to retrieve the list of previously uploaded files in Faraday. Use when you need to see uploaded datasets or verify file uploads.

### Get Usages

**Slug:** `FARADAY_GET_USAGES`

Tool to retrieve usage statistics for your Faraday account. Use when you need to check current usage and limits for various account features.

### Get Webhook Endpoint

**Slug:** `FARADAY_GET_WEBHOOK_ENDPOINT`

Tool to retrieve a webhook endpoint by its UUID. Use when you need to access details about a specific webhook endpoint including its URL, status, enabled events, and signing secret.

### List Webhook Endpoints

**Slug:** `FARADAY_GET_WEBHOOK_ENDPOINTS`

Tool to list all webhook endpoints configured for the account. Use when you need to retrieve webhook endpoint information including URLs, status, and enabled events.

### List Attributes

**Slug:** `FARADAY_LIST_ATTRIBUTES`

Tool to list all attributes in the feature store. Use when you need to retrieve the catalog of available attributes for data analysis or feature engineering.

### List Connections

**Slug:** `FARADAY_LIST_CONNECTIONS`

Tool to list all connections configured in Faraday. Use when you need to view available data connections between Faraday and external locations.

### List Scopes

**Slug:** `FARADAY_LIST_SCOPES`

Tool to list all scopes. Use when you need to retrieve scope configurations for viewing output data instructions.

### List Targets

**Slug:** `FARADAY_LIST_TARGETS`

Tool to list all targets in your Faraday account. Use when you need to view export configurations for predictions.

### Unarchive Cohort

**Slug:** `FARADAY_UNARCHIVE_COHORT`

Tool to unarchive a previously archived cohort. Use when you need to restore an archived cohort and optionally its upstream resources.

### Unarchive Dataset

**Slug:** `FARADAY_UNARCHIVE_DATASETS`

Tool to unarchive a dataset in Faraday. Use when you need to restore an archived dataset for active use. Optionally cascades to upstream resources.

### Unarchive Outcome

**Slug:** `FARADAY_UNARCHIVE_OUTCOME`

Tool to unarchive an outcome in Faraday. Use when you need to restore updates to a previously archived outcome.

### Unarchive Persona Set

**Slug:** `FARADAY_UNARCHIVE_PERSONA_SETS`

Tool to unarchive a previously archived persona set. Use when you need to restore an archived persona set and optionally its upstream resources.

### Unarchive Place

**Slug:** `FARADAY_UNARCHIVE_PLACES`

Tool to unarchive a previously archived place. Use when you need to restore an archived place and optionally its upstream resources.

### Unarchive Scope

**Slug:** `FARADAY_UNARCHIVE_SCOPE`

Tool to unarchive a previously archived scope. Use when you need to restore an archived scope and optionally its upstream resources.

### Unarchive Stream

**Slug:** `FARADAY_UNARCHIVE_STREAM`

Tool to unarchive a stream in Faraday. Use when you need to restore an archived stream for active use. Optionally cascades to upstream resources.

### Unarchive Trait

**Slug:** `FARADAY_UNARCHIVE_TRAIT`

Tool to unarchive a trait. Use when you need to restore an archived trait and optionally its upstream resources.

### Update Account

**Slug:** `FARADAY_UPDATE_ACCOUNT`

Tool to update an account's name or branding settings. Use when you need to modify account properties using JSON Merge Patch semantics.

### Update Cohort

**Slug:** `FARADAY_UPDATE_COHORT`

Tool to update a cohort's configuration using JSON Merge Patch semantics. Use when you need to modify cohort properties like name, filters, or conditions.

### Update Connection

**Slug:** `FARADAY_UPDATE_CONNECTION`

Tool to update a Faraday connection's name or options. Use when you need to modify connection properties using JSON Merge Patch semantics.

### Update Dataset

**Slug:** `FARADAY_UPDATE_DATASET`

Tool to update a dataset configuration using JSON Merge Patch semantics. Use when you need to modify dataset properties like name, identity sets, output configurations, or privacy settings.

### Update Outcome

**Slug:** `FARADAY_UPDATE_OUTCOME`

Tool to update an outcome's configuration using JSON Merge Patch semantics. Use when you need to modify outcome properties such as name, cohorts, bias mitigation, feature blocklist, prediction mode, predictors, or preview status.

### Update Persona Set

**Slug:** `FARADAY_UPDATE_PERSONA_SET`

Tool to edit a persona set's configuration using JSON Merge Patch. Use when you need to update persona set properties like name, explore visibility, number of clusters, or preview mode.

### Update Place

**Slug:** `FARADAY_UPDATE_PLACE`

Tool to update a place's name, addresses, or geojson geometry. Use when you need to modify place properties using JSON Merge Patch semantics.

### Update Scope

**Slug:** `FARADAY_UPDATE_SCOPE`

Tool to update a Faraday scope's configuration using JSON Merge Patch semantics. Use when you need to modify scope properties such as name, payload settings, population cohorts, or preview status.

### Update Stream

**Slug:** `FARADAY_UPDATE_STREAM`

Tool to update a stream's properties using JSON Merge Patch semantics. Use when you need to modify stream metadata like description, category, or deprecation status.

### Update Target

**Slug:** `FARADAY_UPDATE_TARGET`

Tool to update a target's configuration in Faraday. Use when you need to modify target properties using JSON Merge Patch semantics.

### Update Trait

**Slug:** `FARADAY_UPDATE_TRAIT`

Tool to update a trait's properties using JSON Merge Patch semantics. Use when you need to modify trait metadata like description, literate name, lookup table, statistical type, or unit.

### Update Webhook Endpoint

**Slug:** `FARADAY_UPDATE_WEBHOOK_ENDPOINTS`

Tool to update a webhook endpoint's configuration. Use when you need to modify the status, URL, or enabled events for an existing webhook endpoint.
