跳到文档正文
浏览和搜索
本页内容

读取实时流 key

读取账号有权使用的产品的实时流 key:标准 key,或单独的 Ultra Speed key。请把它保存在环境变量中,不要放进 URL 或日志。

POST/api/agent/credentials

授权

  • Authorizationstringheader必填使用 TweetStream API 密钥进行 Bearer 认证:Bearer <key>。

请求头

  • X-TweetStream-Setup-Proofstringheader必填邮箱验证返回的 setupProof,有效期 30 分钟。过期后需重新验证邮箱验证码。

请求体

  • familyenum<string>必填

响应字段

  • apiKeystring必填
  • createdAtstring必填a string to be decoded into a Date
  • credentialScopeenum<string>必填
  • familyenum<string>必填

响应

  • 200成功
  • 400请求无效、验证码错误,或未接受服务条款
  • 401API key 缺失或无效,或 setup proof 缺失或已过期
  • 403账号受到限制,或请求带有外部 Origin
  • 404结账或链接不存在,或账号没有该产品的使用权
  • 429已达到速率限制或开通额度,请在 retryAfterSeconds 秒后重试
  • 503暂时不可用,请稍后重试