Get started
Ayeform API
Anything you can do in the app, a script or an AI agent can do with an API key: build and publish forms, set up brands and webhooks, and read every response.
Start here
It’s a REST API with 91 endpoints. Requests with a body send JSON, and answers are JSON, except the CSV export, which comes back as a file.
For AI agents
Point an AI agent at openapi.json and it can find every endpoint, its inputs and what it answers with on its own. The concepts below are in it too.
Concepts
Rules that hold across many endpoints, written once.
- PaginationLists that can grow without limit come back one page at a time, and you follow a cursor to the next page.
- Response statesA response is saved while the person answers, so every response is finished, started or left.
- ConsentEvery response says whether the person agreed to be called and texted, when, to which wording, and for which number.
- Plan history and retentionResponses are kept forever. A plan shows a number of days of them, and older ones are hidden until a plan shows them again.
- Brand accessA workspace member can be limited to some brands. They, and the API keys they make, see only those brands.
- FilesFiles people upload with a form stay private. You read them with your API key, which gives you a short-lived download link.
- Owner-only and app-onlyA few endpoints act on the workspace itself or on money. Some need the workspace owner, and some only work from the app, never with an API key.
- Paid checksSome form features need the plan to include them. You need the plan to turn one on, but whatever is already on stays on.
- Webhook deliveriesEach new response is POSTed to a brand's or form's webhooks as signed JSON, with retries.
- Export columnsExports turn a form's responses into spreadsheet rows. Every way to export uses the same columns.
- AI builds and fixesAI can build a form from a description or fix a draft's errors. While it works, the form's draft is locked.