Markbase

Link copied to clipboard
Markbase is a one click publish platform that lets you automatically sync and publish local markdown content to unlimited hosted domains
You can view more interactive API Documentation with Postman here

πŸ“ Collection: Project

Link copied to clipboard
ListProjects
List all projects for a user
    "projects": [
        {
            "id": String,
            "slug": String,
            "name": String,
            "folderToShare": String,
            "publishedUrl": String,
            "repositoryUrl": String,
            "customCss": String,
            "customHeadJs": String,
            "customBodyJs": String,
            "public": Boolean,
            "metadata": {
                "id": String,
                "createdAt": String,
                "updatedAt": String"
            }
        }
    ]

Method: GET

Link copied to clipboard
https://api.markbase.xyz/projects/user
CreateProject
Create new project for a user

Method: POST

Link copied to clipboard
https://api.markbase.xyz/projects/user

Body formdata

Link copied to clipboard
ParamvalueType
slugStringtext
nameStringtext
folderToShareStringtext
zipFileBuffertext
CustomCSS
Apply custom css for a project

Method: POST

Link copied to clipboard
https://api.markbase.xyz/projects/user/custom-css

Body formdata

Link copied to clipboard
ParamvalueType
slugStringundefined
customCSSStringundefined
CustomHeadJS
Apply custom JS to the head for a project

Method: POST

Link copied to clipboard
https://api.markbase.xyz/custom-head-js

Body formdata

Link copied to clipboard
ParamvalueType
slugStringundefined
customHeadJSStringundefined
CustomBodyJS
Apply custom JS to the body for a project

Method: POST

Link copied to clipboard
https://api.markbase.xyz/projects/user/custom-body-js

Body formdata

Link copied to clipboard
ParamvalueType
slugStringundefined
customBodyJSStringundefined
CustomDomain
Apply a custom domain for a project

Method: POST

Link copied to clipboard
https://api.markbase.xyz/projects/user/custom-domain

Body formdata

Link copied to clipboard
ParamvalueType
slugStringundefined
customDomainStringundefined
ProjectByID
Get a project by ID
    "projects": [
        {
            "id": String,
            "slug": String,
            "name": String,
            "folderToShare": String,
            "publishedUrl": String,
            "repositoryUrl": String,
            "customCss": String,
            "customHeadJs": String,
            "customBodyJs": String,
            "public": Boolean,
            "metadata": {
                "id": String,
                "createdAt": String,
                "updatedAt": String"
            }
        }
    ]

Method: GET

Link copied to clipboard
https://api.markbase.xyz/projects/id/:projectId
UpdateProjectById
Update a project by ID

Method: PUT

Link copied to clipboard
https://api.markbase.xyz/projects/id/:projectId
DeleteProjectById
Delete a project by ID

Method: DELETE

Link copied to clipboard
https://api.markbase.xyz/projects/id/:projectId
ProjectBySlug
Get project by Slug

Method: GET

Link copied to clipboard
https://api.markbase.xyz//projects/slug/:projectSlug
SyncProject
Sync a project's deployment with content and styles

Method: POST

Link copied to clipboard
https://api.markbase.xyz/projects/user/sync

Body formdata

Link copied to clipboard
ParamvalueType
slugStringundefined
fileBufferundefined

πŸ“ Collection: Stripe

Link copied to clipboard
Checkout
Proceed to checkout via stripe

Method: GET

Link copied to clipboard
https://api.markbase.xyz/stripe/checkout?priceId=String

Query Params

Link copied to clipboard
Paramvalue
priceIdString
Subscriptions
Get active subscriptions for user

Method: GET

Link copied to clipboard
https://api.markbase.xyz/stripe/subscriptions
SubscriptionById
Get subscription by ID

Method: GET

Link copied to clipboard
https://api.markbase.xyz/stripe/subscriptions/:subscriptionId
Session
Get Stripe checkout session

Method: GET

Link copied to clipboard
https://api.markbase.xyz/stripe/portal

πŸ“ Collection: User

Link copied to clipboard
CreateUser
Create a new User if it does not exist

Method: POST

Link copied to clipboard
https://api.markbase.xyz/user
UserInfo
Get info for a user

Method: GET

Link copied to clipboard
https://api.markbase.xyz/user/me
UserFeedback
Publish user feedback

Method: POST

Link copied to clipboard
https://api.markbase.xyz/user/feedback
UserOnboarding
Send user a onboarding email

Method: POST

Link copied to clipboard
https://api.markbase.xyz/user/onboarding

πŸ“ Collection: Token

Link copied to clipboard
TokenObsidian
Get Obsidian Token

Method: GET

Link copied to clipboard
https://api.markbase.xyz/token/obsidian
TokenObsidianVerify
Verify obsidian token

Method: GET

Link copied to clipboard
https://api.markbase.xyz/token/obsidian/verify