# 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
- **Composio Managed App Available?** N/A
- **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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | The UUID of the cohort to archive. Archiving stops updates but keeps the cohort visible. Example: 'ac030f6a-a728-4fcd-b34a-d5b7ba09d60c' |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the cohort and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `connection_id` | string | Yes | The UUID of the connection to archive. Archiving stops updates but keeps the connection visible. Example: 'eca0b539-5002-49f0-ac5e-ff4acd1d85b1' |
| `cascade_to_all` | boolean | No | When true, archive the connection and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resources to be archived. If a downstream resource would be archived and is not in this list, throw an error. List of UUIDs. |
| `dataset_id` | string | Yes | The UUID of the dataset to archive. |
| `cascade_to_all` | boolean | No | When archiving a resource, if this is set to true, archive the resource and all its downstream resources. If false, and there are downstream resources that would be archived, throw an error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `outcome_id` | string | Yes | The UUID of the outcome to archive. Archiving stops updates but keeps the outcome visible. Example: 'd0e90b8d-f69d-420d-b191-8438421cdc8e' |
| `cascade_to_all` | boolean | No | When true, archive the outcome and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the persona set and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |
| `persona_set_id` | string | Yes | The UUID of the persona set to archive. Archiving stops updates but keeps the persona set visible. Example: '8505e525-128c-4ede-a279-85f372aa6aaf' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `place_id` | string | Yes | The UUID of the place to archive. Archiving stops updates but keeps the place visible. Example: 'a1eafa5c-020a-427f-ae18-2d0b3c0fced7' |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the place and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to archive. Archiving stops updates but keeps the scope visible. Example: 'fce4d114-9516-4e8c-a92e-e1ed13d5369d' |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the scope and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the stream and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |
| `stream_id_or_name` | string | Yes | The stream's UUID or name to archive. Example: 'b8907e67-dac8-4fc2-a332-7676f0077dd8' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | The UUID of the target to archive. Example: 'eb3450c4-f1d3-4edd-8d70-d1b4f7c16348' |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the target and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trait_id` | string | Yes | The UUID of the trait to archive. Archiving stops updates but keeps the trait visible. Example: '1b3411ea-0082-4873-bd3d-1f5c6586012e' |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, archive the trait and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the account. Must be non-empty and max 64 characters. |
| `branding` | object | No | Whitelabel branding configuration for the account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label for this cohort. Must be non-empty and max 64 characters. |
| `traits` | array | No | List of traits to filter cohort membership. At least one of stream_name, traits, or place_conditions must be provided. |
| `explore` | boolean | No | Whether to show the Cohort in Explore, the map view on https://app.faraday.ai. This will slow down Cohort builds. |
| `recency` | object | No | Recency condition for event-based filtering. |
| `max_count` | number | No | Maximum count for this cohort's config |
| `max_value` | number | No | Maximum value for this cohort's config |
| `min_count` | number | No | Minimum count for this cohort's config |
| `min_value` | number | No | Minimum value for this cohort's config |
| `stream_name` | string | No | The name field of the stream from which to build this cohort. At least one of stream_name, traits, or place_conditions must be provided. |
| `place_conditions` | array | No | List of places to use to spatially filter Cohort membership. At least one of stream_name, traits, or place_conditions must be provided. |
| `stream_conditions` | array | No | List of stream properties to filter cohort membership on. The stream properties must be for the same stream set as the cohort stream_name. Nulls are excluded unless explicitly requested with _null: true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Identifying name for the dataset |
| `options` | object | Yes | Dataset connection options specifying how to connect to and read the data. Must include type field. |
| `preview` | boolean | No | If true, dataset will only detect columns and produce preview without ingesting data. |
| `connection_id` | string | No | Connection identifier in UUID format. Required if using a connection-based dataset type. |
| `identity_sets` | object | Yes | Mapping of identity set names to objects describing personally identifiable information. Each key is a logical grouping name (e.g., 'customers', 'leads') and the value describes how to extract PII from dataset rows. |
| `upsert_columns` | array | No | Primary key columns that uniquely identify rows to prevent duplication. |
| `identity_providers` | array | No | Identity matching providers to use, in order of priority. |
| `incremental_column` | string | No | Name of a date column for efficient incremental data loading. |
| `reference_key_columns` | array | No | Column names that reference IDs from external systems. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label for this outcome. Each outcome must have a unique name. Must be non-empty. |
| `preview` | boolean | No | An outcome in preview mode will not build until preview is turned off. |
| `predictors` | object | No | Configuration for features used during modeling. |
| `bias_mitigation` | object | No | Bias mitigation configuration for age and gender dimensions. |
| `prediction_mode` | string ("auto" | "static") | No | Prediction mode for outcome modeling. |
| `feature_blocklist` | array | No | Field or category names that should not be considered for this outcome, primarily for Responsible AI purposes. |
| `eligible_cohort_id` | string | No | A cohort of people who could attain or attrite the desired outcome. If not specified, uses the US population. |
| `attrition_cohort_id` | string | No | A cohort of counterexamples - people who have clearly failed to attain the outcome. |
| `attainment_cohort_id` | string | Yes | A cohort of people who have attained the desired outcome (e.g., existing customers if predicting prospect to customer transition). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label for this persona set. Must be non-empty and max 64 characters. |
| `explore` | boolean | No | Display persona set in Explore map view at https://app.faraday.ai. This will slow down persona set builds. |
| `preview` | boolean | No | A persona set in preview mode will not build until preview is turned off. |
| `cohort_id` | string | Yes | The cohort for which to build personas. |
| `modeling_fields` | array | No | Customer attributes for modeling (e.g., fig/age, fig/gender). These fields define the characteristics used to segment the cohort into personas. |
| `number_of_clusters` | integer | No | Specific persona count. If omitted, the number of personas is automatically determined. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label for this place. Names must be unique. Uniqueness is case-insensitive. Must be non-empty and max 64 characters. |
| `geojson` | object | No | A GeoJSON Geometry, as defined in the GeoJSON specification. The longitude and latitude units are in decimal degrees, using the WGS84 coordinate reference system (SRID 4326). Either addresses or geojson must be provided. |
| `addresses` | array | No | List of addresses to be geocoded. Either addresses or geojson must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label for this scope. Each scope must have a unique name. |
| `payload` | object | Yes | Specifies data to include for each person in the scope. |
| `preview` | boolean | Yes | When true, provides limited output records without billing charges. A preview scope provides only a limited number of output records, but it is not billed. |
| `population` | object | Yes | Defines which people to include in the scope. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stream_name` | string | Yes | The name of the event stream to find or create. Maximum length is 64 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | The UUID of a target |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A user-friendly name for the target (max 64 characters) |
| `limit` | object | No | Row restriction configuration by count or percentile. |
| `filter` | object | No | Row-level filtering criteria for the target. |
| `options` | object | Yes | The export target configuration options varying by connection type |
| `scope_id` | string | Yes | The UUID of a scope for configuration |
| `connection_id` | string | No | For replication targets; omit for hosted targets |
| `human_readable` | boolean | No | When true, use literal names instead of machine-readable IDs in the output |
| `representation` | object | Yes | Specifies the output formatting mode (hashed, referenced, identified, or aggregated) |
| `analysis_config` | object | No | Configuration for geographic and trait analysis. |
| `custom_structure` | array | No | Column mapping transformations for custom output structure |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | How to refer to this Trait in other API calls to Faraday. Must start with a lowercase letter or underscore, followed by lowercase letters, numbers, or underscores. |
| `unit` | string | No | For numeric types, in what units is the data stored. |
| `literate` | string | No | A more human-consumable version of the name of this field. |
| `description` | string | No | Information about this field. |
| `lookup_table` | object | No | A mapping of the input values used in modeling, to how they should be displayed in reports. |
| `statistical_type` | string ("categorical" | "multicategorical" | "ordinal" | "nominal") | No | The nature of data represented by the trait. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The destination URL for webhook notifications. Must be a valid HTTPS URL. |
| `enabled_events` | array | Yes | Event types that trigger the webhook. Must contain at least one event type. Available events: 'resource.errored' (when a resource encounters an error) and 'resource.ready_with_update' (when a resource is ready with updates). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The UUID of the account to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | The UUID of the cohort to delete. This permanently deletes the cohort. Example: '856bc7b0-f4d4-433b-9e46-199970d7b78c' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Connection

**Slug:** `FARADAY_DELETE_CONNECTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connection_id` | string | Yes | The UUID of the connection to delete. This permanently removes the connection from Faraday. Ensure no active processes depend on this connection before deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset_id` | string | Yes | The UUID of the dataset to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Outcome

**Slug:** `FARADAY_DELETE_OUTCOME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outcome_id` | string | Yes | The UUID of the outcome to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `persona_set_id` | string | Yes | The UUID of the persona set to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `place_id` | string | Yes | The UUID of the place to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stream_id_or_name` | string | Yes | The stream's UUID or name to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Target

**Slug:** `FARADAY_DELETE_TARGET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | The UUID of the target to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | The name of an individual data file in a dataset to delete. Must include the file extension (e.g., '.csv', '.json'). Example: 'data_01.csv', 'orders_2024.csv' |
| `directory` | string | Yes | A directory of files which can be imported as a single dataset. This is the folder name where the file is stored. Example: 'abc_orders', 'customer_orders' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_endpoint_id` | string | Yes | The UUID of the webhook endpoint to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | The UUID of the cohort to force update. This triggers a rerun for the cohort. Example: 'ac030f6a-a728-4fcd-b34a-d5b7ba09d60c' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connection_id` | string | Yes | The UUID of the connection to trigger a rerun for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset_id` | string | Yes | The UUID of the dataset to force update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outcome_id` | string | Yes | The UUID of the outcome to force update (trigger a rerun). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `persona_set_id` | string | Yes | The UUID of the persona set to force update (trigger a rerun). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `place_id` | string | Yes | The UUID of the place to force update. This triggers a rerun for the place. Example: 'a1eafa5c-020a-427f-ae18-2d0b3c0fced7' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to force update (trigger a rerun). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stream_id_or_name` | string | Yes | The UUID or name of the stream to force update. This triggers a rerun for the stream. Example: 'b8907e67-dac8-4fc2-a332-7676f0077dd8' or 'orders' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | The UUID of the target to force update. This triggers a rerun for the target. Example: 'eb3450c4-f1d3-4edd-8d70-d1b4f7c16348' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trait_id` | string | Yes | The UUID of the trait to force update. This triggers a rerun for the trait. Example: '616aee5f-e544-43ff-a27e-5207248d4056' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The UUID of the account to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The UUID of an account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | The UUID of the cohort to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | The UUID of the cohort to analyze |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connection_id` | string | Yes | The UUID of the connection to retrieve datasets for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connection_id` | string | Yes | The UUID of a connection |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset_id` | string | Yes | The UUID of the dataset to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of records to return (pagination) |
| `offset` | integer | No | Number of records to skip for pagination |
| `dataset_id` | string | Yes | UUID of the dataset to retrieve ingress logs for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outcome_id` | string | Yes | The UUID of the outcome to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `persona_set_id` | string | Yes | The UUID of a persona set to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `persona_set_id` | string | Yes | The UUID of a persona set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `persona_set_id` | string | Yes | The UUID of the persona set to retrieve analysis dimensions for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `place_id` | string | Yes | The UUID of the place to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to get analysis for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve datasets for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve efficacy data for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve payload cohorts for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve payload outcomes for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve payload persona sets for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of a scope |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of a scope |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of a scope |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to retrieve targets for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stream_id_or_name` | string | Yes | The stream's UUID or name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stream_id_or_name` | string | Yes | The UUID of a stream or stream name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | The UUID of the target to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | The UUID of the target to retrieve analysis for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trait_id` | string | Yes | The UUID of the trait to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trait_id` | string | Yes | The UUID of the trait to retrieve analysis dimensions for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | The name of an individual data file in a dataset to download. Must include the file extension (e.g., '.csv', '.json'). Example: 'data_01.csv', 'sample.csv' |
| `directory` | string | Yes | A directory of files which can be imported as a single dataset. This is the folder name where the file is stored. Example: 'abc_orders', 'test-data' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_endpoint_id` | string | Yes | The UUID of a webhook endpoint |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scopes

**Slug:** `FARADAY_LIST_SCOPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | The UUID of the cohort to unarchive. Example: 'bc4eef1c-be49-4ca6-880f-a34479c7755d' |
| `cascade_to` | array | No | Only allow the following resources (by UUID) to be unarchived. If an upstream resource would be unarchived and is not in this list, throw an error. |
| `cascade_to_all` | boolean | No | When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resources to be archived/unarchived. If a downstream or upstream resource would be archived/unarchived, and is not in this list, throw an error. |
| `dataset_id` | string | Yes | The UUID of the dataset to unarchive. |
| `cascade_to_all` | boolean | No | When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resource UUIDs to be unarchived. If an upstream resource would be unarchived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `outcome_id` | string | Yes | The UUID of the outcome to unarchive. Unarchiving restores updates to the outcome. Example: '15be73ec-1525-4d5c-a96a-e644c93d00d8' |
| `cascade_to_all` | boolean | No | When true, unarchive the outcome and all its upstream resources. When false, throw an error if there are upstream resources that would be unarchived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resources (by UUID) to be unarchived. If an upstream resource would be unarchived and is not in this list, throw an error. |
| `cascade_to_all` | boolean | No | When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error. |
| `persona_set_id` | string | Yes | The UUID of the persona set to unarchive. Example: '8505e525-128c-4ede-a279-85f372aa6aaf' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `place_id` | string | Yes | The UUID of the place to unarchive. Example: 'a1eafa5c-020a-427f-ae18-2d0b3c0fced7' |
| `cascade_to` | array | No | Only allow the following resources (by UUID) to be unarchived. If an upstream resource would be unarchived and is not in this list, throw an error. |
| `cascade_to_all` | boolean | No | When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope_id` | string | Yes | The UUID of the scope to unarchive. Example: 'fce4d114-9516-4e8c-a92e-e1ed13d5369d' |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be unarchived. If an upstream resource would be unarchived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all. |
| `cascade_to_all` | boolean | No | When true, unarchive the scope and all its upstream resources. When false, throw an error if there are upstream resources that would be unarchived. Cannot be used together with cascade_to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade_to` | array | No | Only allow the following resources to be unarchived. If an upstream resource would be unarchived, and is not in this list, throw an error. |
| `cascade_to_all` | boolean | No | When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error. |
| `stream_id_or_name` | string | Yes | The UUID or name of the stream to unarchive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trait_id` | string | Yes | The UUID of the trait to unarchive |
| `cascade_to` | array | No | Only allow the following resource UUIDs to be unarchived. If an upstream resource would be unarchived, and is not in this list, throw an error. |
| `cascade_to_all` | boolean | No | When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the account. Must be non-empty and max 64 characters. |
| `branding` | object | No | Whitelabel branding configuration for the account |
| `account_id` | string | Yes | The UUID of the account to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label for this cohort. Must be non-empty and max 64 characters. |
| `traits` | array | No | List of traits to filter cohort membership. Set to null to clear. |
| `explore` | boolean | No | Whether to show the Cohort in Explore, the map view on https://app.faraday.ai. This will slow down Cohort builds. |
| `recency` | object | No | Recency condition for event-based filtering. |
| `cohort_id` | string | Yes | The UUID of the cohort to update |
| `max_count` | number | No | Max count for this cohort's config |
| `max_value` | number | No | Max value for this cohort's config |
| `min_count` | number | No | Min count for this cohort's config |
| `min_value` | number | No | Min value for this cohort's config |
| `stream_name` | string | No | The name field of the stream from which to build this cohort. Set to null to clear. |
| `place_conditions` | array | No | List of places to use to spatially filter Cohort membership. Set to null to clear. |
| `stream_conditions` | array | No | List of stream properties to filter cohort membership on. The stream properties must be for the same stream set as the cohort stream_name. Nulls are excluded unless explicitly requested with _null: true. Set to null to clear. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A user-friendly name of the connection. Max 64 characters, must be non-empty. |
| `options` | object | No | Connection-specific options that vary by connection type. |
| `connection_id` | string | Yes | The UUID of the connection to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | An identifying name for this dataset. |
| `options` | object | No | Dataset connection options. Must specify 'type' field for the connection type. |
| `preview` | boolean | No | A dataset in preview mode will only detect columns and produce a data preview, but not ingest the data. Set to null to clear. |
| `privacy` | string | No | Privacy settings: 'suppress' (data can be used for modeling but excluded from pipelines) or 'delete' (data cannot be used for modeling and excluded from pipelines). Set to null to clear. |
| `dataset_id` | string | Yes | The UUID of the dataset to update. |
| `identity_sets` | object | No | A mapping of identity set names to identity set objects. Describes all the logical groupings of personally-identifiable information present in the dataset. Set value to null to clear. |
| `upsert_columns` | array | No | Also known as the "primary key" of the dataset. A column or set of columns that uniquely identify an input row. Set to null to clear. |
| `output_to_traits` | object | No | A mapping of trait name to trait definition. Set to null to clear. |
| `output_to_streams` | object | No | Describes how to transform the dataset into one or more streams. Set to null to clear. |
| `identity_providers` | array | No | Which identity providers to use for matching, in order of priority. Set to null to clear. |
| `incremental_column` | string | No | A column specifying a date associated with a record. Set to null to clear. |
| `reference_key_column` | string | No | Deprecated: use reference_key_columns instead. The name of the column that references an ID from an external system. Set to null to clear. |
| `reference_key_columns` | array | No | The names of columns that reference IDs from an external system. Set to null to clear. |
| `output_to_streams_array` | array | No | An array-based approach to transforming datasets into streams. Each element specifies a stream_name and properties configuration. Set to null to clear. |
| `output_all_columns_as_traits` | object | No | If specified, all columns that are not excluded will be output as traits. Must include 'exclude' field with list of column names. Set to null to clear. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label for this outcome. Each outcome must have a unique name. Max 64 characters, must not be empty or only whitespace. |
| `preview` | boolean | No | An outcome in preview mode will not build until preview is turned off. Set to null to clear. |
| `outcome_id` | string | Yes | The UUID of the outcome to update. |
| `predictors` | object | No | Configuration for features used during modeling. |
| `bias_mitigation` | object | No | Bias mitigation configuration for age and gender dimensions. |
| `prediction_mode` | string ("auto" | "static") | No | Prediction mode for outcome modeling. |
| `feature_blocklist` | array | No | Field or category names that should not be considered for this outcome, primarily for Responsible AI purposes. Set to null to clear. |
| `eligible_cohort_id` | string | No | A cohort of people who could attain or attrite the desired outcome. If not specified, uses the US population. Set to null to clear. |
| `attrition_cohort_id` | string | No | A cohort of counterexamples - people who have clearly failed to attain the outcome. This cohort is optional. Set to null to clear. |
| `attainment_cohort_id` | string | No | A cohort of people who have attained the desired outcome (e.g., existing customers if predicting prospect to customer transition). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label for this persona set. Must be non-empty and max 64 characters. |
| `explore` | boolean | No | Whether to show the persona set in Explore, the map view on https://app.faraday.ai. This will slow down persona set builds. Set to null to clear this setting. |
| `preview` | boolean | No | A persona set in preview mode will not build until preview is turned off. Set to null to clear this setting. |
| `persona_set_id` | string | Yes | The UUID of the persona set to update |
| `number_of_clusters` | integer | No | Specify the exact number of clusters (i.e. personas) in the persona set. By default, the optimal value is determined automatically. Setting this requires external knowledge and should only be done when the use-case necessitates a specific number. Set to null to clear and use automatic determination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label for this place. Names must be unique. Uniqueness is case-insensitive. |
| `geojson` | object | No | A GeoJSON Geometry, as defined in the GeoJSON specification. The longitude and latitude units are in decimal degrees, using the WGS84 coordinate reference system (SRID 4326). Set to null to clear geojson. |
| `place_id` | string | Yes | The UUID of the place to update |
| `addresses` | array | No | List of addresses to be geocoded. Set to null to clear addresses, or provide a list to overwrite existing addresses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label for this scope. Each scope must have a unique name (max length: 64 characters, must be non-empty). |
| `payload` | object | No | The data to include for each person in this scope (for PATCH requests) |
| `preview` | boolean | No | A preview scope provides only a limited number of output records, but it is not billed. |
| `scope_id` | string | Yes | The UUID of the scope to update |
| `population` | object | No | The people to include in a scope (for PATCH requests) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tier` | string | No | A billing tier for the stream property. Set to null to clear this field. |
| `category` | string | No | A category describing the type of stream property. Set to null to clear this field. |
| `literate` | string | No | A human-readable name for the stream. Set to null to clear this field. |
| `deprecated` | boolean | No | Whether the stream is deprecated. Set to null to clear this field. |
| `properties` | object | No | Columns in your data that you want to associate with this event. The key is the name of the property, and the value is metadata about the property. Set to null to clear this field. |
| `description` | string | No | A description of the stream. Set to null to clear this field. |
| `deprecation_notes` | string | No | Notes about the deprecation of the stream. Set to null to clear this field. |
| `stream_id_or_name` | string | Yes | The stream's UUID or name to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A user-friendly name of the target (max length: 64 characters) |
| `limit` | object | No | Limit configuration for target rows |
| `filter` | object | No | Filter configuration for target rows |
| `options` | object | No | Target export configuration options |
| `target_id` | string | Yes | The UUID of the target to update |
| `payload_map` | object | No | Deprecated: use custom_structure. Explicit mapping of columns that should be included in the target export. Set to null to clear |
| `connection_id` | string | No | If this is a replication (externally-hosted) target, the UUID of a connection. Set to null to clear |
| `human_readable` | boolean | No | Whether to use human-readable column names instead of machine-readable format with underscored uuids. Set to null to clear |
| `representation` | object | No | Target representation configuration |
| `analysis_config` | object | No | Configuration for the analysis of the target |
| `custom_structure` | array | No | Custom structure transformations to override the default selection, order, and name of exported columns. Set to null to clear |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unit` | string | No | For numeric types, in what units is the data stored. Set to null to clear this value. |
| `literate` | string | No | A more human-consumable version of the name of this field. Set to null to clear this value. |
| `trait_id` | string | Yes | The UUID of the trait to update |
| `description` | string | No | Information about this field. Set to null to clear this value. |
| `lookup_table` | object | No | A mapping of the input values used in modeling, to how they should be displayed in reports. Set to null to clear this value. |
| `statistical_type` | string ("categorical" | "multicategorical" | "ordinal" | "nominal") | No | Statistical type describing the nature of data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | The URL of the webhook endpoint. |
| `status` | string ("enabled" | "disabled") | No | The status of the webhook endpoint. |
| `enabled_events` | array | No | The event types to enable for this endpoint. Available events: 'resource.errored' (when a resource encounters an error) and 'resource.ready_with_update' (when a resource is ready with updates). |
| `webhook_endpoint_id` | string | Yes | The UUID of the webhook endpoint to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |