Skip to content
calternal docs

Get public link details

GET
/api/v1/public/{slug}
curl --request GET \
  --url https://example.com/api/v1/public/example

Requires a valid public link. It returns 404 when the link is missing or no longer available, or 429 when the request limit is reached. Route: /api/v1/public/{slug}. Inputs: slug, X-Public-Password. Safe reads can use bounded retries.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Header Parameters

Section titled “Header Parameters”
X-Public-Password
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
extension

The lowercase file extension of a single-file link (md, jpg), so the page can pick a presentation even when the name is hidden. It tells no more than the thumbnail or the MIME type already does.

string | null
hide_filenames
required
boolean
kind
required

file or directory.

string
mime

Content type from Files’ projection for a single-file link.

string | null
owner_name

The owner’s display name, shown as “Shared by …” on the link page.

string | null
permissions
required
object
download
required
boolean
linked_notes
required
boolean
upload
required
boolean
view
required
boolean
presentation
required
string
size
required

Size in bytes for a file; 0 for a folder.

integer format: int64
title
string | null
Examplegenerated
{
  "extension": "example",
  "hide_filenames": true,
  "kind": "example",
  "mime": "example",
  "owner_name": "example",
  "permissions": {
    "download": true,
    "linked_notes": true,
    "upload": true,
    "view": true
  },
  "presentation": "example",
  "size": 1,
  "title": "example"
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}