Skip to main content
POST
Get a link preview
curl --request POST \
  --url https://api.peekalink.io/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "link": "<string>",
  "source": "API",
  "forceNewSnapshot": "true",
  "forceNewSnapshotRecursive": "true"
}
'
{
  "id": 123,
  "ok": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "domain": "<string>",
  "type": "UNKNOWN",
  "status": 123,
  "redirected": true,
  "requestId": "<string>",
  "size": 123,
  "redirectionUrl": "<string>",
  "redirectionCount": 123,
  "redirectionTrail": [
    "<string>"
  ],
  "title": "<string>",
  "description": "<string>",
  "language": "<string>",
  "icon": {
    "width": 123,
    "height": 123,
    "backgroundColor": "<string>"
  },
  "image": {
    "thumbnail": {
      "width": 123,
      "height": 123,
      "url": "<string>"
    },
    "medium": {
      "width": 123,
      "height": 123,
      "url": "<string>"
    },
    "large": {
      "width": 123,
      "height": 123,
      "url": "<string>"
    },
    "original": {
      "width": 123,
      "height": 123,
      "url": "<string>"
    }
  },
  "video": {
    "duration": 123,
    "size": 123,
    "frameRate": 123,
    "videoCodec": "<string>",
    "hasAudio": true,
    "name": "<string>",
    "title": "<string>",
    "width": 123,
    "height": 123,
    "format": "<string>",
    "bitRate": 123,
    "author": "<string>",
    "image": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "video": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "snapshots": [
      {
        "timestamp": 123,
        "image": {
          "thumbnail": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "medium": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "large": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "original": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          }
        }
      }
    ]
  },
  "audio": {
    "duration": 123,
    "creationDate": "2023-11-07T05:31:56Z",
    "size": 123,
    "bitRate": 123,
    "audioCodec": "<string>",
    "format": "<string>",
    "title": "<string>",
    "artist": "<string>",
    "album": "<string>",
    "sampleRate": 123,
    "channels": 123,
    "waveform": [
      123
    ],
    "albumArtwork": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    }
  },
  "document": {
    "title": "<string>",
    "pageCount": 123,
    "isEncrypted": true,
    "type": "<string>",
    "description": "<string>",
    "estimatedReadingTime": 123,
    "rawTextUrl": "<string>",
    "image": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "pages": [
      {
        "pageNumber": 123,
        "screenshot": {
          "thumbnail": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "medium": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "large": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "original": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          }
        }
      }
    ],
    "author": "<string>",
    "lastModified": "2023-11-07T05:31:56Z",
    "language": "<string>"
  },
  "text": {
    "size": 123,
    "estimatedReadingTime": 123,
    "rawTextUrl": "<string>",
    "image": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    }
  },
  "page": {
    "estimatedReadingTimeInMinutes": 123,
    "screenshot": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "htmlUrl": "<string>",
    "markdownUrl": "<string>",
    "rawTextUrl": "<string>"
  },
  "youtubeVideo": {
    "id": 123,
    "videoId": "<string>",
    "user": {
      "id": 123,
      "username": "<string>",
      "name": "<string>",
      "avatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "banner": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "description": "<string>",
      "subscribersCount": 123,
      "videosCount": 123,
      "viewsCount": 123,
      "joinedAt": "2023-11-07T05:31:56Z",
      "visibility": "PUBLIC",
      "externalId": "<string>",
      "url": "<string>",
      "isFamilySafe": true,
      "verified": true
    },
    "publishedAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "description": "<string>",
    "duration": 123,
    "viewsCount": 123,
    "likesCount": 123,
    "dislikesCount": 123,
    "rating": 123,
    "commentsCount": 123,
    "thumbnail": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    }
  },
  "youtubeUser": {
    "id": 123,
    "username": "<string>",
    "name": "<string>",
    "avatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "banner": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "description": "<string>",
    "subscribersCount": 123,
    "videosCount": 123,
    "viewsCount": 123,
    "joinedAt": "2023-11-07T05:31:56Z",
    "visibility": "PUBLIC",
    "externalId": "<string>",
    "url": "<string>",
    "isFamilySafe": true,
    "verified": true
  },
  "xUser": {
    "id": 123,
    "username": "<string>",
    "name": "<string>",
    "avatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "cover": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "bio": "<string>",
    "verified": true,
    "followersCount": 123,
    "followingCount": 123,
    "postsCount": 123,
    "url": "<string>",
    "location": "<string>",
    "joinedAt": "2023-11-07T05:31:56Z",
    "protected": true,
    "sensitive": true
  },
  "xPost": {
    "id": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "user": {
      "id": 123,
      "username": "<string>",
      "name": "<string>",
      "avatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "cover": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "bio": "<string>",
      "verified": true,
      "followersCount": 123,
      "followingCount": 123,
      "postsCount": 123,
      "url": "<string>",
      "location": "<string>",
      "joinedAt": "2023-11-07T05:31:56Z",
      "protected": true,
      "sensitive": true
    },
    "publishedAt": "2023-11-07T05:31:56Z",
    "text": "<string>",
    "media": [
      {
        "duration": 123,
        "size": 123,
        "frameRate": 123,
        "videoCodec": "<string>",
        "hasAudio": true,
        "name": "<string>",
        "title": "<string>",
        "width": 123,
        "height": 123,
        "format": "<string>",
        "bitRate": 123,
        "author": "<string>",
        "image": {
          "thumbnail": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "medium": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "large": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "original": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          }
        },
        "video": {
          "thumbnail": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          }
        },
        "snapshots": [
          {
            "timestamp": 123,
            "image": {
              "thumbnail": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              },
              "medium": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              },
              "large": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              },
              "original": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              }
            }
          }
        ]
      }
    ],
    "likesCount": 123,
    "commentsCount": 123,
    "viewsCount": 123,
    "bookmarksCount": 123,
    "repostsCount": 123,
    "quotesCount": 123
  },
  "instagramUser": {
    "id": 123,
    "username": "<string>",
    "verified": true,
    "name": "<string>",
    "avatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "bio": "<string>",
    "url": "<string>",
    "followersCount": 123,
    "followingCount": 123,
    "postsCount": 123,
    "visibility": "PUBLIC"
  },
  "instagramPost": {
    "id": 123,
    "publishedAt": "2023-11-07T05:31:56Z",
    "user": {
      "id": 123,
      "username": "<string>",
      "verified": true,
      "name": "<string>",
      "avatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "bio": "<string>",
      "url": "<string>",
      "followersCount": 123,
      "followingCount": 123,
      "postsCount": 123,
      "visibility": "PUBLIC"
    },
    "text": "<string>",
    "media": [
      {
        "width": 123,
        "height": 123,
        "size": 123,
        "format": "<string>",
        "hasAlphaChannel": true,
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      }
    ],
    "likesCount": 123,
    "commentsCount": 123
  },
  "amazonProduct": {
    "productId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "price": 123,
    "currency": "<string>",
    "rating": 123,
    "reviewCount": 123,
    "features": [
      "<string>"
    ],
    "media": [
      {
        "width": 123,
        "height": 123,
        "size": 123,
        "format": "<string>",
        "hasAlphaChannel": true,
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      }
    ]
  },
  "etsyProduct": {
    "productId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "price": 123,
    "currency": "<string>",
    "rating": 123,
    "reviewCount": 123,
    "media": [
      {
        "width": 123,
        "height": 123,
        "size": 123,
        "format": "<string>",
        "hasAlphaChannel": true,
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      }
    ]
  },
  "tiktokUser": {
    "id": 123,
    "username": "<string>",
    "verified": true,
    "name": "<string>",
    "avatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "bio": "<string>",
    "url": "<string>",
    "followersCount": 123,
    "followingCount": 123,
    "likesCount": 123,
    "visibility": "PUBLIC"
  },
  "tiktokVideo": {
    "id": 123,
    "user": {
      "id": 123,
      "username": "<string>",
      "verified": true,
      "name": "<string>",
      "avatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "bio": "<string>",
      "url": "<string>",
      "followersCount": 123,
      "followingCount": 123,
      "likesCount": 123,
      "visibility": "PUBLIC"
    },
    "publishedAt": "2023-11-07T05:31:56Z",
    "text": "<string>",
    "media": [
      {
        "width": 123,
        "height": 123,
        "size": 123,
        "format": "<string>",
        "hasAlphaChannel": true,
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      }
    ],
    "likesCount": 123,
    "commentsCount": 123,
    "playsCount": 123,
    "sharesCount": 123
  },
  "redditUser": {
    "id": 123,
    "username": "<string>",
    "name": "<string>",
    "flattenedAvatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "avatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "avatarBackground": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "banner": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "bio": "<string>",
    "karma": 123,
    "postKarma": 123,
    "commentKarma": 123,
    "joinedAt": "2023-11-07T05:31:56Z"
  },
  "redditSubreddit": {
    "id": 123,
    "name": "<string>",
    "title": "<string>",
    "description": "<string>",
    "subscribersCount": 123,
    "activeUsersCount": 123,
    "createdDate": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "nsfw": true,
    "banner": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    },
    "avatar": {
      "thumbnail": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "medium": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "large": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      },
      "original": {
        "width": 123,
        "height": 123,
        "url": "<string>"
      }
    }
  },
  "redditPost": {
    "id": 123,
    "xId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "user": {
      "id": 123,
      "username": "<string>",
      "name": "<string>",
      "flattenedAvatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "avatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "avatarBackground": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "banner": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "bio": "<string>",
      "karma": 123,
      "postKarma": 123,
      "commentKarma": 123,
      "joinedAt": "2023-11-07T05:31:56Z"
    },
    "subreddit": {
      "id": 123,
      "name": "<string>",
      "title": "<string>",
      "description": "<string>",
      "subscribersCount": 123,
      "activeUsersCount": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "nsfw": true,
      "banner": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      },
      "avatar": {
        "thumbnail": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "medium": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "large": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        },
        "original": {
          "width": 123,
          "height": 123,
          "url": "<string>"
        }
      }
    },
    "publishedAt": "2023-11-07T05:31:56Z",
    "text": "<string>",
    "likesCount": 123,
    "commentsCount": 123,
    "type": "IMAGE",
    "media": [
      {
        "duration": 123,
        "size": 123,
        "frameRate": 123,
        "videoCodec": "<string>",
        "hasAudio": true,
        "name": "<string>",
        "title": "<string>",
        "width": 123,
        "height": 123,
        "format": "<string>",
        "bitRate": 123,
        "author": "<string>",
        "image": {
          "thumbnail": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "medium": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "large": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          },
          "original": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          }
        },
        "video": {
          "thumbnail": {
            "width": 123,
            "height": 123,
            "url": "<string>"
          }
        },
        "snapshots": [
          {
            "timestamp": 123,
            "image": {
              "thumbnail": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              },
              "medium": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              },
              "large": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              },
              "original": {
                "width": 123,
                "height": 123,
                "url": "<string>"
              }
            }
          }
        ]
      }
    ]
  },
  "githubRepository": {
    "id": 123,
    "name": "<string>",
    "owner": {
      "id": 123,
      "username": "<string>"
    },
    "description": "<string>",
    "starsCount": 123,
    "contributorsCount": 123,
    "watchersCount": 123,
    "commitsCount": 123,
    "forksCount": 123,
    "issuesCount": 123,
    "pullRequestsCount": 123,
    "languages": [
      {
        "name": "<string>",
        "color": "<string>",
        "percentage": 123
      }
    ],
    "topics": [
      "<string>"
    ],
    "lastCommitDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
accept-language
string

The language of the user

Body

Request to generate a link preview

​
link
string<url>
required
​
source
enum<string>
default:API

Source of the link preview request

Available options:
API,
WEB
​
forceNewSnapshot
enum<string>
default:true

Only available to enterprise customers working on integrations. Every link is guaranteed fresh, this is just for debugging timing issues.

Available options:
true,
false
​
forceNewSnapshotRecursive
enum<string>
default:true

Only available to enterprise customers working on integrations. Every link is guaranteed fresh, this is just for debugging timing issues.

Available options:
true,
false

Response

Successfully retrieved link preview

Complete information about a link and its associated content

​
id
number
required

Unique identifier for the link

​
ok
boolean
required

Whether the link is valid

​
updatedAt
string<date-time>
required

Last update timestamp

​
url
string
required

Original URL

​
domain
string
required

Domain name from the URL

​
type
enum<string>
default:UNKNOWN
required

Type of content the link represents

Available options:
UNKNOWN,
IMAGE,
VIDEO,
AUDIO,
DOCUMENT,
TEXT,
PAGE,
YOUTUBE_USER,
X_USER,
X_POST,
INSTAGRAM_USER,
INSTAGRAM_POST,
YOUTUBE_VIDEO,
AMAZON_PRODUCT,
ETSY_PRODUCT,
REDDIT_USER,
REDDIT_POST,
REDDIT_SUBREDDIT,
TIKTOK_USER,
TIKTOK_VIDEO,
GITHUB_REPOSITORY
​
status
number
required

HTTP status code

​
redirected
boolean
required

Whether the URL was redirected

​
requestId
string

Optional identifier for tracking the request

​
size
number

Content size in bytes

​
redirectionUrl
string

Final URL after redirects

​
redirectionCount
number

Number of redirects

​
redirectionTrail
string[]

Redirect URL

​
title
string

Page title (only missing when ok: false)

​
description
string

Page description (only missing when ok: false)

​
language
string

Content language code

​
icon
object

Information about a website icon/favicon

​
image
object

Collection of differently sized versions of an image

​
video
object

Detailed information about a video file

​
audio
object

Detailed information about an audio file

​
document
object

Detailed information about a document

​
text
object

Information about plain text content

​
page
object

Information about a web page

​
youtubeVideo
object

Information about a YouTube video

​
youtubeUser
object

Information about a YouTube channel

​
xUser
object

Information about an X (formerly Twitter) user

​
xPost
object

Information about an X (formerly Twitter) post

​
instagramUser
object

Information about an Instagram user

​
instagramPost
object

Information about an Instagram post

​
amazonProduct
object

Information about an Amazon product

​
etsyProduct
object

Information about an Etsy product

​
tiktokUser
object

Information about a TikTok user

​
tiktokVideo
object

Information about a TikTok video

​
redditUser
object

Information about a Reddit user

​
redditSubreddit
object

Information about a Reddit subreddit

​
redditPost
object

Information about a Reddit post

​
githubRepository
object

Detailed information about a GitHub repository