💎Technical PDF Maker💎 Reports & Research · GPT Actions

{
  "openapi": "3.1.0",
  "info": {
    "title": "Ofia Handoff API",
    "description": "Stores a document brief from a ChatGPT conversation and returns a continuation URL that drops the user straight into a pre-filled Ofia trial.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://ofia.app/api",
      "description": "Ofia production API"
    }
  ],
  "paths": {
    "/gpt/handoff": {
      "post": {
        "operationId": "createHandoff",
        "summary": "Store a document brief and get a continuation URL",
        "description": "Call this when you have gathered enough requirements from the user. Returns a short URL (valid 7 days) that opens directly into a pre-filled Ofia trial — no intake questionnaire, drafting starts immediately.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "document_title",
                  "user_requirements",
                  "document_uploaded"
                ],
                "properties": {
                  "document_title": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 300,
                    "description": "A clean descriptive title for the document (e.g. 'Competitive Intelligence Brief: Google Quantum Computing Patent Strategy'). This becomes the project name in Ofia."
                  },
                  "user_requirements": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20000,
                    "description": "A dense structured brief (150–400 words) covering document type, audience, tone, core argument, key sections, specific content, and any open questions for Ofia's agent to clarify. Be specific — this is what Ofia's AI will use to draft the document."
                  },
                  "document_uploaded": {
                    "type": "boolean",
                    "description": "Set to true if the user mentioned having an existing document, notes, or data file they want to base this on. Ofia will prompt them to upload it."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Handoff created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string",
                      "description": "The continuation URL to give the user. Opening it starts a fresh Ofia trial pre-filled with their brief. Valid for 7 days."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request body."
          },
          "401": {
            "description": "Missing or invalid API key."
          },
          "429": {
            "description": "Rate limit exceeded. Retry shortly."
          }
        }
      }
    }
  }
}