Skip to content
Super Artifacts
Sign inGet started for free

API endpoints

Every REST API endpoint, grouped by what it acts on, read from the OpenAPI document at build — with parameters and a request you can build and copy.

reference~2 minVerified v0.175.0

Every operation the REST API answers, read from its OpenAPI document when the docs are built. Open one for its parameters and a request built from the fields you fill in. The request reads your key from the SUPER_ARTIFACTS_KEY environment variable, so the key never goes into this page.

48 endpoints

Every command below sends its request here.

Account2

GET/v1/whoamiWho this key publishes as · super_whoami

Try it

Terminal
curl 'https://superartifacts.app/v1/whoami' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
GET/v1/helpHow the operations fit together · super_help

Parameters

topicquery
"tools" | "data" | "templates" | "collections" | "projects" | "batch"

Try it

Terminal
curl 'https://superartifacts.app/v1/help' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"

Artifacts11

GET/v1/artifactsList your artifacts, newest first · super_artifacts

Try it

Terminal
curl 'https://superartifacts.app/v1/artifacts' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/artifactsPublish an artifact, or a new version of one · super_publish

Parameters

slugbody, required
stringKebab-case, 3–63 chars, under your key’s handle: it updates one there you are Editor on. Another workspace’s artifact: publish from its dashboard.
promptbody, required
stringOne sentence on why; shown in the gallery.
htmlbody
stringComplete self-contained index.html.
valuesbody
objectFilled slots for template's runtime, by slot name; json slots are schema-checked.
instancesbody
array of objectInstead of slug/values: several pages of one template.
templatebody
objectThe template built from (provenance); required with values or instances.
titlebody
stringUnder 60 chars. Default: page <title>.
descriptionbody
stringLink-preview sentence, under 200 chars. Default: prompt.
kindbody
"page" | "slideshow" | "survey" | "tracker" | "video" | "tool" | "dashboard"Default page. dashboard labels a page of mostly live data.
collectionbody
stringGallery grouping label, not a content collection.
visibilitybody
"private" | "organization"From version 1. Default: the workspace default; public is set after.
policybody
objectData policy v1. Visitors submit to a sheet (perUser single, upsert, a field per question), a log (many, append-only) or a shared doc (shared, key). CMS rows: collections. See super_help data.
datasetbody
stringWith values: overrides the declaration's dataset.key.
continuesbody
stringWith values: the dataset key this one succeeds.
uploadsbody
stringuploadId from super_upload; its files ship with the page.
valuesFilebody
stringWith uploads: the staged JSON file to read values from.
filesbody
array of objectWith html: small assets. ≤200, 5 MiB each, 10 MiB total, decoded.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"slug":"","prompt":""}'
GET/v1/artifacts/{artifact}One artifact: its versions, published version and declaration · super_artifacts

Parameters

artifactpath, required
stringArtifact id or slug.

Try it

Terminal
curl 'https://superartifacts.app/v1/artifacts/{artifact}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
PATCH/v1/artifacts/{artifact}Change visibility, gallery label, live phase or submission email · super_artifact_set

Parameters

artifactpath, required
stringArtifact id or slug.
visibilitybody
"private" | "organization" | "public"private: Restricted (default). organization: anyone at the workspace. public: anyone with the link.
collectionbody
stringGallery grouping label, ≤ 60 chars. Empty clears it.
phasebody
stringThe name a stream’s revealAt waits for; from then on that stream reads as public.
notifyOnSubmissionbody
boolean

Try it

Terminal
curl -X PATCH 'https://superartifacts.app/v1/artifacts/{artifact}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
DELETE/v1/artifacts/{artifact}Delete an artifact with every version, permanently · super_artifact_set

Parameters

artifactpath, required
stringArtifact id or slug.
confirmquery, required
stringRepeat the artifact: deleting is permanent.

Try it

Terminal
curl -X DELETE 'https://superartifacts.app/v1/artifacts/{artifact}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
GET/v1/artifacts/{artifact}/fileRead one file of a version as text (default: the published index.html) · super_artifacts

Parameters

artifactpath, required
stringArtifact id or slug.
pathquery
string
versionquery
integer

Try it

Terminal
curl 'https://superartifacts.app/v1/artifacts/{artifact}/file' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/artifacts/{artifact}/openA ten-minute viewer URL for an artifact, private included · super_artifacts

Parameters

artifactpath, required
stringArtifact id or slug.
versionbody
integer

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts/{artifact}/open' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
POST/v1/artifacts/{artifact}/versions/{version}/serveServe an existing version again · super_artifact_set

Parameters

artifactpath, required
stringArtifact id or slug.
versionpath, required
integer

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts/{artifact}/versions/{version}/serve' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/artifacts/{artifact}/liveTurn an artifact's live room on · super_artifact_set

Parameters

artifactpath, required
stringArtifact id or slug.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts/{artifact}/live' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
DELETE/v1/artifacts/{artifact}/liveTurn an artifact's live room off, disconnecting every visitor · super_artifact_set

Parameters

artifactpath, required
stringArtifact id or slug.

Try it

Terminal
curl -X DELETE 'https://superartifacts.app/v1/artifacts/{artifact}/live' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/uploadsStage big files for a publish; PUT each to its URL · super_upload

Parameters

filesbody, required
array of object

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/uploads' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"files":[]}'

Data5

GET/v1/artifacts/{artifact}/dataRows visitors submitted to one artifact, newest first · super_data

Parameters

artifactpath, required
stringArtifact id or slug.
filterquery
array of stringANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= contains in, is set, is unset. System: _version _at _status _visitor.
sincequery
stringISO-8601 instant or window (7d, 24h). Or a version (v2) when addressing one artifact.
untilquery
string
sortquery
"newest" | "oldest"By collection time.
limitquery
integerPer artifact. Default 50.
cursorquery
stringThe previous cursor.next.
fieldsquery
array of string

Try it

Terminal
curl 'https://superartifacts.app/v1/artifacts/{artifact}/data' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/artifacts/{artifact}/data/rowsWrite rows into an artifact you may edit · super_data_write

Parameters

artifactpath, required
stringArtifact id or slug.
streambody
string
rowsbody
array of object
opsbody
array of object
atomicbody
boolean

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts/{artifact}/data/rows' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
GET/v1/dataRows submitted to a dataset or a gallery label · super_data

Parameters

datasetquery
string
collectionquery
stringThe gallery grouping label set at publish, case-sensitive. Not a content collection.
filterquery
array of stringANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= contains in, is set, is unset. System: _version _at _status _visitor.
sincequery
stringISO-8601 instant or window (7d, 24h). Or a version (v2) when addressing one artifact.
untilquery
string
sortquery
"newest" | "oldest"By collection time.
limitquery
integerPer artifact. Default 50.
cursorquery
stringThe previous cursor.next.
fieldsquery
array of string

Try it

Terminal
curl 'https://superartifacts.app/v1/data' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/data/queryAggregate what was collected: numbers, never rows · super_data_query

Parameters

scopebody
objectThe union of the forms given.
measuresbody
array of stringCatalog measure names, not field names.
aggbody
"sum" | "avg" | "min" | "max" | "count" | "last"
computebody
array of objectDerived columns, in order; operands name a measure or an earlier as.
filterbody
array of stringANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= in. Catalog fields only.
group_bybody
array of stringOne of dataset, day, week, month, visitor, or "field:{name}".
sincebody
stringISO-8601 instant or window (7d, 24h).
untilbody
string
limitbody
integer
distributionsbody
objectOne artifact's per-field distributions instead of a scoped query.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/data/query' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
GET/v1/schemaThe data catalog: datasets and content collections, or a comparison · super_data_schema

Parameters

seriesquery
string
tagsquery
array of stringAll must match.
artifactquery
stringArtifact id or slug.
comparequery
array of stringAlone: 2+ ids or slugs; their fields side by side, conflicts named.
sincequery
stringISO-8601 instant or window (7d, 24h).
workspacequery
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl 'https://superartifacts.app/v1/schema' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"

Collections4

PUT/v1/schemaCreate or replace a content collection · super_data_schema

Parameters

definebody
objectA content collection definition: creates one, or replaces the one with this key.
workspacebody
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl -X PUT 'https://superartifacts.app/v1/schema' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
GET/v1/collections/{collection}/entriesOne page of a content collection's entries · super_entries

Parameters

collectionpath, required
stringContent collection key (a content model), not a gallery label.
workspacequery
stringWorkspace handle. Omit for your own.
filterquery
array of stringANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= contains starts has in, is set, is empty. System: _created_at _updated_at _status _author.
searchquery
stringCase-insensitive, over text fields.
sortquery
stringField or system column. Default _created_at.
directionquery
"asc" | "desc"
pagequery
integer
limitquery
integer

Try it

Terminal
curl 'https://superartifacts.app/v1/collections/{collection}/entries' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/collections/{collection}/entriesCreate one entry, or a batch · super_entries

Parameters

collectionpath, required
stringContent collection key (a content model), not a gallery label.
valuesbody
object | arrayKeyed by field name. An array writes a batch.
statusbody
"draft" | "published" | "archived"Written entries. Default published.
workspacebody
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/collections/{collection}/entries' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
POST/v1/collections/{collection}/entries/{entry}/fields/{field}/useCall an approved API with a stored secret you cannot read (workspace keys) · super_secret_use

Parameters

collectionpath, required
stringContent collection key (a content model), not a gallery label.
entrypath, required
stringThe entry id.
fieldpath, required
stringThe pii: secret field whose value is sent.
methodbody, required
"GET" | "POST" | "PUT" | "PATCH" | "DELETE"
urlbody, required
stringhttps only; its host must be the approved one. Redirects are returned, never followed.
headersbody
objectSent as given, except host, authorization, cookie, proxy-* and the grant’s own header.
bodybody
string≤64 KiB.
headerbody
objectWhere the value goes; asked for when no grant exists. The approved grant’s header wins.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/collections/{collection}/entries/{entry}/fields/{field}/use' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"method":"GET","url":""}'

Templates7

GET/v1/templatesFind, rank or list templates · super_templates

Parameters

requestquery
stringWhat the person asked for, in their words.
scopequery
"installed" | "marketplace"Default installed.
kindquery
"page" | "slideshow" | "survey" | "tracker" | "video" | "tool" | "dashboard"A label, not a capability.
sortquery
"relevance" | "rating" | "uses" | "installs" | "recent"Default relevance with request, else rating.
limitquery
integerDefault 5.
jobsquery
array of "track" | "collect" | "present" | "report" | "monitor" | "prove" | "document" | "explain" | "plan" | "decide" | "review" | "learn" | "prototype" | "announce" | "compute" | "curate" | "coordinate" | "play"Any of.
audiencequery
array of "everyone" | "engineering" | "product" | "design" | "marketing" | "sales" | "ops" | "people" | "finance" | "founders" | "education" | "personal" | "community"Any of.
needsquery
array of "runtime" | "data" | "comments" | "live"All of. ["runtime"]: ships code.
costquery
"fill" | "write" | "build"fill: you send a document; write: you write the page; build: page and policy.
tierquery
"all" | "official" | "verified" | "community"Marketplace trust tier: Official, Verified or Community.
minequery
boolean

Try it

Terminal
curl 'https://superartifacts.app/v1/templates' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/templatesCreate or revise a template draft · super_template_save

Parameters

slugbody, required
stringKebab-case, 3–64 chars. Permanent.
titlebody, required
string
descriptionbody, required
string
kindbody
"page" | "slideshow" | "survey" | "tracker" | "video" | "tool" | "dashboard"dashboard: a page that mostly shows live data — a label, not a capability.
jobsbody
array of "track" | "collect" | "present" | "report" | "monitor" | "prove" | "document" | "explain" | "plan" | "decide" | "review" | "learn" | "prototype" | "announce" | "compute" | "curate" | "coordinate" | "play"What a person hires it for; the first is primary. Create default: from kind.
audiencebody
array of "everyone" | "engineering" | "product" | "design" | "marketing" | "sales" | "ops" | "people" | "finance" | "founders" | "education" | "personal" | "community"1–3, or everyone alone (the default).
useCasesbody
array of objectThings to build from it; the build prompt draws on them.
installArchetypebody
"scenarios" | "explainer" | "interview"After install: scenarios (default) offers three builds; explainer builds one from the sample; interview asks three questions first.
installAfterbody
stringYour note, appended to the build prompt as a suggestion.
samplePublicbody
booleanThe sample may appear on the public listing page.
categorybody
"trackers" | "surveys" | "presentations" | "dashboards" | "documents" | "tools" | "games" | "other"Deprecated; read as jobs when jobs is absent.
specbody, required
objectslots, declaration (every instance’s policy), optional comments, keywords (searched), examplePrompts.
guidancebody
stringOptional notes for whoever fills it.
promptbody
stringA prompt a person copies to ask for one.
samplebody
object{"values": {…}}, rendered in the preview.
demobody
stringSlug of your artifact to link as the demo (linked once public). "" clears it.
filesbody
array of objectRuntime files, index.html required. Omitting them on a revision drops the runtime from that new draft version only.
companionsbody
array of objectExtra artifacts each publish makes at {slug}-{role}, same values (e.g. a stage for a host). Bind the primary with source: {artifact: "@primary", streams}. Released: add, never remove.
expectedVersionbody
integerThe version you revised. Present: revise. Absent: create.
changeNotebody
stringRevisions: one line on why, for the changelog.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/templates' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"slug":"","title":"","description":"","spec":{}}'
GET/v1/templates/{slug}One template in full, with its install prompt · super_templates

Parameters

slugpath, required
string
versionquery
integerDefault: the released one.

Try it

Terminal
curl 'https://superartifacts.app/v1/templates/{slug}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
GET/v1/templates/{slug}/historyA template's changelog · super_templates

Parameters

slugpath, required
string

Try it

Terminal
curl 'https://superartifacts.app/v1/templates/{slug}/history' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
GET/v1/templates/{slug}/feedbackComments on a template's artifacts, as themes · super_templates

Parameters

slugpath, required
string

Try it

Terminal
curl 'https://superartifacts.app/v1/templates/{slug}/feedback' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/templates/{slug}/actionsInstall, uninstall, rate, report, roll back or request verification · super_template_action

Parameters

slugpath, required
string
actionbody, required
"install" | "uninstall" | "rate" | "report" | "rollback" | "request_verification"
starsbody
integer
versionbody
integer
kindbody
"spam" | "harmful" | "broken" | "misleading" | "pii" | "copyright" | "other"Report only.
reasonbody
stringReport only.
confirmedByPersonbody
booleanInstall only: true once the person agreed to this public template. Never set it unasked (permission_required).

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/templates/{slug}/actions' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"action":"install"}'
POST/v1/templates/{slug}/releaseRelease one version of your template · super_release_template

Parameters

slugpath, required
string
versionbody, required
integer
visibilitybody
"public" | "unlisted" | "workspace"unlisted (default): by slug. public: marketplace. workspace: team shelf, members only.
demoConsentbody
booleanDefault false. Makes the demo artifact, and its data, public.
sampleConsentbody
booleantrue: show the sample on the public listing. Omit: unchanged.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/templates/{slug}/release' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"version":1}'

Projects7

GET/v1/projectsYour projects · super_project

Parameters

workspacequery
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl 'https://superartifacts.app/v1/projects' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/projectsCreate a project, optionally seeded with artifacts · super_project

Parameters

titlebody
string≤ 120 chars.
artifactsbody
array of stringArtifact ids or slugs, in order.
groupLabelbody
stringHeading over these artifacts.
visibilitybody
"private" | "organization" | "public"organization: anyone at the workspace. Widening over private needs confirm.
rulebody
object | nullSee super_help projects. null: manual.
confirmbody
booleanNeeded to delete; also to add a private artifact to a shared project, or widen one holding private ones (confirm_private).
workspacebody
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/projects' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
GET/v1/projects/{project}One project and its items · super_project

Parameters

projectpath, required
stringProject id, slug or exact title.
workspacequery
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl 'https://superartifacts.app/v1/projects/{project}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
PATCH/v1/projects/{project}Rename, set visibility, reorder, move, fold groups or set a rule · super_project

Parameters

projectpath, required
stringProject id, slug or exact title.
titlebody
string≤ 120 chars.
visibilitybody
"private" | "organization" | "public"organization: anyone at the workspace. Widening over private needs confirm.
orderbody
array of stringEvery item once, in order: ids or slugs.
movebody
object
rulebody
object | nullSee super_help projects. null: manual.
collapsedGroupsbody
array of stringgroupLabels shown folded. Whole set.
confirmbody
booleanNeeded to delete; also to add a private artifact to a shared project, or widen one holding private ones (confirm_private).
workspacebody
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl -X PATCH 'https://superartifacts.app/v1/projects/{project}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
DELETE/v1/projects/{project}Delete a project; its artifacts stay · super_project

Parameters

projectpath, required
stringProject id, slug or exact title.
confirmquery, required
stringRepeat the project: deleting is permanent.

Try it

Terminal
curl -X DELETE 'https://superartifacts.app/v1/projects/{project}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/projects/{project}/artifactsAdd artifacts to a project · super_project

Parameters

projectpath, required
stringProject id, slug or exact title.
artifactsbody
array of stringArtifact ids or slugs, in order.
groupLabelbody
stringHeading over these artifacts.
confirmbody
booleanNeeded to delete; also to add a private artifact to a shared project, or widen one holding private ones (confirm_private).
workspacebody
stringWorkspace handle. Omit for your own.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/projects/{project}/artifacts' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
DELETE/v1/projects/{project}/artifacts/{remove}Remove one artifact (or item) from a project · super_project

Parameters

projectpath, required
stringProject id, slug or exact title.
removepath, required
stringAn artifact id or slug, or an item id.

Try it

Terminal
curl -X DELETE 'https://superartifacts.app/v1/projects/{project}/artifacts/{remove}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"

Sharing3

POST/v1/artifacts/{artifact}/sharesGive named people access to an artifact · super_share

Parameters

artifactpath, required
stringArtifact id or slug.
emailsbody, required
array of string
rolebody
"viewer" | "commenter" | "editor"Default viewer; editor for a workspace. An editor's key restores (super_artifact_set version), writes (super_data_write), publishes by slug in its workspace.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts/{artifact}/shares' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"emails":[]}'
POST/v1/projects/{project}/sharesGive named people access to a project · super_share

Parameters

projectpath, required
stringProject id, slug or exact title.
emailsbody, required
array of string
rolebody
"viewer" | "commenter" | "editor"Default viewer; editor for a workspace. An editor's key restores (super_artifact_set version), writes (super_data_write), publishes by slug in its workspace.
confirmbody
booleanProject only: true shares a project that holds private artifacts (confirm_private).

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/projects/{project}/shares' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"emails":[]}'
POST/v1/workspace/sharesInvite editors to a workspace (returns accept links) · super_share

Parameters

emailsbody, required
array of string
rolebody
"viewer" | "commenter" | "editor"Default viewer; editor for a workspace. An editor's key restores (super_artifact_set version), writes (super_data_write), publishes by slug in its workspace.
workspacebody
stringA handle you administer, or "" for your own.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/workspace/shares' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"emails":[]}'

Comments4

GET/v1/artifacts/{artifact}/commentsComment threads on an artifact, newest first · super_comments

Parameters

artifactpath, required
stringArtifact id or slug.
statusquery
"all" | "open" | "resolved"
pagequery
stringA path inside the artifact, e.g. "/pricing". Not pagination.
limitquery
integer
cursorquery
stringThe previous cursor.next.

Try it

Terminal
curl 'https://superartifacts.app/v1/artifacts/{artifact}/comments' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/artifacts/{artifact}/comments/responsesReply to and/or resolve threads, one outcome each · super_comments

Parameters

artifactpath, required
stringArtifact id or slug.
respondbody
array of object

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/artifacts/{artifact}/comments/responses' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
GET/v1/artifacts/{artifact}/comments/screenshots/{screenshot}One message's screenshot, base64 in image · super_comments

Parameters

artifactpath, required
stringArtifact id or slug.
screenshotpath, required
stringA message id, not a thread id.

Try it

Terminal
curl 'https://superartifacts.app/v1/artifacts/{artifact}/comments/screenshots/{screenshot}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
GET/v1/mentionsWhere people @mentioned you; listing marks them seen · super_comments

Parameters

artifactquery
stringArtifact id or slug.
limitquery
integer
cursorquery
stringThe previous cursor.next.

Try it

Terminal
curl 'https://superartifacts.app/v1/mentions' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"

Signatures5

GET/v1/signaturesAn artifact's signature requests, newest first · super_signatures

Parameters

artifactquery
stringArtifact id or slug.

Try it

Terminal
curl 'https://superartifacts.app/v1/signatures' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/signaturesAsk named people to sign one version of an artifact · super_signatures

Parameters

artifactbody
stringArtifact id or slug.
versionbody
integerThe version to sign. Default: the published one.
signersbody
array of object
messagebody
stringA note shown to every signer.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/signatures' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
GET/v1/signatures/{request}One signature request and its signers · super_signatures

Parameters

requestpath, required
stringA signature request id, from request or status.

Try it

Terminal
curl 'https://superartifacts.app/v1/signatures/{request}' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"
POST/v1/signatures/{request}/remindEmail a signer their link again · super_signatures

Parameters

requestpath, required
stringA signature request id, from request or status.
signerbody
stringA signer id, from status. For remind.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/signatures/{request}/remind' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'
POST/v1/signatures/{request}/withdrawClose an open signature request · super_signatures

Parameters

requestpath, required
stringA signature request id, from request or status.

Try it

Terminal
curl -X POST 'https://superartifacts.app/v1/signatures/{request}/withdraw' \
  -H "Authorization: Bearer $SUPER_ARTIFACTS_KEY"