Skip to content
Changelog

Report a bug

Faraday integration: operations for AI agents

Faraday connects to Type.com as an integration. This page lists the 208 operations documented for Claude and Codex in Type.com: 91 read, 82 write, 35 destructive.

About Faraday

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

Categories: Analytics & Data

How to connect Faraday to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

208 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

208 operations listed.

Accounts

  • Read

    List accounts

    Get a list of accounts defined on the account

  • Read

    Retrieve current account

    Get details on the current account, as identified by the API key

  • Read

    List configuration audits of the current account

    The account's configuration audits, newest first. Each compares the account's configuration with what its knowledgebase use cases require. Listed audits omit changes, orphanedresources and usecases; fetch one to get them.

  • Read

    Get a configuration audit of the current account

    One configuration audit, in full.

  • Read

    Get usage metrics for current account

    Get historical usage metrics for the current account from the most recent metrics dashboard event.

  • Read

    Get usage metrics for current and sub accounts

    Get aggregated historical usage metrics for the current account and all of its sub-accounts.

  • Read

    Retrieve an account

    Get details on a specific account. This must be an account controlled by your API key.

  • Read

    List configuration audits

    The account's configuration audits, newest first. Each compares the account's configuration with what its knowledgebase use cases require. Listed audits omit changes, orphanedresources and usecases; fetch one to get them.

  • Read

    Get a configuration audit

    One configuration audit, in full.

  • Read

    Get usage metrics for a specific account

    GET /accounts/{account_id}/usage

  • Write

    Create account

    Create a subaccount.

  • Write

    Request a configuration audit of the current account

    Queue a new configuration audit of the account. The response has no body: the audit is in the list at once, with status running until it finishes. Responds 409 while an audit of the account is already running.

  • Write

    Apply a configuration audit of the current account

    Apply every appliable change in this audit to the account. Poll the audit's applystatus for the outcome. Before changing anything, the account is compared again, and the apply proceeds only if the result is identical to what this audit found.

  • Write

    Update an account

    Update the configuration of an account.

  • Write

    Request a configuration audit

    Queue a new configuration audit of the account. The response has no body: the audit is in the list at once, with status running until it finishes. Responds 409 while an audit of the account is already running.

  • Write

    Apply a configuration audit

    Apply every appliable change in this audit to the account. Poll the audit's applystatus for the outcome. Before changing anything, the account is compared again, and the apply proceeds only if the result is identical to what this audit found.

  • Destructive

    Delete an account

    Request an account deletion. In 24 hours, the account and all resources associated with it will be deleted. Contact support within the 24 hour window if you wish to reverse this.

Billing

  • Read

    Get billing information about the current account.

    Get invoices, payments, and usage stats for the current account.

  • Read

    Get billing information about your account.

    Get invoices, payments, and usage stats for your account.

Atlases

  • Read

    List atlases

    Get a list of the atlases defined on the account

  • Read

    Retrieve an atlas

    Retrieve details on a specific atlas

  • Read

    List the ingress logs of an atlas

    Get the build logs of an atlas, newest first. There is one log per build that re-read the atlas' source data or re-derived its locations from it, including builds that failed. A build that found nothing to do produces no log.

  • Read

    Retrieve an atlas ingress log

    Retrieve a single build log of an atlas

  • Read

    List the rows an atlas build could not place

    Get the rows of the atlas' source data that the build recorded by this log could not place as a location, with their source values and the reason, ordered by name and then referencekey.

  • Write

    Create atlas

    Create a new atlas

  • Write

    Update atlas

    Update an existing atlas

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive an atlas

    Unarchive an atlas

  • Destructive

    Delete an atlas

    DELETE /atlases/{atlas_id}

  • Destructive

    Archive an atlas

    Archive an atlas

Locations

  • Read

    List the locations of an atlas

    Get a list of the locations belonging to a specific atlas

  • Read

    List locations

    Get a list of the locations belonging to every atlas on the account

Attributes

  • Read

    List attributes

    Get a list of attributes defined on the account

  • Read

    Retrieve an attribute

    Get details on a specific attribute

  • Write

    Create attribute

    Add a new attribute that wraps a stream of assertions

  • Write

    Update an attribute

    Update the configuration of an attribute

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Destructive

    Delete an attribute

    DELETE /attributes/{attribute_id}

Cohorts

  • Read

    List cohorts

    Get a list of cohorts defined on the account

  • Read

    Retrieve a cohort

    Get details on a specific cohort

  • Read

    Get the cohort membership counts over time.

    GET /cohorts/{cohort_id}/analysis/membership

  • Write

    Create cohort

    Add a new cohort (defined as people who have made qualifying emissions of certain events)

  • Write

    Edit a cohort

    Edit configuration of a cohort

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive a cohort

    Unarchive a cohort

  • Destructive

    Delete a cohort

    DELETE /cohorts/{cohort_id}

  • Destructive

    Archive a cohort

    Archive a cohort

Connections

  • Read

    List connections

    Get a list of connections defined on the account

  • Read

    Retrieve a connection

    Get details on a specific connection

  • Read

    Retrieve all datasets that use this connection

    Get all datasets that use this connection

  • Read

    Retrieve all targets that use this connection

    Get all targets that use this connection

  • Write

    Create connection

    Add a new connection. Connections are configuration for connecting data between Faraday and an external location. They are required when working with replication targets . All connections have a type that determines which options may be specified.

  • Write

    Update a connection

    Update the configuration of a connection.

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Rotate credentials for a connection

    Rotate credentials for a Snowflake or ClickHouse connection. This regenerates the connection type's keypair.

  • Write

    Unarchive a connection

    Unarchive a connection

  • Destructive

    Delete a connection

    Delete a connection

  • Destructive

    Archive a connection

    Archive a connection

Datasets

  • Read

    List datasets

    Get a list of the datasets defined on the account

  • Read

    Retrieve a dataset

    Retrieve details on a specific dataset

  • Read

    Get dataset ingress metrics over time

    Retrieves ingress metrics for a specific dataset

  • Read

    Get a single dataset ingress log by ID

    Retrieves a specific ingress log entry for a dataset

  • Write

    Create dataset

    Create a new dataset

  • Write

    Update dataset

    Update an existing dataset

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive a dataset

    Unarchive a dataset

  • Destructive

    Delete a dataset

    DELETE /datasets/{dataset_id}

  • Destructive

    Archive a dataset

    Archive a dataset

Feature stores

  • Read

    List feature stores

    Get a list of feature stores defined on the account

  • Read

    Retrieve a feature store

    Get details on a specific feature store

  • Write

    Create feature store

    Add a new feature store that compiles attributes

  • Write

    Update a feature store

    Update the configuration of a feature store

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Destructive

    Delete a feature store

    DELETE /feature_stores/{feature_store_id}

Forecasts

  • Read

    List forecasts

    Get a list of forecasts defined on the account

  • Read

    Retrieve a forecast

    Get details on a specific forecast

  • Write

    Create forecast

    Add a new forecast. This feature is experimental and subject to change. To enable this feature, contact your account manager.

  • Write

    Edit a forecast

    Edit configuration of a forecast. Sending any member other than name starts a new asynchronous build of the forecast.

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource.

  • Write

    Unarchive a forecast

    Unarchive a forecast

  • Destructive

    Delete a forecast

    DELETE /forecasts/{forecast_id}

  • Destructive

    Archive a forecast

    Archive a forecast

Graph

  • Read

    Retrieve a dependency graph for all resources on an account

    Each object in the list is an edge in the dependency graph.

Insights

  • Read

    Retrieve the account's Insights

    One per account, provisioned by your plan. Returns the account's Insights resource: its status, and the tables and columns available to query with POST /insights/query. Every table and column listed exists and can be queried; they are exactly what the last build produced.

  • Write

    Rebuild the account's Insights

    Queues a rebuild of the account's Insights tables. Changes to the account's cohorts, streams and atlases already trigger one; this is for recovering from a failed build.

  • Write

    Run an Insights query

    Runs one aggregate GoogleSQL query against the tables GET /insights lists and returns the result rows. Synchronous: the rows come back in the response, and nothing is stored.

Knowledgebase

  • Read

    Retrieve the account overview

    Get the current revision of this account's knowledgebase overview. If no overview has ever been written, revisionid and createdat are absent and content is the empty string.

  • Read

    List account overview revisions

    List every saved revision of the account overview, newest first.

  • Read

    Retrieve a specific account overview revision

    Read an older saved revision of the account overview. The shape matches the current-revision endpoint.

  • Read

    List use cases

    Get a list of use cases for the calling account. Returns summary fields only; fetch a specific use case to see its preface, guide, and resources.

  • Read

    Retrieve a use case

    Get the full current revision of a use case, including its computed resources list.

  • Read

    List use case revisions

    List every saved revision of a use case, newest first.

  • Read

    Retrieve a specific use case revision

    Read an older saved revision of a use case. The shape matches the current-revision endpoint, except resources is omitted (resources are a live computed property, not part of the versioned content).

  • Write

    Update the account overview

    Save a new revision of the account overview. Optimistic locking: pass back the revisionid you read; if the server's current revision has moved past it, the request is rejected with 409. Omit revisionid only when the overview has never been written before.

  • Write

    Real-time checklist for a use-case draft

    A fast, text-only completeness check for a use case still being written: given the draft title, preface, and technicaldetails, it returns the use case's flavor and a per-flavor checklist of requirements, each marked covered / partial / missing.

  • Write

    Create a use case

    Create a new use case under the calling account.

  • Write

    Update a use case

    Save a new revision of a use case. Optimistic locking: pass back the revisionid you read; if the server's current revision has moved past it, the request is rejected with 409. Fields not present are left at their current values.

  • Write

    Request a review of a use case

    Request an agentic review of a use case: does it carry enough — its preface plus technical details — to generate a correct implementation guide and to audit the account against it?

  • Write

    Unarchive a use case

    Unarchive a use case.

  • Destructive

    Delete a use case

    Delete a use case. Unlike archiving, a deleted use case is no longer returned by any read, including when listing archived use cases.

  • Destructive

    Archive a use case

    Archive a use case. Use cases have no downstream dependents so no cascade configuration is required.

Market opportunity analyses

  • Read

    Get all market opportunity analyses

    GET /market_opportunity_analyses

  • Read

    Get a specific market opportunity analysis

    GET /market_opportunity_analyses/{market_opportunity_analysis_id}

  • Write

    Create a new market opportunity analysis

    POST /market_opportunity_analyses

  • Write

    Update a specific market opportunity analysis

    PATCH /market_opportunity_analyses/{market_opportunity_analysis_id}

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource.

  • Write

    Unarchive a specific market opportunity analysis

    POST /market_opportunity_analyses/{market_opportunity_analysis_id}/unarchive

  • Destructive

    Delete a specific market opportunity analysis

    DELETE /market_opportunity_analyses/{market_opportunity_analysis_id}

  • Destructive

    Archive a specific market opportunity analysis

    POST /market_opportunity_analyses/{market_opportunity_analysis_id}/archive

Migrations

  • Read

    List migrations

    GET /migrations

  • Read

    Retrieve a migration

    GET /migrations/{migration_id}

  • Write

    Create a migration

    POST /migrations

  • Write

    Update a migration

    Update a migration with a JSON Merge Patch. Configuration fields (notes, datasets, targets, cohorts, outcomes, personasets, recommenders) may be changed only by the owning FIG v2 account while the migration is unapproved.

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Destructive

    Delete a migration

    DELETE /migrations/{migration_id}

Outcomes

  • Read

    List outcomes

    Get a list of outcomes defined on the account

  • Read

    Retrieve an outcome

    Get details on a specific outcome

  • Read

    Retrieve an outcome's analysis

    Get details on a specific outcome's analysis report on model performance, bias, etc.

  • Read

    Retrieve outcome report

    Download an HTML report containing information such as the objective of the model, performance, and important features

  • Write

    Create outcome

    Add a new outcome (defined as a prediction of how likely individuals are to transition from one cohort to another)

  • Write

    Edit an outcome

    Edit configuration of an existing outcome

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive a outcome

    Unarchive a outcome

  • Destructive

    Delete an outcome

    DELETE /outcomes/{outcome_id}

  • Destructive

    Archive a outcome

    Archive a outcome

Persona sets

  • Read

    List persona sets

    A list of available persona sets

  • Read

    Retrieve a persona set

    Details on a specific persona set, including details on all of its constituent personas

  • Read

    Get various trait breakdown information about a persona set.

    GET /persona_sets/{persona_set_id}/analysis/dimensions

  • Write

    Create persona set

    Invoke the build of a new persona set for a given cohort

  • Write

    Edit a persona set

    Edit a persona set

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Edit a persona

    Edit a persona

  • Write

    Unarchive a persona set

    Unarchive a persona set

  • Destructive

    Delete a persona set

    DELETE /persona_sets/{persona_set_id}

  • Destructive

    Archive a persona set

    Archive a persona set

Recommenders

  • Read

    List recommenders

    Get a list of recommenders defined on the account

  • Read

    Retrieve a recommender

    Get details on a specific recommender

  • Read

    Retrieve a recommenders's analysis

    Get details on a specific recommender's analysis report on model performance, bias, etc.

  • Write

    Create recommender

    Add a new recommender. This feature is experimental and subject to change. To enable this feature, contact your account manager.

  • Write

    Edit a recommender

    Edit configuration of a recommender

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource.

  • Write

    Unarchive a recommender

    Unarchive a recommender

  • Destructive

    Delete a recommender

    DELETE /recommenders/{recommender_id}

  • Destructive

    Archive a recommender

    Archive a recommender

Scopes

  • Read

    List scopes

    Get a list of scopes defined on the account

  • Read

    Retrieve a scope

    Get details on a specific scope

  • Read

    Get analysis for a scope

    Get analysis for a scope

  • Read

    Get geographic breakdown for a scope

    Get a postcode- and state-level breakdown of the scope population, including per-payload-cohort counts. postcodes may be omitted when the scope spans more than 250 distinct postcodes (the UI distribution table saturates at that point); states is always present.

  • Read

    Retrieve all datasets associated with a scope

    Retrieve all datasets associated with a scope. For example, if your scope has populationcohorts, you built those cohorts using data from one of your datasets. This endpoint gets all such datasets.

  • Read

    Get efficacy for a scope

    Get efficacy for a scope

  • Read

    Get payload cohorts for a scope

    Get payload cohorts for a scope

  • Read

    Get payload forecasts for a scope

    Get payload forecasts for a scope

  • Read

    Get payload outcomes for a scope

    Get payload outcomes for a scope

  • Read

    Get payload persona sets for a scope

    Get payload persona sets for a scope

  • Read

    Get payload recommenders for a scope

    Get payload recommenders for a scope

  • Read

    Get population cohorts for a scope

    Get population cohorts for a scope

  • Read

    Get address-level population exclusion cohorts for a scope

    Get address-level population exclusion cohorts for a scope

  • Read

    Get population exclusion cohorts for a scope

    Get population exclusion cohorts for a scope

  • Read

    Get targets for a scope

    Get targets for a scope

  • Write

    Create scope

    Add a new scope

  • Write

    Update a scope

    Update the configuration of a scope.

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive a scope

    Unarchive a scope

  • Destructive

    Delete a scope

    DELETE /scopes/{scope_id}

  • Destructive

    Archive a scope

    Archive a scope

Streams

  • Read

    List streams

    List all streams present on the account

  • Read

    Retrieve a stream

    Look up a specific event stream.

  • Read

    Get the count of stream events emitted over a time period.

    GET /streams/{stream_id_or_name}/analysis

  • Write

    Update a stream

    Update the configuration of a stream

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive a stream

    Unarchive a stream

  • Write

    Create a stream

    Look up (or create) an event stream by name.

  • Destructive

    Delete a stream

    DELETE /streams/{stream_id_or_name}

  • Destructive

    Archive a stream

    Archive a stream

Targets

  • Read

    List targets

    Get a list of targets defined on the account

  • Read

    Retrieve a target

    Get details on a specific target

  • Read

    Retrieve a target's analysis

    Get details on a target's analysis report for specific trait, attribute, and/or geography dimensions.

  • Read

    Retrieve target analysis report

    Gets a redirect URL to download a PDF report.

  • Read

    Download the default output of a target

    GET /targets/{target_id}/download.csv

  • Write

    Create target

    Add a new target. Targets are configuration for exporting data from Faraday, possibly to an external environment (with /connections ).

  • Write

    Update a target

    Update the configuration of a target.

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Perform a lookup on the target, if its type is Lookup API.

    Use either PII or a spatial aggregate to retrieve the payload of a Lookup API target. See the Lookup API specification's quickstart for more details, including examples.

  • Write

    Start a preview delivery

    Trigger a preview delivery (first 1000 results) of a target

  • Write

    Unarchive a target

    Unarchive a target

  • Destructive

    Delete a target

    Delete a target

  • Destructive

    Archive a target

    Archive a target

Traits

  • Read

    List all user-defined and Faraday-provided traits

    Get a list of all available traits, including those provided by Faraday and those defined by the user.

  • Read

    List all user-defined and Faraday-provided traits, in csv form

    Get a csv of all available traits, including those provided by Faraday and those defined by the user.

  • Read

    Get a specific trait

    Get a specific trait by ID.

  • Read

    The percentage of the US population that falls into each category of this trait.

    GET /traits/{trait_id}/analysis/dimensions

  • Write

    Create a Trait

    Create a new user-defined Trait. You can connect your uploaded data to this trait by sending a PATCH to the relevant dataset with outputtotraits defined.

  • Write

    Update a trait

    Update the configuration of a trait

  • Write

    Trigger a rerun for this resource.

    Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

  • Write

    Unarchive a trait

    Unarchive a trait

  • Destructive

    Delete all orphaned traits

    Delete all traits without a source dataset.

  • Destructive

    Delete a trait

    Delete a trait

  • Destructive

    Archive a trait

    Archive a trait

Uploads

  • Read

    Retrieve the list of previously uploaded files

    A list of files uploaded via /uploads/{directory}/{filename}, and their metadata

  • Read

    Download a previously uploaded file

    The file uploaded via /uploads/{directory}/{filename}

  • Write

    Add a file

    Upload a CSV file containing data to process.

  • Destructive

    Delete a file

    Delete a CSV file previously uploaded.

Usage

  • Read

    Get usage stats for your account.

    Get usage stats for your account.

Webhooks

  • Read

    List webhook endpoints

    Get a list of webhook endpoints defined on the account

  • Read

    Retrieve a webhook

    Get details on a specific webhook endpoint

  • Write

    Create webhook endpoint

    Add a new webhook endpoint

  • Write

    Update a webhook endpoint

    Update the configuration of a webhook endpoint

  • Destructive

    Delete a webhook endpoint

    Delete a webhook endpoint

See How connections work for access and permissions, or browse all integrations.

Reference date: October 27, 2026. Faraday API docs.