openapi.json

{
    "openapi": "3.0.0",
    "info": {
      "version": "0.1.0.0",
      "title": "ZkFold Prover API",
      "description": "ZkFold Prover API"
    },
    "servers": [
      {
        "url": "http://localhost:8080",
        "description": "Local server"
      }
    ],
    "paths": {
      "/prove": {
        "post": {
          "summary": "Prove API",
          "description": "Endpoint for creating a zero-knowledge proof",
          "requestBody": {
            "content": {
              "application/octet-stream": {
                "schema": {
                  "type": "string",
                  "format": "byte"
                }
              }
            },
            "required": true,
            "description": "Setup and Witness data in byte strings"
          },
          "responses": {
            "200": {
              "description": "Proof created successfully",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/ProveAPIResult"
                  }
                }
              }
            },
            "400": {
              "description": "Invalid input"
            }
          }
        }
      }
    },
    "components": {
      "schemas": {
        "ProveAPIResult": {
          "type": "object",
          "properties": {
            "status": {
              "type": "string"
            },
            "data": {
              "type": "string",
              "format": "byte"
            },
            "message": {
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "example": {
            "status": "success",
            "data": "base64encodedbytestring"
          }
        }
      }
    }
  }