Faraday

faraday

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

Artificial Intelligence Web del proveedor

Acciones

117

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (117)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Archive CohortFARADAY_ARCHIVE_COHORTAcción

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

Parámetros de entrada

cohort_idstringObligatorio
The UUID of the cohort to archive. Archiving stops updates but keeps the cohort visible. Example: 'ac030f6a-a728-4fcd-b34a-d5b7ba09d60c'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive ConnectionFARADAY_ARCHIVE_CONNECTIONAcción

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

Parámetros de entrada

cascade_tostring[]
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_idstringObligatorio
The UUID of the connection to archive. Archiving stops updates but keeps the connection visible. Example: 'eca0b539-5002-49f0-ac5e-ff4acd1d85b1'
cascade_to_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive DatasetFARADAY_ARCHIVE_DATASETAcción

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.

Parámetros de entrada

cascade_tostring[]
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_idstringObligatorio
The UUID of the dataset to archive.
cascade_to_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive OutcomeFARADAY_ARCHIVE_OUTCOMEAcción

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

Parámetros de entrada

cascade_tostring[]
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_idstringObligatorio
The UUID of the outcome to archive. Archiving stops updates but keeps the outcome visible. Example: 'd0e90b8d-f69d-420d-b191-8438421cdc8e'
cascade_to_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Persona SetFARADAY_ARCHIVE_PERSONA_SETAcción

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

Parámetros de entrada

cascade_tostring[]
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_allboolean
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_idstringObligatorio
The UUID of the persona set to archive. Archiving stops updates but keeps the persona set visible. Example: '8505e525-128c-4ede-a279-85f372aa6aaf'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive PlaceFARADAY_ARCHIVE_PLACEAcción

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.

Parámetros de entrada

place_idstringObligatorio
The UUID of the place to archive. Archiving stops updates but keeps the place visible. Example: 'a1eafa5c-020a-427f-ae18-2d0b3c0fced7'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive ScopeFARADAY_ARCHIVE_SCOPEAcción

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

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to archive. Archiving stops updates but keeps the scope visible. Example: 'fce4d114-9516-4e8c-a92e-e1ed13d5369d'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive StreamFARADAY_ARCHIVE_STREAMAcción

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.

Parámetros de entrada

cascade_tostring[]
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_allboolean
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_namestringObligatorio
The stream's UUID or name to archive. Example: 'b8907e67-dac8-4fc2-a332-7676f0077dd8'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive TargetFARADAY_ARCHIVE_TARGETAcción

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.

Parámetros de entrada

target_idstringObligatorio
The UUID of the target to archive. Example: 'eb3450c4-f1d3-4edd-8d70-d1b4f7c16348'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive TraitFARADAY_ARCHIVE_TRAITAcción

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

Parámetros de entrada

trait_idstringObligatorio
The UUID of the trait to archive. Archiving stops updates but keeps the trait visible. Example: '1b3411ea-0082-4873-bd3d-1f5c6586012e'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create AccountFARADAY_CREATE_ACCOUNTSAcción

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

Parámetros de entrada

namestringObligatorio
The name of the account. Must be non-empty and max 64 characters.
brandingobject
Whitelabel branding configuration for the account

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CohortsFARADAY_CREATE_COHORTSAcción

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.

Parámetros de entrada

namestringObligatorio
Human-readable label for this cohort. Must be non-empty and max 64 characters.
traitsobject[]
List of traits to filter cohort membership. At least one of stream_name, traits, or place_conditions must be provided.
exploreboolean
Whether to show the Cohort in Explore, the map view on https://app.faraday.ai. This will slow down Cohort builds.
recencyobject
Recency condition for event-based filtering.
max_countnumber
Maximum count for this cohort's config
max_valuenumber
Maximum value for this cohort's config
min_countnumber
Minimum count for this cohort's config
min_valuenumber
Minimum value for this cohort's config
stream_namestring
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_conditionsobject[]
List of places to use to spatially filter Cohort membership. At least one of stream_name, traits, or place_conditions must be provided.
stream_conditionsobject[]
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DatasetFARADAY_CREATE_DATASETAcción

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

Parámetros de entrada

namestringObligatorio
Identifying name for the dataset
optionsobjectObligatorio
Dataset connection options specifying how to connect to and read the data. Must include type field.
previewboolean
If true, dataset will only detect columns and produce preview without ingesting data.
connection_idstring
Connection identifier in UUID format. Required if using a connection-based dataset type.
identity_setsobjectObligatorio
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_columnsstring[]
Primary key columns that uniquely identify rows to prevent duplication.
identity_providersobject[]
Identity matching providers to use, in order of priority.
incremental_columnstring
Name of a date column for efficient incremental data loading.
reference_key_columnsstring[]
Column names that reference IDs from external systems.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create OutcomeFARADAY_CREATE_OUTCOMEAcción

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.

Parámetros de entrada

namestringObligatorio
Human-readable label for this outcome. Each outcome must have a unique name. Must be non-empty.
previewboolean
An outcome in preview mode will not build until preview is turned off.
predictorsobject
Configuration for features used during modeling.
bias_mitigationobject
Bias mitigation configuration for age and gender dimensions.
prediction_modestringenum
Prediction mode for outcome modeling.
autostatic
feature_blockliststring[]
Field or category names that should not be considered for this outcome, primarily for Responsible AI purposes.
eligible_cohort_idstring
A cohort of people who could attain or attrite the desired outcome. If not specified, uses the US population.
attrition_cohort_idstring
A cohort of counterexamples - people who have clearly failed to attain the outcome.
attainment_cohort_idstringObligatorio
A cohort of people who have attained the desired outcome (e.g., existing customers if predicting prospect to customer transition).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Persona SetFARADAY_CREATE_PERSONA_SETAcción

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.

Parámetros de entrada

namestringObligatorio
Human-readable label for this persona set. Must be non-empty and max 64 characters.
exploreboolean
Display persona set in Explore map view at https://app.faraday.ai. This will slow down persona set builds.
previewboolean
A persona set in preview mode will not build until preview is turned off.
cohort_idstringObligatorio
The cohort for which to build personas.
modeling_fieldsstring[]
Customer attributes for modeling (e.g., fig/age, fig/gender). These fields define the characteristics used to segment the cohort into personas.
number_of_clustersinteger
Specific persona count. If omitted, the number of personas is automatically determined.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create PlaceFARADAY_CREATE_PLACEAcción

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.

Parámetros de entrada

namestringObligatorio
Human-readable label for this place. Names must be unique. Uniqueness is case-insensitive. Must be non-empty and max 64 characters.
geojsonobject
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.
addressesobject[]
List of addresses to be geocoded. Either addresses or geojson must be provided.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ScopeFARADAY_CREATE_SCOPESAcción

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.

Parámetros de entrada

namestringObligatorio
Human-readable label for this scope. Each scope must have a unique name.
payloadobjectObligatorio
Specifies data to include for each person in the scope.
previewbooleanObligatorio
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.
populationobjectObligatorio
Defines which people to include in the scope.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create StreamFARADAY_CREATE_STREAMSAcción

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.

Parámetros de entrada

stream_namestringObligatorio
The name of the event stream to find or create. Maximum length is 64 characters.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Target PreviewFARADAY_CREATE_TARGET_PREVIEWAcción

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

Parámetros de entrada

target_idstringObligatorio
The UUID of a target

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TargetFARADAY_CREATE_TARGETSAcción

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.

Parámetros de entrada

namestringObligatorio
A user-friendly name for the target (max 64 characters)
limitobject
Row restriction configuration by count or percentile.
filterobject
Row-level filtering criteria for the target.
optionsobjectObligatorio
The export target configuration options varying by connection type
scope_idstringObligatorio
The UUID of a scope for configuration
connection_idstring
For replication targets; omit for hosted targets
human_readableboolean
When true, use literal names instead of machine-readable IDs in the output
representationobjectObligatorio
Specifies the output formatting mode (hashed, referenced, identified, or aggregated)
analysis_configobject
Configuration for geographic and trait analysis.
custom_structureobject[]
Column mapping transformations for custom output structure

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TraitFARADAY_CREATE_TRAITAcción

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.

Parámetros de entrada

namestringObligatorio
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.
unitstring
For numeric types, in what units is the data stored.
literatestring
A more human-consumable version of the name of this field.
descriptionstring
Information about this field.
lookup_tableobject
A mapping of the input values used in modeling, to how they should be displayed in reports.
statistical_typestringenum
The nature of data represented by the trait.
categoricalmulticategoricalordinalnominal

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Webhook EndpointFARADAY_CREATE_WEBHOOK_ENDPOINTSAcción

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.

Parámetros de entrada

urlstringObligatorio
The destination URL for webhook notifications. Must be a valid HTTPS URL.
enabled_eventsstring[]Obligatorio
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).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete AccountFARADAY_DELETE_ACCOUNTAcción

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.

Parámetros de entrada

account_idstringObligatorio
The UUID of the account to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete All Orphaned TraitsFARADAY_DELETE_ALL_ORPHANED_TRAITSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CohortFARADAY_DELETE_COHORTAcción

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

Parámetros de entrada

cohort_idstringObligatorio
The UUID of the cohort to delete. This permanently deletes the cohort. Example: '856bc7b0-f4d4-433b-9e46-199970d7b78c'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ConnectionFARADAY_DELETE_CONNECTIONAcción

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

Parámetros de entrada

connection_idstringObligatorio
The UUID of the connection to delete. This permanently removes the connection from Faraday. Ensure no active processes depend on this connection before deletion.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DatasetFARADAY_DELETE_DATASETAcción

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.

Parámetros de entrada

dataset_idstringObligatorio
The UUID of the dataset to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete OutcomeFARADAY_DELETE_OUTCOMEAcción

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

Parámetros de entrada

outcome_idstringObligatorio
The UUID of the outcome to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Persona SetFARADAY_DELETE_PERSONA_SETAcción

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.

Parámetros de entrada

persona_set_idstringObligatorio
The UUID of the persona set to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete PlaceFARADAY_DELETE_PLACEAcción

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

Parámetros de entrada

place_idstringObligatorio
The UUID of the place to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ScopeFARADAY_DELETE_SCOPEAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete StreamFARADAY_DELETE_STREAMAcción

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

Parámetros de entrada

stream_id_or_namestringObligatorio
The stream's UUID or name to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TargetFARADAY_DELETE_TARGETAcción

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

Parámetros de entrada

target_idstringObligatorio
The UUID of the target to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete UploadFARADAY_DELETE_UPLOADAcción

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.

Parámetros de entrada

filenamestringObligatorio
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'
directorystringObligatorio
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'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Webhook EndpointFARADAY_DELETE_WEBHOOK_ENDPOINTAcción

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.

Parámetros de entrada

webhook_endpoint_idstringObligatorio
The UUID of the webhook endpoint to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update CohortFARADAY_FORCE_UPDATE_COHORTAcción

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

Parámetros de entrada

cohort_idstringObligatorio
The UUID of the cohort to force update. This triggers a rerun for the cohort. Example: 'ac030f6a-a728-4fcd-b34a-d5b7ba09d60c'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update ConnectionFARADAY_FORCE_UPDATE_CONNECTIONAcción

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

Parámetros de entrada

connection_idstringObligatorio
The UUID of the connection to trigger a rerun for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update DatasetFARADAY_FORCE_UPDATE_DATASETAcción

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.

Parámetros de entrada

dataset_idstringObligatorio
The UUID of the dataset to force update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update OutcomeFARADAY_FORCE_UPDATE_OUTCOMEAcción

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.

Parámetros de entrada

outcome_idstringObligatorio
The UUID of the outcome to force update (trigger a rerun).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update Persona SetFARADAY_FORCE_UPDATE_PERSONA_SETAcción

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.

Parámetros de entrada

persona_set_idstringObligatorio
The UUID of the persona set to force update (trigger a rerun).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update PlaceFARADAY_FORCE_UPDATE_PLACEAcción

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

Parámetros de entrada

place_idstringObligatorio
The UUID of the place to force update. This triggers a rerun for the place. Example: 'a1eafa5c-020a-427f-ae18-2d0b3c0fced7'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update ScopeFARADAY_FORCE_UPDATE_SCOPEAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to force update (trigger a rerun).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update StreamFARADAY_FORCE_UPDATE_STREAMAcción

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

Parámetros de entrada

stream_id_or_namestringObligatorio
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'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update TargetFARADAY_FORCE_UPDATE_TARGETAcción

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

Parámetros de entrada

target_idstringObligatorio
The UUID of the target to force update. This triggers a rerun for the target. Example: 'eb3450c4-f1d3-4edd-8d70-d1b4f7c16348'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force Update TraitFARADAY_FORCE_UPDATE_TRAITAcción

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

Parámetros de entrada

trait_idstringObligatorio
The UUID of the trait to force update. This triggers a rerun for the trait. Example: '616aee5f-e544-43ff-a27e-5207248d4056'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AccountFARADAY_GET_ACCOUNTAcción

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.

Parámetros de entrada

account_idstringObligatorio
The UUID of the account to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List AccountsFARADAY_GET_ACCOUNTSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Accounts BillingFARADAY_GET_ACCOUNTS_BILLINGAcción

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

Parámetros de entrada

account_idstringObligatorio
The UUID of an account

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CohortFARADAY_GET_COHORTAcción

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

Parámetros de entrada

cohort_idstringObligatorio
The UUID of the cohort to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Cohort Membership AnalysisFARADAY_GET_COHORT_ANALYSIS_MEMBERSHIPAcción

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.

Parámetros de entrada

cohort_idstringObligatorio
The UUID of the cohort to analyze

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CohortsFARADAY_GET_COHORTSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Connection DatasetsFARADAY_GET_CONNECTION_DATASETSAcción

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

Parámetros de entrada

connection_idstringObligatorio
The UUID of the connection to retrieve datasets for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Connection TargetsFARADAY_GET_CONNECTIONS_TARGETSAcción

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.

Parámetros de entrada

connection_idstringObligatorio
The UUID of a connection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current AccountFARADAY_GET_CURRENT_ACCOUNTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current Account BillingFARADAY_GET_CURRENT_ACCOUNT_BILLINGAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DatasetFARADAY_GET_DATASETAcción

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.

Parámetros de entrada

dataset_idstringObligatorio
The UUID of the dataset to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dataset Ingress LogsFARADAY_GET_DATASETS_LOGS_INGRESSAcción

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.

Parámetros de entrada

limitinteger
Number of records to return (pagination)
offsetinteger
Number of records to skip for pagination
dataset_idstringObligatorio
UUID of the dataset to retrieve ingress logs for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Feature StoresFARADAY_GET_FEATURE_STORESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dependency GraphFARADAY_GET_GRAPHAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Market Opportunity AnalysesFARADAY_GET_MARKET_OPPORTUNITY_ANALYSESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get OutcomeFARADAY_GET_OUTCOMEAcción

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.

Parámetros de entrada

outcome_idstringObligatorio
The UUID of the outcome to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List OutcomesFARADAY_GET_OUTCOMESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Persona SetFARADAY_GET_PERSONA_SETAcción

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.

Parámetros de entrada

persona_set_idstringObligatorio
The UUID of a persona set to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Persona Set Analysis FlowFARADAY_GET_PERSONA_SET_ANALYSIS_FLOWAcción

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.

Parámetros de entrada

persona_set_idstringObligatorio
The UUID of a persona set

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Persona SetsFARADAY_GET_PERSONA_SETSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Persona Set Analysis DimensionsFARADAY_GET_PERSONA_SETS_ANALYSIS_DIMENSIONSAcción

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.

Parámetros de entrada

persona_set_idstringObligatorio
The UUID of the persona set to retrieve analysis dimensions for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PlaceFARADAY_GET_PLACEAcción

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.

Parámetros de entrada

place_idstringObligatorio
The UUID of the place to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List PlacesFARADAY_GET_PLACESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List RecommendersFARADAY_GET_RECOMMENDERSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ScopeFARADAY_GET_SCOPEAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope AnalysisFARADAY_GET_SCOPE_ANALYSISAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to get analysis for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope DatasetsFARADAY_GET_SCOPE_DATASETSAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve datasets for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope EfficacyFARADAY_GET_SCOPE_EFFICACYAcción

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

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve efficacy data for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope Payload CohortsFARADAY_GET_SCOPE_PAYLOAD_COHORTSAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve payload cohorts for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope Payload OutcomesFARADAY_GET_SCOPE_PAYLOAD_OUTCOMESAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve payload outcomes for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope Payload Persona SetsFARADAY_GET_SCOPE_PAYLOAD_PERSONA_SETSAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve payload persona sets for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope Payload RecommendersFARADAY_GET_SCOPE_PAYLOAD_RECOMMENDERSAcción

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

Parámetros de entrada

scope_idstringObligatorio
The UUID of a scope

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope Population Exclusion CohortsFARADAY_GET_SCOPE_POPULATION_EXCLUSION_COHORTSAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of a scope

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope Population CohortsFARADAY_GET_SCOPES_POPULATION_COHORTSAcción

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.

Parámetros de entrada

scope_idstringObligatorio
The UUID of a scope

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Scope TargetsFARADAY_GET_SCOPE_TARGETSAcción

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

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to retrieve targets for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get StreamFARADAY_GET_STREAMAcción

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

Parámetros de entrada

stream_id_or_namestringObligatorio
The stream's UUID or name

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List StreamsFARADAY_GET_STREAMSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Streams AnalysisFARADAY_GET_STREAMS_ANALYSISAcción

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.

Parámetros de entrada

stream_id_or_namestringObligatorio
The UUID of a stream or stream name

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TargetFARADAY_GET_TARGETAcción

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.

Parámetros de entrada

target_idstringObligatorio
The UUID of the target to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Target AnalysisFARADAY_GET_TARGETS_ANALYSISAcción

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.

Parámetros de entrada

target_idstringObligatorio
The UUID of the target to retrieve analysis for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TraitFARADAY_GET_TRAITAcción

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.

Parámetros de entrada

trait_idstringObligatorio
The UUID of the trait to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Trait Analysis DimensionsFARADAY_GET_TRAITS_ANALYSIS_DIMENSIONSAcción

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.

Parámetros de entrada

trait_idstringObligatorio
The UUID of the trait to retrieve analysis dimensions for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Traits CSVFARADAY_GET_TRAITS_CSVAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get UploadFARADAY_GET_UPLOADAcción

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

Parámetros de entrada

filenamestringObligatorio
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'
directorystringObligatorio
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'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Uploaded FilesFARADAY_GET_UPLOADSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get UsagesFARADAY_GET_USAGESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Webhook EndpointFARADAY_GET_WEBHOOK_ENDPOINTAcción

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.

Parámetros de entrada

webhook_endpoint_idstringObligatorio
The UUID of a webhook endpoint

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Webhook EndpointsFARADAY_GET_WEBHOOK_ENDPOINTSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List AttributesFARADAY_LIST_ATTRIBUTESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ConnectionsFARADAY_LIST_CONNECTIONSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ScopesFARADAY_LIST_SCOPESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TargetsFARADAY_LIST_TARGETSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive CohortFARADAY_UNARCHIVE_COHORTAcción

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

Parámetros de entrada

cohort_idstringObligatorio
The UUID of the cohort to unarchive. Example: 'bc4eef1c-be49-4ca6-880f-a34479c7755d'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive DatasetFARADAY_UNARCHIVE_DATASETSAcción

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

Parámetros de entrada

cascade_tostring[]
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_idstringObligatorio
The UUID of the dataset to unarchive.
cascade_to_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive OutcomeFARADAY_UNARCHIVE_OUTCOMEAcción

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

Parámetros de entrada

cascade_tostring[]
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_idstringObligatorio
The UUID of the outcome to unarchive. Unarchiving restores updates to the outcome. Example: '15be73ec-1525-4d5c-a96a-e644c93d00d8'
cascade_to_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive Persona SetFARADAY_UNARCHIVE_PERSONA_SETSAcción

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

Parámetros de entrada

cascade_tostring[]
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_allboolean
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_idstringObligatorio
The UUID of the persona set to unarchive. Example: '8505e525-128c-4ede-a279-85f372aa6aaf'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive PlaceFARADAY_UNARCHIVE_PLACESAcción

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

Parámetros de entrada

place_idstringObligatorio
The UUID of the place to unarchive. Example: 'a1eafa5c-020a-427f-ae18-2d0b3c0fced7'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive ScopeFARADAY_UNARCHIVE_SCOPEAcción

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

Parámetros de entrada

scope_idstringObligatorio
The UUID of the scope to unarchive. Example: 'fce4d114-9516-4e8c-a92e-e1ed13d5369d'
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive StreamFARADAY_UNARCHIVE_STREAMAcción

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

Parámetros de entrada

cascade_tostring[]
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_allboolean
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_namestringObligatorio
The UUID or name of the stream to unarchive.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive TraitFARADAY_UNARCHIVE_TRAITAcción

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

Parámetros de entrada

trait_idstringObligatorio
The UUID of the trait to unarchive
cascade_tostring[]
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_allboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update AccountFARADAY_UPDATE_ACCOUNTAcción

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

Parámetros de entrada

namestring
The name of the account. Must be non-empty and max 64 characters.
brandingobject
Whitelabel branding configuration for the account
account_idstringObligatorio
The UUID of the account to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CohortFARADAY_UPDATE_COHORTAcción

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.

Parámetros de entrada

namestring
Human-readable label for this cohort. Must be non-empty and max 64 characters.
traitsobject[]
List of traits to filter cohort membership. Set to null to clear.
exploreboolean
Whether to show the Cohort in Explore, the map view on https://app.faraday.ai. This will slow down Cohort builds.
recencyobject
Recency condition for event-based filtering.
cohort_idstringObligatorio
The UUID of the cohort to update
max_countnumber
Max count for this cohort's config
max_valuenumber
Max value for this cohort's config
min_countnumber
Min count for this cohort's config
min_valuenumber
Min value for this cohort's config
stream_namestring
The name field of the stream from which to build this cohort. Set to null to clear.
place_conditionsobject[]
List of places to use to spatially filter Cohort membership. Set to null to clear.
stream_conditionsobject[]
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ConnectionFARADAY_UPDATE_CONNECTIONAcción

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

Parámetros de entrada

namestring
A user-friendly name of the connection. Max 64 characters, must be non-empty.
optionsobject
Connection-specific options that vary by connection type.
connection_idstringObligatorio
The UUID of the connection to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DatasetFARADAY_UPDATE_DATASETAcción

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.

Parámetros de entrada

namestring
An identifying name for this dataset.
optionsobject
Dataset connection options. Must specify 'type' field for the connection type.
previewboolean
A dataset in preview mode will only detect columns and produce a data preview, but not ingest the data. Set to null to clear.
privacystring
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_idstringObligatorio
The UUID of the dataset to update.
identity_setsobject
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_columnsstring[]
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_traitsobject
A mapping of trait name to trait definition. Set to null to clear.
output_to_streamsobject
Describes how to transform the dataset into one or more streams. Set to null to clear.
identity_providersobject[]
Which identity providers to use for matching, in order of priority. Set to null to clear.
incremental_columnstring
A column specifying a date associated with a record. Set to null to clear.
reference_key_columnstring
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_columnsstring[]
The names of columns that reference IDs from an external system. Set to null to clear.
output_to_streams_arrayobject[]
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_traitsobject
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update OutcomeFARADAY_UPDATE_OUTCOMEAcción

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.

Parámetros de entrada

namestring
Human-readable label for this outcome. Each outcome must have a unique name. Max 64 characters, must not be empty or only whitespace.
previewboolean
An outcome in preview mode will not build until preview is turned off. Set to null to clear.
outcome_idstringObligatorio
The UUID of the outcome to update.
predictorsobject
Configuration for features used during modeling.
bias_mitigationobject
Bias mitigation configuration for age and gender dimensions.
prediction_modestringenum
Prediction mode for outcome modeling.
autostatic
feature_blockliststring[]
Field or category names that should not be considered for this outcome, primarily for Responsible AI purposes. Set to null to clear.
eligible_cohort_idstring
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_idstring
A cohort of counterexamples - people who have clearly failed to attain the outcome. This cohort is optional. Set to null to clear.
attainment_cohort_idstring
A cohort of people who have attained the desired outcome (e.g., existing customers if predicting prospect to customer transition).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Persona SetFARADAY_UPDATE_PERSONA_SETAcción

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.

Parámetros de entrada

namestring
Human-readable label for this persona set. Must be non-empty and max 64 characters.
exploreboolean
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.
previewboolean
A persona set in preview mode will not build until preview is turned off. Set to null to clear this setting.
persona_set_idstringObligatorio
The UUID of the persona set to update
number_of_clustersinteger
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update PlaceFARADAY_UPDATE_PLACEAcción

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

Parámetros de entrada

namestring
Human-readable label for this place. Names must be unique. Uniqueness is case-insensitive.
geojsonobject
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_idstringObligatorio
The UUID of the place to update
addressesobject[]
List of addresses to be geocoded. Set to null to clear addresses, or provide a list to overwrite existing addresses.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ScopeFARADAY_UPDATE_SCOPEAcción

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.

Parámetros de entrada

namestring
Human-readable label for this scope. Each scope must have a unique name (max length: 64 characters, must be non-empty).
payloadobject
The data to include for each person in this scope (for PATCH requests)
previewboolean
A preview scope provides only a limited number of output records, but it is not billed.
scope_idstringObligatorio
The UUID of the scope to update
populationobject
The people to include in a scope (for PATCH requests)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update StreamFARADAY_UPDATE_STREAMAcción

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.

Parámetros de entrada

tierstring
A billing tier for the stream property. Set to null to clear this field.
categorystring
A category describing the type of stream property. Set to null to clear this field.
literatestring
A human-readable name for the stream. Set to null to clear this field.
deprecatedboolean
Whether the stream is deprecated. Set to null to clear this field.
propertiesobject
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.
descriptionstring
A description of the stream. Set to null to clear this field.
deprecation_notesstring
Notes about the deprecation of the stream. Set to null to clear this field.
stream_id_or_namestringObligatorio
The stream's UUID or name to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TargetFARADAY_UPDATE_TARGETAcción

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

Parámetros de entrada

namestring
A user-friendly name of the target (max length: 64 characters)
limitobject
Limit configuration for target rows
filterobject
Filter configuration for target rows
optionsobject
Target export configuration options
target_idstringObligatorio
The UUID of the target to update
payload_mapobject
Deprecated: use custom_structure. Explicit mapping of columns that should be included in the target export. Set to null to clear
connection_idstring
If this is a replication (externally-hosted) target, the UUID of a connection. Set to null to clear
human_readableboolean
Whether to use human-readable column names instead of machine-readable format with underscored uuids. Set to null to clear
representationobject
Target representation configuration
analysis_configobject
Configuration for the analysis of the target
custom_structureobject[]
Custom structure transformations to override the default selection, order, and name of exported columns. Set to null to clear

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TraitFARADAY_UPDATE_TRAITAcción

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.

Parámetros de entrada

unitstring
For numeric types, in what units is the data stored. Set to null to clear this value.
literatestring
A more human-consumable version of the name of this field. Set to null to clear this value.
trait_idstringObligatorio
The UUID of the trait to update
descriptionstring
Information about this field. Set to null to clear this value.
lookup_tableobject
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_typestringenum
Statistical type describing the nature of data.
categoricalmulticategoricalordinalnominal

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Webhook EndpointFARADAY_UPDATE_WEBHOOK_ENDPOINTSAcción

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.

Parámetros de entrada

urlstring
The URL of the webhook endpoint.
statusstringenum
The status of the webhook endpoint.
enableddisabled
enabled_eventsstring[]
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_idstringObligatorio
The UUID of the webhook endpoint to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not