Upload a source DOCX or playbook

POST /uploads

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Body

fileName string Required
mimeType string Required
purpose string Required
One of source_doc playbook
contentBase64 string Required

Returns

error object
Show 3 fields
- code string
  One of SUBSCRIPTION_PAYMENT_REQUIRED
- message string
  One of Your last payment didn't go through. Update your payment method to keep using Scaffold.
- details object
  Show 1 field
  - reason string
    One of payment

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/uploads" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{"fileName":"text","mimeType":"text","purpose":"source_doc","contentBase64":"text"}'

const response = await fetch("https://api.scaffoldyourdocs.com/uploads", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fileName":"text","mimeType":"text","purpose":"source_doc","contentBase64":"text"})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/uploads",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={"fileName": "text", "mimeType": "text", "purpose": "source_doc", "contentBase64": "text"},
)

Response (shape)

{
  "error": {
    "code": "SUBSCRIPTION_PAYMENT_REQUIRED",
    "message": "Your last payment didn't go through. Update your payment method to keep using Scaffold.",
    "details": {
      "reason": "payment"
    }
  }
}