curl -sS -X POST "http://localhost:3001/api/v1/artifacts" \
-H "Authorization: Bearer $FACTROVE_API_KEY" \
-F "file=@./fixtures/hello.html"import { readFile } from "node:fs/promises";
const bytes = await readFile("./fixtures/hello.html");
const htmlBlob = new Blob([bytes], { type: "text/html" });
const form = new FormData();
form.append("file", htmlBlob, "hello.html");
const response = await fetch("http://localhost:3001/api/v1/artifacts", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.FACTROVE_API_KEY}` },
body: form,
});import os
import requests
with open("./fixtures/hello.html", "rb") as handle:
response = requests.post(
"http://localhost:3001/api/v1/artifacts",
headers={"Authorization": f"Bearer {os.environ['FACTROVE_API_KEY']}"},
files={"file": ("hello.html", handle, "text/html")},
){
"artifact": {
"id": "11111111-1111-4111-8111-111111111111",
"creatorUserId": "user_example",
"organizationId": null,
"accessType": "private",
"filename": "11111111-1111-4111-8111-111111111111.html",
"name": "hello",
"mimeType": "text/html",
"sizeBytes": 527,
"createdAt": "2026-10-21T12:00:00.000Z",
"updatedAt": "2026-10-21T12:00:00.000Z",
"uploadedAt": "2026-10-21T12:00:00.000Z",
"viewerUrl": "http://localhost:3000/artifacts/11111111-1111-4111-8111-111111111111",
"contentUrl": "http://localhost:3001/api/v1/artifacts/11111111-1111-4111-8111-111111111111/content",
"shared": false,
"passwordProtected": false
}
}Upload an HTML file
Accepts one non-empty .html or .htm file as multipart field file, optional accessType (private default, or org_shared), and optional name. name is one line of 1 to 120 characters. When name is omitted, the stored name is the file name without .html or .htm when that stem is one line of 1 to 120 characters. An empty stem, a stem longer than 120 characters, or a stem that is not one line stores null, and the upload still succeeds. An invalid submitted name is 400 INVALID_REQUEST and stores no row. The backend assigns text/html. Maximum size is 10 MiB. Each request creates a new artifact. The object is written first, then the row. A storage failure leaves no row. Cookie-authenticated writes also require Origin or Referer to be WEB_ORIGIN or PUBLIC_BASE_URL.
curl -sS -X POST "http://localhost:3001/api/v1/artifacts" \
-H "Authorization: Bearer $FACTROVE_API_KEY" \
-F "file=@./fixtures/hello.html"import { readFile } from "node:fs/promises";
const bytes = await readFile("./fixtures/hello.html");
const htmlBlob = new Blob([bytes], { type: "text/html" });
const form = new FormData();
form.append("file", htmlBlob, "hello.html");
const response = await fetch("http://localhost:3001/api/v1/artifacts", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.FACTROVE_API_KEY}` },
body: form,
});import os
import requests
with open("./fixtures/hello.html", "rb") as handle:
response = requests.post(
"http://localhost:3001/api/v1/artifacts",
headers={"Authorization": f"Bearer {os.environ['FACTROVE_API_KEY']}"},
files={"file": ("hello.html", handle, "text/html")},
){
"artifact": {
"id": "11111111-1111-4111-8111-111111111111",
"creatorUserId": "user_example",
"organizationId": null,
"accessType": "private",
"filename": "11111111-1111-4111-8111-111111111111.html",
"name": "hello",
"mimeType": "text/html",
"sizeBytes": 527,
"createdAt": "2026-10-21T12:00:00.000Z",
"updatedAt": "2026-10-21T12:00:00.000Z",
"uploadedAt": "2026-10-21T12:00:00.000Z",
"viewerUrl": "http://localhost:3000/artifacts/11111111-1111-4111-8111-111111111111",
"contentUrl": "http://localhost:3001/api/v1/artifacts/11111111-1111-4111-8111-111111111111/content",
"shared": false,
"passwordProtected": false
}
}Authorizations
Factrove API key, usually prefixed ftrv_. Send Authorization: Bearer <key>. Product routes do not accept x-api-key as a credential. A present Authorization header that is not a valid key does not fall back to the session cookie.
Body
One file, an optional access type, and an optional library name.
One non-empty .html or .htm file, at most 10 MiB.
private, org_shared Library name. Normalized to NFC, then trimmed. One line of 1 to 120 Unicode code points. U+0000–U+001F, U+007F–U+009F, U+2028, and U+2029 are rejected before trimming, so a trailing break is not removed. An invalid value is 400 INVALID_REQUEST with message name must be one line of 1 to 120 characters.
1 - 120Response
The new artifact.
Show child attributes
Show child attributes