canonical: https://jentic.com/apis/beekai.com/beekai

# BEEKAI API

Jentic publishes the only available OpenAPI specification for BEEKAI API, keeping it validated and agent-ready. BEEKAI is a no-code form builder for collecting structured data from web visitors, customers, and survey respondents. The API is intentionally small with four endpoints across Forms and Submissions, letting integrations list and create forms and read or post submissions, secured by an API key sent in the Authorization header.

## For AI agents

List and create BEEKAI forms and read or submit form responses through a focused 4-endpoint forms-and-submissions API.

## Scope

Does not handle email delivery, payment collection, or advanced branching logic - use for creating forms and reading or submitting form responses only.

## Capabilities

- List all forms configured under the BEEKAI account
- Create a new form definition with fields and validation rules
- List submissions captured for a form with pagination
- Post a new submission to an existing form on behalf of a respondent

## Use cases

### Lead capture for marketing sites

Marketing teams use BEEKAI to publish lead-capture forms on landing pages and read the submissions into a CRM or email tool. POST /forms creates the form definition and GET /submissions returns the captured responses, letting an integration sync new leads into HubSpot, beehiiv, or a custom data warehouse on a schedule.

Example prompt: Create a lead-capture form named Spring Webinar Signup with name, email, and company fields, then poll /submissions every hour and forward new entries to a CRM

### Customer feedback collection

Product and CX teams collect open-ended feedback through a BEEKAI form embedded in-app or sent via email. The integration creates the form once with POST /forms, captures responses to /submissions, and downstream pipelines can summarise and tag the feedback. The minimal API surface keeps the integration cost low.

Example prompt: Read all submissions from the customer-feedback form filed in the past 14 days and produce a summary of common themes

### Server-side submission ingest

Some integrations need to record events as form submissions for downstream analysis even when no web form was rendered. POST /submissions accepts a payload against an existing form ID, letting backend services log structured records that share the same export pipeline as user-rendered submissions.

Example prompt: Post a submission to form fid_99 with payload source webhook and value 1, then confirm the submission count has incremented

### AI agent integration for forms and surveys

Marketing and ops teams use AI agents through Jentic to read recent BEEKAI submissions, route them to CRMs, and create new forms when campaigns spin up. The agent searches Jentic for the right BEEKAI operation, loads the schema, and executes with the API key held in your Jentic One instance, so the key never appears in agent context.

Example prompt: Through Jentic, find BEEKAI's submissions list operation and forward all new submissions for form fid_99 to a sales agent inbox once per hour

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/forms` | List forms |
| POST | `/forms` | Create a new form |
| GET | `/submissions` | List form submissions |
| POST | `/submissions` | Post a new submission |

## Key resources

- **Forms** — List and create form definitions
- **Submissions** — Read submissions captured against forms and post new submissions

## Why Jentic

- **Setup:** Wiring the BEEKAI API by hand means adding the API key to the Authorization header, learning the forms and submissions endpoints, and parsing the response payloads yourself. Through Jentic you install once, import the BEEKAI API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** BEEKAI exposes collection endpoints and takes its targets in the request body rather than as a resource in the URL path, so scope the agent to the operations it needs, such as listing forms or reading submissions. You choose that operation set, so creating forms or posting submissions are not included unless you add them.
- **Credential handling:** Your BEEKAI API key is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list form submissions' or 'create a contact form', and Jentic returns the matching BEEKAI operation with its input schema so the agent calls /forms or /submissions without browsing the reference docs.

## Related APIs

- **Typeform** — Conversational form builder with broader logic and design options than BEEKAI's minimal surface.
- **Tally** — Free-tier no-code form builder; alternative for cost-sensitive small projects.
- **Jotform** — Form builder with deep integration catalogue and HIPAA-eligible plans.

## FAQ

### Why is there no official OpenAPI spec for BEEKAI API?

BEEKAI does not publish an OpenAPI specification alongside its product docs. Jentic generates and maintains this spec so that AI agents and developers can call BEEKAI API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the BEEKAI API use?

BEEKAI uses an API key sent in the Authorization header on every request. Generate the key from your BEEKAI workspace settings. Jentic stores the key in its vault and injects the header at execution time so the key never enters agent context.

### Can I create a form programmatically with the BEEKAI API?

Yes. POST /forms accepts a form definition with fields and validation rules and returns a form ID you can embed on a site or reference when posting submissions. Use GET /forms to list existing forms.

### How do I read form submissions through Jentic?

Search Jentic for list BEEKAI form submissions to find GET /submissions. Load the schema and execute with the form ID and any pagination parameters. Pipe the results into a CRM sync or summarisation step.

### Does the BEEKAI API support server-side submissions?

Yes. POST /submissions accepts a payload against an existing form ID, so backend services can log structured records that share the same export pipeline as web-rendered submissions.

### What are the rate limits for the BEEKAI API?

BEEKAI does not publish explicit rate limits in the spec. If you receive HTTP 429 responses, back off and retry with exponential delay, and contact BEEKAI support if you need additional headroom for an aggressive sync job.

### Can I limit what my agent is allowed to do with the BEEKAI API?

Yes. Because Jentic One is self-hosted, you decide which BEEKAI operations your agent may call and which credentials it may use. BEEKAI exposes collection endpoints and takes its targets in the request body rather than in the URL path, so you can scope the agent to only the operations it needs, such as listing forms with GET /forms or reading submissions with GET /submissions. Since you choose that operation set, write actions like creating forms with POST /forms or posting submissions with POST /submissions are not available to the agent unless you add them.
