Skip to docs content
Browse and search
On this page

get_delivery

Read what the stream delivers beyond the watchlist: default keyword filters and Discord webhook, feed toggles, Binance Square accounts, news sources, callouts and the Instagram Discord destination. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:watchlist scope.

POST/api/agent/actions/get_delivery

Authorization

  • AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key: Bearer <key>.

Body

json
{}

Response fields

  • binanceSquareobjectrequired
    • accountsobject[]required
      • accountstringrequired
      • enabledbooleanrequired
      • namestringrequired
      • profileUrlstringrequired
    • canManagebooleanrequired
  • calloutsobjectrequired
    • callersobject[]required
      • callerIdstringrequired
      • createdAtstringrequired
      • labelstringrequired
      • platformenum<string>required
      • usernamestringrequired
    • limitnumberrequired
    • pendingobject[]required
      • createdAtstringrequired
      • inputstringrequired
      • intentIdstringrequired
      • labelstringrequired
      • platformenum<string>required
  • feedsobjectrequired
    • charityobjectrequired
      • enabledbooleanrequired
    • robinhoodSocialobjectrequired
      • accountsobject[]required
        • enabledbooleanrequired
        • namestringrequired
        • profileIdstringrequired
        • profileUrlstringrequired
      • canManagebooleanrequired
    • truthSocialobjectrequired
      • availablebooleanrequired
      • enabledbooleanrequired
  • globalobjectrequired
    • keywordsstring[]required
    • webhookobjectrequiredPresent when a Discord webhook is saved; endsWith is the last 4 characters of its URL.
      • configuredenum<boolean>required
      • endsWithstringrequired
  • instagramDiscordobjectrequired
    • botobjectrequired
      • availablebooleanrequired
      • deliveringbooleanrequired
      • enabledbooleanrequired
    • webhookobjectrequired
      • availablebooleanrequired
      • configuredbooleanrequired
      • enabledbooleanrequired
  • newsSourcesobject[]required
    • availablebooleanrequired
    • enabledbooleanrequired
    • idstringrequired
    • namestringrequired
  • refusalsobject[]required
    • messagestringrequired
    • reasonenum<string>required
    • sectionenum<string>required

Responses

  • 200Success
  • 400The input does not match the action's schema (INVALID_REQUEST)
  • 401Missing or invalid API key
  • 403The request carried a foreign Origin
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later