POST/api/v1/artifacts

Publish an uploaded file

Publishes a file uploaded with Get a single upload URL, after checking its real size and type.

API token required20 per minute per IP
Code samples and Try it

Request body

#

application/json, required

  • blob_keystringRequired

    1–300 characters.

  • titlestring

    Shown on the page and in link previews. Up to 200 characters.

  • filenamestring

    Up to 255 characters.

  • custom_slugstring

    Your own address: markdrop.in/<custom_slug>. Letters, digits, - and _. Taken or reserved addresses answer 409. 3–50 characters. Matches ^[a-zA-Z0-9_-]+$.

  • expires_in"never" | "1d" | "7d" | "30d" | "custom"

    When the document is deleted. custom needs custom_expires_at. Default "never".

  • custom_expires_atstring (date-time)

    The deletion time, when expires_in is custom. Must be in the future. ISO 8601, for example 2026-11-30T12:00:00Z.

  • read_passwordstring

    Readers must enter this password before they see the content. 1–100 characters.

  • access_level"private" | "link" | "workspace"

    Who can open it: link (anyone with the link), private (only you and the people you share it with) or workspace (members of its workspace). Default "link".

  • workspacestring

    File it in this workspace: the workspace's id. 1–64 characters.

  • folderstring

    An existing folder of workspace: its id or its path, like guides/setup. 1–400 characters.

Responses

#
  • 201Created.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
201 response: 22 fields (ArtifactCreateResponse)
  • slugstring
  • urlstring
  • titlestring | null

    Shown on the page and in link previews.

  • kindstring

    Default "artifact".

  • mimestring
  • rendererstring
  • type_labelstring
  • size_bytesinteger
  • original_filenamestring | null
  • artifact_urlstring
  • workspace_urlstring | null
  • download_urlstring
  • poster_urlstring | null
  • mediaobject | null
  • created_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • updated_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • expires_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • viewsinteger

    Default 0.

  • is_password_protectedboolean

    Default false.

  • is_ownerboolean

    Default false.

  • edit_secretstring
  • workspace_errorstring | null
Did this page help?