← Files RapidNativeARCHIVED FILE

openapi.json

10.3 KB · Nov 17, 2026 · 19:42 UTC

↓ Download file

{
  "openapi": "3.1.0",
  "info": {
    "title": "RapidNative",
    "description": "Build and deploy React Native & web apps from ChatGPT. Describe your idea, get a live working app with a preview URL.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://rapidnative.com/api/plugin"
    }
  ],
  "paths": {
    "/create-project": {
      "post": {
        "operationId": "createProject",
        "summary": "Create a new app project and start building it with AI",
        "description": "Creates a new RapidNative project and automatically starts the AI coding agent to build the app based on the provided prompt. Returns a project with a live preview URL.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["name", "prompt"],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name for the project (e.g. 'My Todo App')"
                  },
                  "description": {
                    "type": "string",
                    "description": "Brief description of what the app does"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "Detailed prompt describing the app to build. Include features, design preferences, and specific requirements."
                  },
                  "componentBase": {
                    "type": "string",
                    "enum": ["fullstack-supabase", "fullstack"],
                    "default": "fullstack-supabase",
                    "description": "Project template. 'fullstack-supabase' includes a database."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Project created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": { "type": "boolean" },
                    "project": {
                      "type": "object",
                      "properties": {
                        "id": { "type": "string" },
                        "kv_id": { "type": "string" },
                        "name": { "type": "string" },
                        "description": { "type": "string" }
                      }
                    },
                    "generation": {
                      "type": "object",
                      "properties": {
                        "started": { "type": "boolean" },
                        "message": { "type": "string" }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects": {
      "get": {
        "operationId": "listProjects",
        "summary": "List all projects for the current user",
        "responses": {
          "200": {
            "description": "Projects listed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": { "type": "boolean" },
                    "projects": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": { "type": "string" },
                          "kv_id": { "type": "string" },
                          "name": { "type": "string" },
                          "description": { "type": "string" },
                          "previewUrl": { "type": "string" },
                          "editorUrl": { "type": "string" },
                          "lastActivity": { "type": "string" }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects/{projectId}": {
      "get": {
        "operationId": "getProject",
        "summary": "Get details about a project",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "required": true,
            "schema": { "type": "string" },
            "description": "Project ID (UUID or kv_id)"
          }
        ],
        "responses": {
          "200": {
            "description": "Project details",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": { "type": "boolean" },
                    "project": {
                      "type": "object",
                      "properties": {
                        "id": { "type": "string" },
                        "kv_id": { "type": "string" },
                        "name": { "type": "string" },
                        "description": { "type": "string" },
                        "previewUrl": { "type": "string" },
                        "editorUrl": { "type": "string" }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects/{projectId}/generate": {
      "post": {
        "operationId": "editProject",
        "summary": "Edit a project by sending a follow-up prompt to the AI",
        "description": "Triggers the AI coding agent to make changes to an existing project. The AI loads the full conversation history and current files.",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "required": true,
            "schema": { "type": "string" },
            "description": "Project ID (UUID or kv_id)"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["prompt"],
                "properties": {
                  "prompt": {
                    "type": "string",
                    "description": "Describe the changes to make. Be specific about what to add, change, or remove."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Generation started",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": { "type": "boolean" },
                    "message": { "type": "string" },
                    "projectId": { "type": "string" }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects/{projectId}/files": {
      "get": {
        "operationId": "viewCode",
        "summary": "View the source code files of a project",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "required": true,
            "schema": { "type": "string" },
            "description": "Project ID (UUID or kv_id)"
          }
        ],
        "responses": {
          "200": {
            "description": "Project files",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": { "type": "boolean" },
                    "fileCount": { "type": "integer" },
                    "files": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "path": { "type": "string" },
                          "content": { "type": "string" },
                          "mimeType": { "type": "string" }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects/{projectId}/deploy": {
      "post": {
        "operationId": "deployProject",
        "summary": "Deploy a project as an Android APK",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "required": true,
            "schema": { "type": "string" },
            "description": "Project ID (UUID or kv_id)"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Optional deployment name"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Deployment created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": { "type": "boolean" },
                    "deployment": {
                      "type": "object",
                      "properties": {
                        "id": { "type": "string" },
                        "status": { "type": "string" }
                      }
                    },
                    "message": { "type": "string" }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "oauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://rapidnative.com/api/auth/chatgpt/authorize",
            "tokenUrl": "https://rapidnative.com/api/auth/chatgpt/token",
            "scopes": {
              "projects:read": "Read your projects",
              "projects:write": "Create and edit projects",
              "deploy": "Deploy projects"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth": ["projects:read", "projects:write", "deploy"]
    }
  ]
}

SHA-256: dc67fbcdee949bcba52a2ad833af96609c3468ffbbf22d8e78710ed56008b684