linkbreakers-com · Schema

A reserved replacement and where to upload the new file

QR CodesLead CaptureWebhookSDK

Properties

Name Type Description
media object The media item as it is now, with its references: the uses the replacement will change. It keeps its current file until CompleteReplace.
replacementId string The replacement's id (UUID), which CompleteReplace takes. Empty when unchanged.
unchanged boolean True when the declared sha256 is the media's own file: nothing to upload, nothing changes.
uploadExpiresAt string
uploadHeaders object Headers the upload must carry, exactly as given: Content-Type, and x-amz-checksum-sha256 when sha256 was declared. The Content-Length must equal the declared size.
uploadMethod string The HTTP method to send them with: always PUT. Empty when unchanged.
uploadUrl string Where to send the new file's bytes, directly to storage. Short-lived. Empty when unchanged.
View JSON Schema on GitHub

JSON Schema

linkbreakers-com-create-media-replace-upload-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/linkbreakers-com/json-schema/linkbreakers-com-create-media-replace-upload-response-schema.json",
  "title": "A reserved replacement and where to upload the new file",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/linkbreakers-com-media-api-openapi.yml#/components/schemas/CreateMediaReplaceUploadResponse",
  "properties": {
    "media": {
      "$ref": "#/$defs/Media",
      "description": "The media item as it is now, with its references: the uses the replacement will change. It keeps its\ncurrent file until CompleteReplace."
    },
    "replacementId": {
      "description": "The replacement's id (UUID), which CompleteReplace takes. Empty when unchanged.",
      "type": "string"
    },
    "unchanged": {
      "description": "True when the declared sha256 is the media's own file: nothing to upload, nothing changes.",
      "type": "boolean"
    },
    "uploadExpiresAt": {
      "format": "date-time",
      "title": "When upload_url stops accepting the file",
      "type": "string"
    },
    "uploadHeaders": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Headers the upload must carry, exactly as given: Content-Type, and x-amz-checksum-sha256 when sha256 was declared. The Content-Length must equal the declared size.",
      "type": "object"
    },
    "uploadMethod": {
      "description": "The HTTP method to send them with: always PUT. Empty when unchanged.",
      "type": "string"
    },
    "uploadUrl": {
      "description": "Where to send the new file's bytes, directly to storage. Short-lived. Empty when unchanged.",
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "Media": {
      "description": "A file in the workspace's media library: an image, a PDF document or an MP4 video. A media item only has a\nkind; where it is used is derived from its references. Any image can be used as a QR code logo, a page\ntheme's background cover, badge or footer logo (up to 3 MB for those), and any media can be opened by an\nOpen media workflow step. Every item counts toward the workspace's media storage allowance\n(PLAN_LIMIT_KEY_MEDIA_STORAGE_MB in allowances).",
      "properties": {
        "createdAt": {
          "format": "date-time",
          "readOnly": true,
          "title": "When the file was created",
          "type": "string"
        },
        "fileName": {
          "title": "The name of the file",
          "type": "string"
        },
        "id": {
          "title": "The unique identifier of the media file (UUID)",
          "type": "string"
        },
        "kind": {
          "description": "- KIND_UNSPECIFIED: Not set\n - KIND_IMAGE: A PNG, JPEG, WebP or SVG image\n - KIND_DOCUMENT: A PDF document\n - KIND_VIDEO: An MP4 video",
          "enum": [
            "KIND_UNSPECIFIED",
            "KIND_IMAGE",
            "KIND_DOCUMENT",
            "KIND_VIDEO"
          ],
          "readOnly": true,
          "title": "What kind of file this is"
        },
        "mediaType": {
          "$ref": "#/$defs/MediaType",
          "description": "Deprecated: read uploaded_from for where the media was uploaded from and references for where it is\nused. Still filled with the value recorded at upload; unset for media uploaded from the media library."
        },
        "mimeType": {
          "readOnly": true,
          "title": "The MIME type of the file",
          "type": "string"
        },
        "references": {
          "description": "Where this media is used: the Open media steps opening it, the page themes showing it and the QR code\ndesigns using it as their logo, each named by the link or the template it belongs to. Empty means it is\nnot used anywhere. Filled by List and Get; Create, CreateUpload and CompleteUpload return it empty.\nDeleting media an Open media step or a page theme uses is refused with MEDIA_IN_USE; a QR code keeps\nits own copy of its logo, so deleting the media changes no QR code and only clears its link to it.",
          "items": {
            "$ref": "#/$defs/MediaReference",
            "type": "object"
          },
          "readOnly": true,
          "type": "array"
        },
        "sha256": {
          "description": "The SHA-256 of the file's bytes, 64 lowercase hexadecimal characters, computed by the server. A\nworkspace holds each file once: uploading bytes with the same hash is refused with 409\nMEDIA_ALREADY_EXISTS, naming this media in the error's existingMediaId and existingFileName\nmetadata. Empty while pending, and for media stored before files were hashed.",
          "readOnly": true,
          "type": "string"
        },
        "signedUrl": {
          "title": "Short-lived signed URL for downloading the media asset",
          "type": "string"
        },
        "size": {
          "format": "int64",
          "readOnly": true,
          "title": "The size of the file in bytes",
          "type": "integer"
        },
        "status": {
          "$ref": "#/$defs/MediaStatus",
          "description": "Whether the file is stored yet. Only CreateUpload and Get of a pending upload return STATUS_PENDING.",
          "readOnly": true
        },
        "updatedAt": {
          "format": "date-time",
          "readOnly": true,
          "title": "When the file was last updated",
          "type": "string"
        },
        "uploadedBy": {
          "description": "The member who uploaded the file\nIf it was uploaded through the public API, or if the member was removed from the workspace, the uploaded_by will be null.",
          "readOnly": true,
          "type": "string"
        },
        "uploadedFrom": {
          "$ref": "#/$defs/MediaUploadOrigin",
          "description": "Where the media was uploaded from, so pickers can show a section's own uploads first. It does not\nlimit where the media can be used; see references for where it is used.",
          "readOnly": true
        },
        "usage": {
          "$ref": "#/$defs/MediaUsage",
          "description": "Deprecated: read uploaded_from for where the media was uploaded from and references for where it is\nused. Still filled with the value recorded at upload; unset for media uploaded from the media library."
        },
        "visibility": {
          "$ref": "#/$defs/MediaVisibility",
          "description": "If not provided, the media file will be private to the workspace.",
          "title": "The visibility of the media"
        },
        "workspaceId": {
          "title": "The workspace ID the media file belongs to (UUID)",
          "type": "string"
        }
      },
      "title": "Media",
      "type": "object"
    },
    "MediaReference": {
      "description": "MediaReference is one place a media item is used. A media item's references are where it is used;\nnone means it is not used anywhere.",
      "properties": {
        "linkId": {
          "description": "The link that uses the media (UUID): the Open media step's link, a link whose page theme shows it, or a link whose QR code uses it as its logo. Empty when the use is not tied to a link, as for a template's own theme or QR code design.",
          "readOnly": true,
          "type": "string"
        },
        "linkName": {
          "description": "The link's name, or its shortlink when it has no name. Empty when link_id is empty.",
          "readOnly": true,
          "type": "string"
        },
        "pageThemeTemplateId": {
          "description": "The page theme template whose theme shows the media (UUID). Set only for page theme uses that belong to a template rather than a link.",
          "readOnly": true,
          "type": "string"
        },
        "pageThemeTemplateName": {
          "description": "The page theme template's name. Set with page_theme_template_id.",
          "readOnly": true,
          "type": "string"
        },
        "qrcodeTemplateId": {
          "description": "The QR code template whose QR code design uses the media as its logo (UUID). Set only for\nTYPE_QR_CODE_LOGO uses that belong to a QR code template rather than a link.",
          "readOnly": true,
          "type": "string"
        },
        "qrcodeTemplateName": {
          "description": "The QR code template's name. Set with qrcode_template_id.",
          "readOnly": true,
          "type": "string"
        },
        "type": {
          "$ref": "#/$defs/MediaReferenceType",
          "readOnly": true,
          "title": "What uses the media"
        },
        "workflowStepId": {
          "description": "The Open media workflow step handing out the media (UUID). Set only for TYPE_OPEN_MEDIA_STEP.",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "MediaReferenceType": {
      "default": "TYPE_UNSPECIFIED",
      "description": "- TYPE_UNSPECIFIED: Not set\n - TYPE_OPEN_MEDIA_STEP: An Open media workflow step opens the media for visitors. It blocks deleting the media.\n - TYPE_PAGE_THEME_COVER: A page theme shows the media as its background cover. It blocks deleting the media.\n - TYPE_PAGE_THEME_BADGE: A page theme shows the media as its badge. It blocks deleting the media.\n - TYPE_PAGE_THEME_FOOTER_LOGO: A page theme shows the media as its footer logo. It blocks deleting the media.\n - TYPE_QR_CODE_LOGO: A QR code design uses the media as its logo, in the center of the QR code. The design keeps its\nown copy of the image, so this does not block deleting the media; deleting it clears this use.\nReplacing the media's file detaches it too: the design keeps its current logo.",
      "enum": [
        "TYPE_UNSPECIFIED",
        "TYPE_OPEN_MEDIA_STEP",
        "TYPE_PAGE_THEME_COVER",
        "TYPE_PAGE_THEME_BADGE",
        "TYPE_PAGE_THEME_FOOTER_LOGO",
        "TYPE_QR_CODE_LOGO"
      ],
      "title": "Type is what uses the media",
      "type": "string"
    },
    "MediaStatus": {
      "default": "STATUS_UNSPECIFIED",
      "description": "- STATUS_UNSPECIFIED: Not set\n - STATUS_PENDING: A direct upload that has not been completed: no file yet, not listed, cannot be used\n - STATUS_READY: Stored and checked, ready to use",
      "enum": [
        "STATUS_UNSPECIFIED",
        "STATUS_PENDING",
        "STATUS_READY"
      ],
      "title": "Status says whether the file behind a media item is stored yet",
      "type": "string"
    },
    "MediaType": {
      "default": "TYPE_UNSPECIFIED",
      "description": "Deprecated: the value recorded at upload, kept for older clients. See UploadOrigin.\n\n - TYPE_UNSPECIFIED: The media type is not specified\n - TYPE_CENTRAL_QRCODE_IMAGE: The media type is a central QR code image\n - TYPE_BACKGROUND_COVER: The media type is a background cover for page themes\n - TYPE_BADGE: The media type is a badge image for page themes\n - TYPE_FOOTER_LOGO: The media type is a footer logo shown at the bottom of page theme pages\n - TYPE_OPEN_MEDIA: The media is handed to visitors by an Open media workflow step",
      "enum": [
        "TYPE_UNSPECIFIED",
        "TYPE_CENTRAL_QRCODE_IMAGE",
        "TYPE_BACKGROUND_COVER",
        "TYPE_BADGE",
        "TYPE_FOOTER_LOGO",
        "TYPE_OPEN_MEDIA"
      ],
      "type": "string"
    },
    "MediaUploadOrigin": {
      "default": "UPLOAD_ORIGIN_UNSPECIFIED",
      "description": "UploadOrigin is where in the product a media item was uploaded from. It is information only, so\npickers can show a section's own uploads first; it never limits where the media can be used.\nTo add a place, add a value here (next number), map it in core, and pass it from the screen that uploads.\n\n - UPLOAD_ORIGIN_UNSPECIFIED: Not set. Uploads that do not say where they come from are recorded as UPLOAD_ORIGIN_MEDIA_LIBRARY.\n - UPLOAD_ORIGIN_MEDIA_LIBRARY: Uploaded from the media library itself\n - UPLOAD_ORIGIN_QR_CODE_LOGO: Uploaded while picking a QR code's logo\n - UPLOAD_ORIGIN_BACKGROUND_COVER: Uploaded while picking a page theme's background cover\n - UPLOAD_ORIGIN_BADGE: Uploaded while picking a page theme's badge\n - UPLOAD_ORIGIN_FOOTER_LOGO: Uploaded while picking a page theme's footer logo\n - UPLOAD_ORIGIN_OPEN_MEDIA: Uploaded while picking the media an Open media step opens\n - UPLOAD_ORIGIN_ASSISTANT: Imported by the Assistant, from a file attached to a conversation or a URL",
      "enum": [
        "UPLOAD_ORIGIN_UNSPECIFIED",
        "UPLOAD_ORIGIN_MEDIA_LIBRARY",
        "UPLOAD_ORIGIN_QR_CODE_LOGO",
        "UPLOAD_ORIGIN_BACKGROUND_COVER",
        "UPLOAD_ORIGIN_BADGE",
        "UPLOAD_ORIGIN_FOOTER_LOGO",
        "UPLOAD_ORIGIN_OPEN_MEDIA",
        "UPLOAD_ORIGIN_ASSISTANT"
      ],
      "type": "string"
    },
    "MediaUsage": {
      "default": "USAGE_UNSPECIFIED",
      "description": "Deprecated: the value recorded at upload, kept for older clients. It no longer limits anything. Uploads\naccept images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB,\nwhatever the usage. Where media is used is checked when it is attached: a QR code logo, background\ncover, badge or footer logo must be an image of at most 3 MB; an Open media step takes any media.\n\n - USAGE_UNSPECIFIED: Not set\n - USAGE_CENTRAL_QRCODE_IMAGE: The logo in the center of a QR code\n - USAGE_BACKGROUND_COVER: A page theme's background cover\n - USAGE_BADGE: A page theme's badge image\n - USAGE_FOOTER_LOGO: A page theme's footer logo\n - USAGE_OPEN_MEDIA: Media an Open media workflow step hands to visitors: a PDF menu or brochure, an image or an MP4 video",
      "enum": [
        "USAGE_UNSPECIFIED",
        "USAGE_CENTRAL_QRCODE_IMAGE",
        "USAGE_BACKGROUND_COVER",
        "USAGE_BADGE",
        "USAGE_FOOTER_LOGO",
        "USAGE_OPEN_MEDIA"
      ],
      "type": "string"
    },
    "MediaVisibility": {
      "default": "VISIBILITY_UNSPECIFIED",
      "description": "- VISIBILITY_UNSPECIFIED: Media visibility not specified\nThe media visibility is not specified\n - VISIBILITY_PUBLIC: The media visibility is public\n - VISIBILITY_PRIVATE: The media visibility is private",
      "enum": [
        "VISIBILITY_UNSPECIFIED",
        "VISIBILITY_PUBLIC",
        "VISIBILITY_PRIVATE"
      ],
      "title": "Visibility represents the visibility of a media file",
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/linkbreakers-com-create-media-replace-upload-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.