Skip to content

API and AI connector

Read responses from your own systems, create forms from code, send new responses to a webhook, or let Claude and ChatGPT work with your forms. Available on the Pro and Business plans.

API keys

Create a key in Settings → API & connectors. A key belongs to one workspace (personal or a team) and acts as the person who made it: it can never do more than they can, and it stops working if they leave the team. The key is shown once; store it as a secret. Send it on every request:

curl https://form-app.edesy.in/api/v1/me \
  -H "Authorization: Bearer efk_your_key"

Permissions (scopes)

Give each key only what it needs.

  • forms:read: See your forms and their questions
  • forms:write: Create forms and change them
  • responses:read: Read responses
  • responses:delete: Delete responses
  • webhooks:write: Add and remove webhooks

A key without the scope gets 403 insufficient_scope. A team editor's key can never delete responses, whatever its scopes.

Endpoints

Base URL https://form-app.edesy.in/api/v1. The full description is at /api/v1/openapi.json (OpenAPI 3.1).

MethodPathScopeWhat it does
GET/me—The key, its permissions and its workspace
GET/formsforms:readThe workspace's forms, newest first
POST/formsforms:writeCreate a form, with questions, and publish it
GET/forms/{id}forms:readA form and its questions
GET/forms/{id}/responsesresponses:readResponses, with filters and search
GET/forms/{id}/responses/{responseId}responses:readOne response
DELETE/forms/{id}/responses/{responseId}responses:deleteDelete a response and its files
GET/forms/{id}/webhooksforms:readA form's webhooks
POST/forms/{id}/webhookswebhooks:writeSend new responses to a URL
DELETE/forms/{id}/webhooks/{webhookId}webhooks:writeRemove a webhook

Reading responses

Answers are keyed by each question's key (its URL key, from GET /forms/{id}). File answers come as { name, size, type, downloadUrl }, where downloadUrl is a signed link valid for 7 days.

curl "https://form-app.edesy.in/api/v1/forms/FORM_ID/responses?since=2026-11-01T00:00:00Z&limit=50" \
  -H "Authorization: Bearer efk_your_key"

Filter with filters: a base64url-encoded JSON array in the same format as the responses page, for example [{"field":"QUESTION_ID","op":"between","min":100000}] or [{"meta":"status","op":"in","values":["NEW"]}].

Pagination

Lists return { data, nextCursor }. Pass nextCursor back as cursor for the next page; it is null on the last page. limit is 1–100 (default 25).

Creating a form

curl -X POST https://form-app.edesy.in/api/v1/forms \
  -H "Authorization: Bearer efk_your_key" -H "Content-Type: application/json" \
  -d '{"title":"Workshop sign-up","publish":true,"draft":{"fields":[
        {"type":"text","label":"Full name","required":true},
        {"type":"email","label":"Email","required":true},
        {"type":"select","label":"Session","options":["Morning","Afternoon"]}]}}'

Webhooks

POST /forms/{id}/webhooks with { "url": "https://…", "headers": { "X-Secret": "…" } } sends every new response to your URL as JSON. Only https and public addresses are accepted. Headers are stored but never shown again.

Rate limits and errors

Each key may make 120 requests a minute on Pro and 600 on Business. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; over the limit you get 429 with Retry-After.

Errors look like { "error": { "code": "not_found", "message": "Form not found." } }. Forms outside the key's workspace are always 404.

Connect Claude or ChatGPT (MCP)

Edesy Forms works as an MCP connector, so an AI assistant can list your forms, create new ones and read and summarise responses, for example “summarise last week's NPS responses”.

  1. In Claude, open Settings → Connectors → Add custom connector (in ChatGPT, add it as a connector in developer mode).
  2. Enter the URL https://form-app.edesy.in/api/mcp.
  3. Sign in to Edesy Forms when asked, choose the workspace and what the assistant may do, and allow it.

You can see and disconnect connected apps in Settings → API & connectors.

API and AI connector · Edesy Forms