AidaForm API
Community OpenAPI document · agent-readyProductivityForms SurveysapiKey3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
List AidaForm forms, list the responses for a given form, and download an individual response in PDF, JSON, XLSX, HTML, or CSV.
Use for: List all forms in my AidaForm workspace, Retrieve responses submitted to a specific form in the last 24 hours, Download a particular AidaForm response as a PDF for an audit trail, Export a response in CSV format and load it into a spreadsheet
Not supported: Does not handle form creation, form editing, or webhook subscriptions - use for reading forms and responses only.
AidaForm is a SaaS platform for building online forms, quizzes, and landing pages and collecting structured responses from end users. The API exposes read access to forms and their responses, including a download endpoint that returns a single response in PDF, JSON, XLSX, HTML, or CSV format. Authentication uses an API key passed in the Authorization header. The surface is small and read-focused, suitable for syncing AidaForm responses into downstream tools.
Install Jentic One Beta
Connect the AidaForm API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AidaForm API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Faidaform.com%2Faidaform" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Faidaform.com%2Faidaform" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with AidaForm API.
List every form in an AidaForm account through GET /forms
Page through responses for a specific form filtered by from and to timestamps via GET /forms/{formId}/responses
Download a single response as PDF, JSON, XLSX, HTML, or CSV using the format path parameter
Sync new form submissions into a CRM or warehouse by polling the response list with marker-based pagination
Export historic responses for archival or analytics from a finite set of read-only endpoints
Use Cases
Patterns agents use AidaForm API for, with concrete tasks.
★ Sync Form Responses to a CRM
Poll the AidaForm API for new responses on lead-capture forms and push each entry into a CRM. Use GET /forms to enumerate active forms, then GET /forms/{formId}/responses with from and to timestamps to fetch only fresh entries. Marker-based pagination keeps the sync resilient across runs.
List forms, then for each form GET /forms/{formId}/responses with from set to the last sync timestamp and write each entry to the CRM
Archive Responses as PDF
Generate a permanent PDF of every submitted response for compliance, audit, or signed-record use cases. Call /forms/{formId}/responses/{responseId}.pdf for each new submission and store the resulting PDF in object storage with a stable filename.
For each new response id, call GET /forms/{formId}/responses/{responseId}.pdf and upload the returned PDF to S3 with the response id as the key
Spreadsheet Export for Analytics
Send form responses into a spreadsheet workflow without manual export by hitting the .csv or .xlsx variant of the response download endpoint. Useful when an analyst expects raw data files in a shared drive rather than a database.
GET /forms/{formId}/responses, then GET each /forms/{formId}/responses/{responseId}.csv and write the bytes to a shared drive path
Agent-Driven Lead Triage via Jentic
An agent watches AidaForm for new responses, classifies them by content, and routes urgent leads to a Slack channel. Through Jentic the agent searches for the response listing operation, the API key is supplied from the vault, and pagination is handled in the tool call. The agent never sees the raw key.
Use Jentic search 'list responses for an AidaForm form', execute /forms/{formId}/responses with from set to now-1h, and forward each entry to a Slack webhook
Key Endpoints
3 endpoints — aidaform is a saas platform for building online forms, quizzes, and landing pages and collecting structured responses from end users.
METHOD
PATH
DESCRIPTION
GET
/forms
List forms in the workspace
GET
/forms/{formId}/responses
List responses for a form with timestamp filters
GET
/forms/{formId}/responses/{responseId}.{format}
Download a response as PDF, JSON, XLSX, HTML, or CSV
GET
/forms
List forms in the workspace
GET
/forms/{formId}/responses
List responses for a form with timestamp filters
GET
/forms/{formId}/responses/{responseId}.{format}
Download a response as PDF, JSON, XLSX, HTML, or CSV
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring AidaForm by hand means handling its API-key header, paging through form responses with from, to, and marker parameters, and building your own retry logic. Through Jentic you install once, import AidaForm from the API Directory, store the key once, and your agent calls it.
Permission scoping
AidaForm puts the form id in the URL path (/forms/{formId}/responses), so a rule can pin your agent to one form: it reads that form's responses and nothing else. This API is read-only for forms and responses, so the agent only lists and fetches, never edits.
Credential isolation
Your AidaForm API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list new form responses', and Jentic returns the AidaForm /forms/{formId}/responses operation with its from, to, and marker schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using AidaForm API through Jentic.
What authentication does the AidaForm API use?
An apiKey scheme named ApiKeyAuth, sent in the Authorization header. Through Jentic the key is held in the vault and injected at execution time, so it never enters the agent's context.
Can I download a response in CSV or PDF?
Yes. GET /forms/{formId}/responses/{responseId}.{format} where format is pdf, json, xlsx, html, or csv. The endpoint returns the response in the requested format directly.
What are the rate limits for the AidaForm API?
The OpenAPI spec does not declare rate limits. Use the from, to, limit, and marker query parameters on /forms/{formId}/responses to keep response volume controlled and to make polling idempotent.
How do I sync AidaForm responses through Jentic?
Run pip install jentic, search 'list new responses for a form', execute /forms/{formId}/responses with from set to your last sync time, then iterate using the marker cursor. Run it through Jentic One, the self-hosted execution layer.
Does the API support creating or editing forms?
No. The current spec exposes read-only access: list forms, list responses, and download a single response. Create and edit operations must be done in the AidaForm UI.
How do I list all forms in my workspace?
GET /forms returns a FormsListResponse containing every form id in the workspace. Use this as the entry point for listing responses on each form.
Can I limit what my agent is allowed to do with the AidaForm API?
Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, and the AidaForm API is read-only, so the agent can only list forms with GET /forms, list responses with GET /forms/{formId}/responses, and download a single response, never create or edit anything. Since the form id sits in the URL path, you can pin the agent to a single form so it reads that form's responses and nothing else. Your API key is stored by your own instance and injected at execution time, so it never enters the agent's prompt or context.
GET STARTED