Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Factrove home page

Overview

API overview

Health

GET
Check that the API is initialized

Auth

GET
Return the caller and current organization
POST
Create an account with email and password
POST
Sign in with email and password
POST
Create an API key
GET
List API keys for the session
POST
Revoke an API key

Artifacts

GET
List artifacts for the caller
POST
Upload an HTML file
GET
Download artifact HTML or converted Markdown
PUT
Replace an artifact's stored HTML
GET
Get artifact metadata
DEL
Delete an artifact
PATCH
Share a private artifact with the confirmed organization
PATCH
Rename an artifact

Shares

GET
Read the owner share state
POST
Create or update a public share
DEL
Revoke the public share
DEL
Remove the password from a shared link

Public

GET
Read a public share
POST
Unlock a password-protected share
GET
Download public share HTML

{
  "status": "ok"
}

Health

Check that the API is initialized

Returns { status: "ok" } after the process has started. No credentials.

GET

/

api

/

v1

/

health

{
  "status": "ok"
}

Response

200 - application/json

The API is initialized.

status

string

required

Allowed value: "ok"

Return the caller and current organization

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform