---
agentTools:
  projectIndex: https://nexaflow.readme.io/llms.txt
---

# Submit a form

API to submit a form. All the responses of the form will be stored and shown in our platform.
Note: Users can download the response in CSV format.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "This is the documentation for the CMS API",
    "version": "1.0.0",
    "title": "CMS Documentation"
  },
  "tags": [
    {
      "name": "form",
      "description": "Form APIs"
    }
  ],
  "paths": {
    "/form/{formId}": {
      "post": {
        "tags": [
          "form"
        ],
        "summary": "Submit a form",
        "description": "API to submit a form. All the responses of the form will be stored and shown in our platform.\nNote: Users can download the response in CSV format.\n",
        "operationId": "submitForm",
        "parameters": [
          {
            "name": "formId",
            "in": "path",
            "description": "Form ID given by the platform",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "description": "Form data",
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid status value"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "externalDocs": {
    "description": "Find out more about Swagger",
    "url": "http://swagger.io"
  },
  "servers": [
    {
      "url": "https://api.nexaflow.xyz/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 95,
      "2": 49,
      "3": 0,
      "4": 6,
      "5": 159,
      "6": 138,
      "7": 0,
      "8": 30,
      "9": 188,
      "10": 93,
      "11": 185
    }
  }
}
```