What is an API?
A short guide for people who have never used one
Last reviewed
The basics
An API is a way for two computer programs to talk to each other. You use a website by clicking. A program uses an API by sending short messages. The API lets your own tools read or update what you keep with TheWILL.ai.
An API key is like a password for a program. You make one in your account and give it to the tool you want to connect. The key only lets the tool do the things you allow. You can switch it off at any time.
A test key is a key that only works with made-up demo data. You can use it to try things out. Nothing you do with it touches real records. Not every API has test keys yet. The table below shows which ones do.
A webhook works the other way round. Instead of your tool asking us for news, we send your tool a short message when something changes. For example, we can tell your tool when a document is ready.
New words on this page are all in the API glossary.
Which one is for me?
Find the row that sounds like you. Then open its guide.
| If you are… | You can… | Start here |
|---|---|---|
| Families | For people who want their own spreadsheets, apps or home tools to read and update the portfolio they keep with us. Test keys are available. | Read the Families guide |
| Law firms | For solicitors and will writers who want their practice software to share client and matter details with their firm's account. Test keys are available. | Read the Law firms guide |
| Advisers and wealth-management firms | For financial advisers and wealth-management firms who want their own systems to see the estate-planning progress their clients choose to share. Test keys are available. | Read the Advisers and wealth-management firms guide |
| Employers | For HR and benefits teams who want reports on how their staff use the will-writing benefit they provide. | Read the Employers guide |
| Banks and partners | For banks and other organisations who want to offer will writing to their own customers under their own name. Test keys are available. | Read the Banks and partners guide |
| AI assistants | For people who want an AI assistant they already use to look up and organise their records with their permission. | Read the AI assistants guide |
What it costs
API access comes with some of our plans. There is no separate fee for each call, but each key has a limit on how many calls it can make in an hour.
- Families: included with Silver, Gold, Platinum and VIP Concierge.
- Law firms: included with Legal Growth, Legal Enterprise and Founding Member Legal Growth.
- Advisers and wealth-management firms: included with Legal Growth, Legal Enterprise and Founding Member Legal Growth.
- Banks and partners: included with Legal Growth, Legal Enterprise and Founding Member Legal Growth.
- AI assistants: included with Silver, Gold, Platinum and VIP Concierge.
The pricing page shows what each plan costs.
How your data stays safe
- A key can only do the things you chose when you made it.
- You can see each key in your account and switch it off at any time.
- We keep a record of the calls each key makes, so you can check what it did.
- Every call travels over an encrypted link.
- We never show a key again after you make it. Keep it somewhere safe, like a password.
To check whether the API is working right now, see our service status page (opens in a new tab).
API terms at a glance
These lines tell you where each part of our legal documents covers the API. They only describe what each part is about. The documents themselves are what apply.
- Terms of Service, the paragraph on personal API keys: What a personal key can do, and the extra checks before a key can download documents.
- Acceptable Use Policy, section 9A: The rules for using the platform through the API or an AI assistant.
- Privacy Policy, section 20: What data we keep when you use the consumer API, and for how long.
- Professional Terms and Conditions, clauses 5.6 and 5.6A: The terms for firms that use the Professional API, including creating wills through it.
- Data Processing Agreement, the employer programme sections: How staff data is handled for employers, including the Corporate Reporting API.
Ready to start?
The developer access guide shows how to make your first key.
Can’t find what you’re looking for?
Our support team is here to help. Contact us and we’ll get back to you as soon as possible.
Contact us
