# Swallow ## Swallow - [Setting up your first project](https://swallow-1.gitbook.io/swallow/your-first-model/setting-up-your-first-project.md) - [Manual setup of a new product](https://swallow-1.gitbook.io/swallow/your-first-model/manual-setup-of-a-new-product.md): A guide to setting up your first product in Swallow. - [Excel Model Upload](https://swallow-1.gitbook.io/swallow/your-first-model/excel-model-upload.md): Swallow models created from XLS uploads - [Create your team](https://swallow-1.gitbook.io/swallow/your-first-model/create-your-team.md): A guide to setting up your first team in Swallow - [Essential concepts](https://swallow-1.gitbook.io/swallow/your-first-model/essential-concepts.md): Master these concepts and you will be able to build any type of financial project - [Syntax](https://swallow-1.gitbook.io/swallow/your-first-model/essential-concepts/syntax.md): This is the structure of the language you'll be using to code nearly all steps and decisions in your pricing model, writing rules, filtering data, looking up variables and applying transforms. - [Steps](https://swallow-1.gitbook.io/swallow/your-first-model/essential-concepts/steps.md): Steps are the core of our drag-and-drop price builder - [Collections](https://swallow-1.gitbook.io/swallow/your-first-model/essential-concepts/collections.md): Using Collections to dynamically query large data sets - [Try Model](https://swallow-1.gitbook.io/swallow/your-first-model/essential-concepts/try-model.md): Interact with your model from anywhere in your project - [Spotlight](https://swallow-1.gitbook.io/swallow/your-first-model/essential-concepts/spotlight.md): Find anything in your model, on any page, by using the Spotlight tool - [Team Management](https://swallow-1.gitbook.io/swallow/process/team-management.md): Setting up a team and managing permissions for each project and version - [Governance & Collaboration](https://swallow-1.gitbook.io/swallow/process/governance-and-collaboration.md): Working with your team to build, edit, approve and evaluate a pricing model - [Building with AI](https://swallow-1.gitbook.io/swallow/build/building-with-ai.md): Kickstart the first build of a new model with our AI tool - [Step builder](https://swallow-1.gitbook.io/swallow/build/step-builder.md): Everything you need to know about getting started with step builder, block-by-block. - [Understanding step types](https://swallow-1.gitbook.io/swallow/build/step-builder/understanding-step-types.md): Learn about the different step types available in the builder - [Ordering step blocks](https://swallow-1.gitbook.io/swallow/build/step-builder/ordering-step-blocks.md): Learning how to order step blocks in the drag-and-drop model builder - [Placeholder mode](https://swallow-1.gitbook.io/swallow/build/step-builder/placeholder-mode.md): Building new models in draft mode, without using them in your model - [Up/Downloading models](https://swallow-1.gitbook.io/swallow/build/step-builder/up-downloading-models.md): Downloading & uploading your full model build as JSON - [Sharing your model](https://swallow-1.gitbook.io/swallow/build/step-builder/sharing-your-model.md): Sharing your pricing model with others for review or testing - [Running tests](https://swallow-1.gitbook.io/swallow/build/step-builder/running-tests.md): Testing your build as you go with logs and the test scenario dialogue - [Inputs](https://swallow-1.gitbook.io/swallow/build/inputs.md): Setting up the inputs you'll process in your pricing model - [Enriching Raw Data](https://swallow-1.gitbook.io/swallow/build/enriching-raw-data.md): Using Enrichment steps in our builder to reformat and enrich raw data inputs - [Transform Data](https://swallow-1.gitbook.io/swallow/build/enriching-raw-data/transform-data.md): Using a transformation step in the builder to reformat raw data inputs - [Enrich via API](https://swallow-1.gitbook.io/swallow/build/enriching-raw-data/enrich-via-api.md): Using an API enrichment step in the builder to enrich raw data inputs with third-party APIs - [Data Set](https://swallow-1.gitbook.io/swallow/build/enriching-raw-data/data-set.md): Using the Data Set step in the builder to enrich raw data inputs with additional data - [Collection](https://swallow-1.gitbook.io/swallow/build/enriching-raw-data/collection.md): Using the Collection step in the builder to dynamically query data tables with multiple columns to enrich your input data - [Custom Code](https://swallow-1.gitbook.io/swallow/build/enriching-raw-data/custom-code.md): Using your own javascript custom code to enrich or reformat data inputs. - [Setting Up Decisions](https://swallow-1.gitbook.io/swallow/build/setting-up-decisions.md): Making automated decisions with your data. - [Exclusions](https://swallow-1.gitbook.io/swallow/build/setting-up-decisions/exclusions.md): Using the 'Exclusions' step in the builder to create rules for rejecting quotes - [Excesses](https://swallow-1.gitbook.io/swallow/build/setting-up-decisions/excesses.md): Using the 'Excesses' step in the builder to create rules for adding excesses or deductibles - [Endorsements](https://swallow-1.gitbook.io/swallow/build/setting-up-decisions/endorsements.md): Using the 'Endorsement' step in the builder to create endorsement rules for quotes - [Refer](https://swallow-1.gitbook.io/swallow/build/setting-up-decisions/refer.md): Creating custom referral rules for quotes so you can review them before or after pricing - [Making Calculations](https://swallow-1.gitbook.io/swallow/build/making-calculations.md): Using data inputs you've collected, transformed and enriched to make calculations to finalise risk factors, pricing or rates - [Factors](https://swallow-1.gitbook.io/swallow/build/making-calculations/factors.md): Using the 'Factors' step in the builder to create a table of risk factors, and calculate final ratings - [Calculation](https://swallow-1.gitbook.io/swallow/build/making-calculations/calculation.md): Using the 'Calculation' step in the builder to define complex calculations - [Outputs](https://swallow-1.gitbook.io/swallow/build/outputs.md): Defining the outputs of your pricing model. - [Creating New Tests](https://swallow-1.gitbook.io/swallow/test/creating-new-tests.md): Creating test inputs and cases for use throughout your project - [Running Tests](https://swallow-1.gitbook.io/swallow/test/running-tests.md): Running tests against your pricing model - [Editing Tests](https://swallow-1.gitbook.io/swallow/test/editing-tests.md): Editing tests already set up in your project - [Reading & Interpreting Tests](https://swallow-1.gitbook.io/swallow/test/reading-and-interpreting-tests.md): Using testing reports to analyse your model's performance - [Impact Testing](https://swallow-1.gitbook.io/swallow/test/impact-testing.md): Understanding how change will effect your customers - [Working with real-time data](https://swallow-1.gitbook.io/swallow/data/working-with-real-time-data.md): All data within Swallow is processed in real time - [Data Views](https://swallow-1.gitbook.io/swallow/data/data-views.md): Viewing quote data that's passed through your model - [Data Quotas](https://swallow-1.gitbook.io/swallow/data/data-quotas.md): Understanding your monthly data allowance - [Troubleshooting](https://swallow-1.gitbook.io/swallow/data/troubleshooting.md): Testing and problem solving throughout the Swallow platform - [API Webhooks](https://swallow-1.gitbook.io/swallow/data/api-webhooks.md): Learn how to write data from Swallow to your own system. - [Data Downloads](https://swallow-1.gitbook.io/swallow/data/data-downloads.md): Learn how to download data from Swallow via API or as a CSV via the web platform. - [Project Management](https://swallow-1.gitbook.io/swallow/admin-and-settings/project-management.md): Using the project overview screen to see all of your models at a glance - [Account Management](https://swallow-1.gitbook.io/swallow/admin-and-settings/account-management.md): Manage your personal and company account within Swallow - [Introduction](https://swallow-1.gitbook.io/swallow/integrations/introduction.md) - [Payments](https://swallow-1.gitbook.io/swallow/integrations/payments.md) - [Stripe](https://swallow-1.gitbook.io/swallow/integrations/payments/stripe.md): Swallow's native integration allows you to collect payments automatically.. - [GoCardless](https://swallow-1.gitbook.io/swallow/integrations/payments/gocardless.md): Swallow's native integration with direct debit providers allows you to collect payments via direct debit. - [Adyen](https://swallow-1.gitbook.io/swallow/integrations/payments/adyen.md): Swallow's native integration with Adyen allows you to collect payments automatically when new quotes are generated - [Alerting](https://swallow-1.gitbook.io/swallow/integrations/alerting.md) - [Slack](https://swallow-1.gitbook.io/swallow/integrations/alerting/slack.md): Here is a typical use case of using Swallow with Slack to receive alerts when quotes are created. - [Zapier](https://swallow-1.gitbook.io/swallow/integrations/alerting/zapier.md): Swallow with Zapier to create automated alerts on quote creation. - [Data](https://swallow-1.gitbook.io/swallow/integrations/data.md) - [AWS S3](https://swallow-1.gitbook.io/swallow/integrations/data/aws-s3.md) - [Google Sheets](https://swallow-1.gitbook.io/swallow/integrations/data/google-sheets.md): Swallow's integration with Google Sheets enables seamless data synchronization and reporting capabilities. - [Admin](https://swallow-1.gitbook.io/swallow/integrations/admin.md) - [Socotra](https://swallow-1.gitbook.io/swallow/integrations/admin/socotra.md) - [Guidewire](https://swallow-1.gitbook.io/swallow/integrations/admin/guidewire.md) - [Hubspot](https://swallow-1.gitbook.io/swallow/integrations/admin/hubspot.md): The Swallow and HubSpot Integration supports bidirectional sync between Swallow and HubSpot. - [Salesforce](https://swallow-1.gitbook.io/swallow/integrations/admin/salesforce.md): Syncs data to Salesforce in real-time - [Introduction](https://swallow-1.gitbook.io/swallow/developer-api/introduction.md): Powerful API for paid Swallow accounts - [Authentication](https://swallow-1.gitbook.io/swallow/developer-api/authentication.md): All API endpoints have authentication built-in. API requests are not available in free accounts. - [Errors codes](https://swallow-1.gitbook.io/swallow/developer-api/errors-codes.md): Standardised errors for all API requests. - [Endpoints](https://swallow-1.gitbook.io/swallow/developer-api/endpoints.md): All the API endpoints available to you is you have a paid for account. - [/quotes](https://swallow-1.gitbook.io/swallow/developer-api/endpoints/quotes.md): Quote API is for creating priced quotes from Swallow pricing projects, and returning quote data at volume. - [/projects](https://swallow-1.gitbook.io/swallow/developer-api/endpoints/projects.md): Projects API is for reporting on pricing project states and to aid in building custom quote flows - [/tests](https://swallow-1.gitbook.io/swallow/developer-api/endpoints/tests.md): Tests API is for having programmatic test reporting for confidence and/or integration in to your own CI/CD systems. - [/process](https://swallow-1.gitbook.io/swallow/developer-api/endpoints/process.md): Process API is for having programatic reporting for auditability --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://swallow-1.gitbook.io/swallow/your-first-model/setting-up-your-first-project.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.