listPlatforms

GET

/platforms

const url = 'http://localhost:8080/api/v1/platforms';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/platforms \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Responses

200

Platform registry as the server sees it (includes current tier, e.g. X with API key).

application/json

object

items

required

Array<object>

object

required

string

Allowed values: instagram facebook line wechat bluesky x douyin xiaohongshu truthsocial

name

required

Map of locale to text.

object

required

string

zh-Hans

string

aliases

Array<string>

tier

required

string

Allowed values: server agent closed

defaultTier

required

string

Allowed values: server agent closed

kinds

required

Array<string>

Allowed values: story post video link text

supportsStories

required

boolean

extensionCapture

The browser extension can capture this platform.

boolean

iconKey

required

string

inputHint

required

Map of locale to text.

object

required

string

zh-Hans

string

tierNote

Map of locale to text.

object

required

string

zh-Hans

string

Examples

seed

Derived from fixtures/seed.json.

{
  "items": [
    {
      "aliases": [
        "ig",
        "insta",
        "instagram",
        "照片墙",
        "อินสตาแกรม",
        "ไอจี"
      ],
      "defaultTier": "agent",
      "extensionCapture": true,
      "iconKey": "instagram",
      "id": "instagram",
      "inputHint": {
        "en": "Paste an Instagram link, @handle or share text.",
        "th": "วางลิงก์ Instagram ชื่อ @ หรือข้อความแชร์",
        "zh-Hans": "粘贴 Instagram 链接、@用户名或分享文本。"
      },
      "kinds": [
        "story",
        "post",
        "video"
      ],
      "name": {
        "en": "Instagram",
        "th": "Instagram",
        "zh-Hans": "Instagram"
      },
      "supportsStories": true,
      "tier": "agent",
      "tierNote": {
        "en": "Stories and posts need a logged-in browser. Connect an agent to fetch them.",
        "th": "สตอรี่และโพสต์ต้องใช้เบราว์เซอร์ที่ล็อกอินอยู่ เชื่อมต่อผู้ช่วย AI เพื่อดึงข้อมูล",
        "zh-Hans": "快拍和帖子需要已登录的浏览器。连接一个智能助理来获取。"
      }
    },
    {
      "aliases": [
        "fb",
        "facebook",
        "脸书",
        "เฟซบุ๊ก",
        "เฟสบุ๊ค"
      ],
      "defaultTier": "agent",
      "extensionCapture": true,
      "iconKey": "facebook",
      "id": "facebook",
      "inputHint": {
        "en": "Paste a Facebook link, @handle or share text.",
        "th": "วางลิงก์ Facebook ชื่อ @ หรือข้อความแชร์",
        "zh-Hans": "粘贴 Facebook 链接、@用户名或分享文本。"
      },
      "kinds": [
        "story",
        "post",
        "video"
      ],
      "name": {
        "en": "Facebook",
        "th": "Facebook",
        "zh-Hans": "Facebook"
      },
      "supportsStories": true,
      "tier": "agent",
      "tierNote": {
        "en": "Facebook needs a logged-in browser. Connect an agent to fetch stories and posts.",
        "th": "Facebook ต้องใช้เบราว์เซอร์ที่ล็อกอินอยู่ เชื่อมต่อผู้ช่วย AI เพื่อดึงสตอรี่และโพสต์",
        "zh-Hans": "Facebook 需要已登录的浏览器。连接智能助理来获取快拍和帖子。"
      }
    },
    {
      "aliases": [
        "line",
        "ไลน์",
        "连我",
        "line voom",
        "ไลน์วูม"
      ],
      "defaultTier": "closed",
      "extensionCapture": true,
      "iconKey": "line",
      "id": "line",
      "inputHint": {
        "en": "Paste a LINE VOOM link, @handle or share text.",
        "th": "วางลิงก์ LINE VOOM ชื่อ @ หรือข้อความแชร์",
        "zh-Hans": "粘贴 LINE VOOM 链接、@用户名或分享文本。"
      },
      "kinds": [
        "post",
        "video",
        "story"
      ],
      "name": {
        "en": "LINE",
        "th": "LINE",
        "zh-Hans": "LINE"
      },
      "supportsStories": true,
      "tier": "closed",
      "tierNote": {
        "en": "LINE keeps personal posts private. Homestead will remind you to visit instead.",
        "th": "LINE ไม่เปิดโพสต์ส่วนตัวให้ดู Homestead จะชวนคุณแวะไปดูใน LINE แทน",
        "zh-Hans": "LINE 的个人动态不公开。家园会提醒你去 LINE 看看。"
      }
    },
    {
      "aliases": [
        "wechat",
        "weixin",
        "wx",
        "微信",
        "朋友圈",
        "视频号",
        "วีแชท"
      ],
      "defaultTier": "closed",
      "extensionCapture": false,
      "iconKey": "wechat",
      "id": "wechat",
      "inputHint": {
        "en": "Paste a WeChat ID or shared card text.",
        "th": "วางไอดี WeChat หรือข้อความจากการ์ดที่แชร์",
        "zh-Hans": "粘贴微信号或分享卡片文本。"
      },
      "kinds": [],
      "name": {
        "en": "WeChat",
        "th": "WeChat",
        "zh-Hans": "微信"
      },
      "supportsStories": false,
      "tier": "closed",
      "tierNote": {
        "en": "WeChat Moments are only visible inside WeChat. Homestead keeps their ID handy and reminds you to say hi.",
        "th": "Moments ของ WeChat ดูได้เฉพาะในแอป Homestead จะเก็บไอดีไว้และชวนคุณไปทักทาย",
        "zh-Hans": "朋友圈只能在微信里看。家园会保存微信号，并提醒你去打个招呼。"
      }
    },
    {
      "aliases": [
        "bluesky",
        "bsky",
        "蓝天",
        "บลูสกาย"
      ],
      "defaultTier": "server",
      "extensionCapture": false,
      "iconKey": "bluesky",
      "id": "bluesky",
      "inputHint": {
        "en": "Paste a Bluesky link, @handle or share text.",
        "th": "วางลิงก์ Bluesky ชื่อ @ หรือข้อความแชร์",
        "zh-Hans": "粘贴 Bluesky 链接、@用户名或分享文本。"
      },
      "kinds": [
        "post",
        "video",
        "link"
      ],
      "name": {
        "en": "Bluesky",
        "th": "Bluesky",
        "zh-Hans": "Bluesky"
      },
      "supportsStories": false,
      "tier": "server",
      "tierNote": {
        "en": "Bluesky is open. Homestead fetches posts directly.",
        "th": "Bluesky เปิดให้เข้าถึง Homestead ดึงโพสต์ได้โดยตรง",
        "zh-Hans": "Bluesky 是开放的。家园会直接获取帖子。"
      }
    },
    {
      "aliases": [
        "x",
        "twitter",
        "tw",
        "推特",
        "ทวิตเตอร์"
      ],
      "defaultTier": "agent",
      "extensionCapture": true,
      "iconKey": "x",
      "id": "x",
      "inputHint": {
        "en": "Paste an x.com link, @handle or share text.",
        "th": "วางลิงก์ x.com ชื่อ @ หรือข้อความแชร์",
        "zh-Hans": "粘贴 x.com 链接、@用户名或分享文本。"
      },
      "kinds": [
        "post",
        "video",
        "link"
      ],
      "name": {
        "en": "X (Twitter)",
        "th": "X (ทวิตเตอร์)",
        "zh-Hans": "X（推特）"
      },
      "supportsStories": false,
      "tier": "agent",
      "tierNote": {
        "en": "X charges per post read. Add your own API key in Sources, or let an agent fetch from your browser.",
        "th": "X คิดเงินตามจำนวนโพสต์ที่อ่าน ใส่ API key ของคุณเองในหน้าแหล่งข้อมูล หรือให้ผู้ช่วย AI ดึงจากเบราว์เซอร์ของคุณ",
        "zh-Hans": "X 按读取次数收费。可在“来源”中填写自己的 API 密钥，或让智能助理从你的浏览器获取。"
      }
    },
    {
      "aliases": [
        "douyin",
        "dy",
        "抖音",
        "โต่วอิน"
      ],
      "defaultTier": "agent",
      "extensionCapture": true,
      "iconKey": "douyin",
      "id": "douyin",
      "inputHint": {
        "en": "Paste a Douyin share text or video link.",
        "th": "วางข้อความแชร์หรือลิงก์วิดีโอ Douyin",
        "zh-Hans": "粘贴抖音分享文本或视频链接。"
      },
      "kinds": [
        "video",
        "post",
        "story"
      ],
      "name": {
        "en": "Douyin",
        "th": "Douyin",
        "zh-Hans": "抖音"
      },
      "supportsStories": true,
      "tier": "agent",
      "tierNote": {
        "en": "Douyin needs a logged-in browser. Connect an agent to fetch videos.",
        "th": "Douyin ต้องใช้เบราว์เซอร์ที่ล็อกอินอยู่ เชื่อมต่อผู้ช่วย AI เพื่อดึงวิดีโอ",
        "zh-Hans": "抖音需要已登录的浏览器。连接智能助理来获取视频。"
      }
    },
    {
      "aliases": [
        "xiaohongshu",
        "xhs",
        "red",
        "redbook",
        "rednote",
        "小红书",
        "เสี่ยวหงซู"
      ],
      "defaultTier": "agent",
      "extensionCapture": true,
      "iconKey": "xiaohongshu",
      "id": "xiaohongshu",
      "inputHint": {
        "en": "Paste a Xiaohongshu share text or note link.",
        "th": "วางข้อความแชร์หรือลิงก์โน้ต Xiaohongshu",
        "zh-Hans": "粘贴小红书分享文本或笔记链接。"
      },
      "kinds": [
        "post",
        "video"
      ],
      "name": {
        "en": "Xiaohongshu (RED)",
        "th": "Xiaohongshu (RED)",
        "zh-Hans": "小红书"
      },
      "supportsStories": false,
      "tier": "agent",
      "tierNote": {
        "en": "Xiaohongshu needs a logged-in browser. Connect an agent to fetch notes.",
        "th": "Xiaohongshu ต้องใช้เบราว์เซอร์ที่ล็อกอินอยู่ เชื่อมต่อผู้ช่วย AI เพื่อดึงโพสต์",
        "zh-Hans": "小红书需要已登录的浏览器。连接智能助理来获取笔记。"
      }
    },
    {
      "aliases": [
        "truthsocial",
        "truth",
        "ts",
        "真相社交",
        "ทรูธโซเชียล"
      ],
      "defaultTier": "server",
      "extensionCapture": true,
      "iconKey": "truthsocial",
      "id": "truthsocial",
      "inputHint": {
        "en": "Paste a Truth Social link, @handle or share text.",
        "th": "วางลิงก์ Truth Social ชื่อ @ หรือข้อความแชร์",
        "zh-Hans": "粘贴 Truth Social 链接、@用户名或分享文本。"
      },
      "kinds": [
        "post",
        "video",
        "link"
      ],
      "name": {
        "en": "Truth Social",
        "th": "Truth Social",
        "zh-Hans": "Truth Social"
      },
      "supportsStories": false,
      "tier": "server",
      "tierNote": {
        "en": "Homestead tries to read Truth Social directly. If it is blocked, an agent can help.",
        "th": "Homestead จะพยายามอ่าน Truth Social โดยตรง ถ้าถูกบล็อก ผู้ช่วย AI ช่วยได้",
        "zh-Hans": "家园会尝试直接读取 Truth Social。如果被拦截，智能助理可以帮忙。"
      }
    }
  ]
}