Document → Convert
AI-generatedSummary
Convert a document into a quiz or form in the selected output format
Inputs
- format (required) — Where to send the converted quiz. Pick Google Forms to create a live form in Drive, or an LMS / quiz platform to receive an importable file.
- source — Whether the input is a Google Doc URL or a publicly accessible file URL.
- documentId (required) — A Google Doc, Sheet, or Slides URL — or just the document ID. The document must be shared with the Formswrite service account email (find it in Settings → Integrations).
- fileUrl (required) — Public HTTPS link to a PDF, DOCX, XLSX, PPTX, or image file (max 10 MB). Redirects are not followed — provide a direct link such as an S3 presigned URL.
- documentName — Optional name for the resulting quiz or export file. Defaults to the source document's title.
- requestOptions — HTTP request configuration options such as batching, interval, proxy, SSL verification, and timeout.
- allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible.
- proxy — HTTP proxy to use, optionally with authentication (e.g., http://username:password@myproxy:3128).
- timeout — Time in ms to wait for the server to send response headers before aborting the request.
Output shape
a JSON object representing the created quiz or exported file
Returns success data with details such as ID or URL; errors are wrapped in an error envelope. No pagination.
Examples
Example 1: Create a Google Form quiz from a Google Doc
format=google_form, source=google, documentId=https://docs.google.com/document/d/1A2B3C4D5E6F7G8H9I, documentName=My Quiz
Example 2: Convert a public PDF into a Moodle XML quiz
format=moodle, source=file, fileUrl=https://example.com/quiz.pdf, documentName=Sample Quiz
Example 3: Batch convert documents with custom batch settings
format=canvas, requestOptions={batch:{batchSize=25, batchInterval=500}}, proxy=http://proxy.example.com:8080