Get document by username and slug

GET

/@{username}/{slug}

• Production

Retrieves a publicly shared document via a user-scoped URL (e.g. /@alice/my-doc). Available for Pro+ users who set custom filenames. Returns 410 if the document has expired. No authentication required.

Parameters

Path Parameters

username

required

string

>= 1 characters <= 50 characters /^[a-z0-9_-]+$/

Author username

slug

required

string

>= 1 characters <= 100 characters /^[a-z0-9-]+$/

Document slug

Responses

200

Public document response for rendering shared links

Public document response for rendering shared links

object

slug

required

URL-friendly identifier

string

title

required

Any of:

string

string

null

null

content

required

Full markdown content

string

username

required

Any of:

string

string

null

null

createdAt

required

Creation timestamp

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

updatedAt

required

Last update timestamp

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

404

Standard error response

Standard error response

object

error

required

Error code or short description

string

message

Human-readable error details

string

410

Standard error response

Standard error response

object

error

required

Error code or short description

string

message

Human-readable error details

string