Formgong API

openapi: 3.1.0
info:
  title: Formgong API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 6 operation(s) read from 14 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Formgong has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 3
    pages-with-code: 8
    pages-read: 14
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://formgong.com/en/docs/v0
  - https://formgong.com/en/contact-form-api
  - https://formgong.com/en/form-endpoint
  - https://formgong.com/en/for/next
  - https://formgong.com/llms-full.txt
  - https://formgong.com/en/docs/cursor
  - https://formgong.com/en/docs/store-connection
  - https://formgong.com/en/integrations/webhooks
  - https://formgong.com/en/website-templates/averin
  - https://formgong.com/en/website-templates/burrow
  - https://formgong.com/en/website-templates/selune
  - https://formgong.com/en/website-templates/contour
  - https://formgong.com/en/website-templates/ai-prompts/restaurant
  - https://formgong.com/en/docs/lovable
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://formgong.com/en/form-endpoint
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl from a connection in Turkey. The browser check ran in Chromium on a page at example.com. We keep every raw answer and will\
          \ send them to anyone who asks. \n FormSubmit answered every request with Cloudflare error 521, which means its own server did not respond.\
          \ We tried again 30 minutes later, and from a second network in Germany. Its home page returned 521 as well. That is an outage, not\
          \ an an"
  /api/orders:
    post:
      operationId: post_api_orders
      tags:
      - Api
      summary: POST /api/orders
      x-source: https://formgong.com/llms-full.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiOrdersRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://formgong.com/api/orders  -H \"Authorization: Bearer fgp_YOUR_STORE_TOKEN\"  -H \"Content-Type: application/json\"\
          \  -d '{\n \"site\": \"fk_your_reviews_key\",\n \"order_id\": \"1001\",\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Emma\"\
          ,\n \"lang\": \"en\",\n \"completed_at\": \"2026-10-22T10:00:00Z\",\n \"country\": \"DE\",\n \"marketing_consent\": true,\n \"items\"\
          : [\n { \"product_id\": \"42\", \"name\": \"Linen apr"
  /api/orders/cancel:
    post:
      operationId: post_api_orders_cancel
      tags:
      - Api
      summary: POST /api/orders/cancel
      x-source: https://formgong.com/llms-full.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiOrdersCancelRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://formgong.com/api/orders/cancel  -H \"Authorization: Bearer fgp_YOUR_STORE_TOKEN\"  -H \"Content-Type: application/json\"\
          \  -d '{ \"site\": \"fk_your_reviews_key\", \"order_id\": \"1001\", \"reason\": \"refunded\" }' \n reason is \"refunded\" or \"cancelled\"\
          \ . The answer is {\"status\":\"cancelled\"} , or {\"status\":\"not_waiting\"} when nothing was waiting."
  /mcp:
    post:
      operationId: post_mcp
      tags:
      - Mcp
      summary: MCP server endpoint for JSON‑based tool calls (initialize, ping, tools/list, etc.).
      x-source: https://formgong.com/llms-full.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /pow:
    get:
      operationId: get_pow
      tags:
      - Pow
      summary: Proof‑of‑work endpoint used by the spam protection system.
      x-source: https://formgong.com/llms-full.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /submit:
    post:
      operationId: post_submit
      tags:
      - Submit
      summary: 'Plain HTML: <form action="https://formgong.com/submit" method="POST">.'
      description: Submit a form directly to Formgong. Accept header should be application/json and response contains a JSON object with a success
        boolean and a message.
      x-source: https://formgong.com/en/docs/v0
      parameters:
      - name: access_key
        in: query
        required: true
        schema:
          type: string
        description: Public access key (fk_...).
      - name: _lang
        in: query
        required: true
        schema:
          type: string
        description: Page language code, e.g. "en".
      - name: name
        in: query
        required: true
        schema:
          type: string
        description: Name of the submitter.
      - name: email
        in: query
        required: true
        schema:
          type: string
        description: Email address of the submitter.
      - name: message
        in: query
        required: true
        schema:
          type: string
        description: Message content.
      - name: phone
        in: query
        required: false
        schema:
          type: string
        description: Optional phone number.
      - name: botcheck
        in: query
        required: false
        schema:
          type: string
        description: Honeypot field; should be left empty.
      - name: _redirect
        in: query
        required: false
        schema:
          type: string
        description: Optional URL to redirect after successful submission.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSubmitRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSubmitResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiOrdersRequest:
      type: object
      properties:
        site:
          type: string
        order_id:
          type: string
        email:
          type: string
        first_name:
          type: string
        lang:
          type: string
        completed_at:
          type: string
          format: date-time
        country:
          type: string
        marketing_consent:
          type: boolean
        items:
          type: array
          items:
            type: object
            properties:
              product_id:
                type: string
              name:
                type: string
              url:
                type: string
              image:
                type: string
    PostApiOrdersCancelRequest:
      type: object
      properties:
        site:
          type: string
        order_id:
          type: string
        reason:
          type: string
    PostSubmitRequest:
      type: object
      properties:
        access_key:
          type: string
        _lang:
          type: string
        name:
          type: string
        email:
          type: string
        message:
          type: string
        phone:
          type: string
        botcheck:
          type: string
        _redirect:
          type: string
      required:
      - access_key
      - _lang
      - name
      - email
      - message
    PostSubmitResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the submission was processed successfully.
        message:
          type: string
          description: Human‑readable message about the result.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Mcp
- name: Pow
- name: Submit