package pb
Get desktop application:
View/edit binary Protocol Buffers messages
service Api
api.proto:12rpc AddFeedService (, )
api.proto:51service
message
api.proto:300string actor_uuid = 1
string target_feed_uuid = 2
string kind = 3
string url = 4
rpc AddGroupAdmin (, )
api.proto:61rpc ApproveFollowRequest (, )
api.proto:73rpc ArchiveFeed (stream , )
api.proto:30A client-to-server streaming RPC. Accepts a stream of Entries on a feed being archived, returning a FeedSummary when archving is completed.
rpc BindUserFeed (, )
api.proto:48rpc BindAuth(OAuthUser) returns (OAuthUser) {}
rpc CancelFollowRequest (, )
api.proto:72rpc ClaimTasks (, )
api.proto:14message
api.proto:138string worker_id = 1
repeated string types = 2
uint32 max_tasks = 3
message
api.proto:144repeated tasks = 1
rpc Command (, )
api.proto:77message
api.proto:180string command = 1
string arg1 = 2
string arg2 = 3
message
api.proto:186string command = 1
string result = 2
rpc CommentEntry (, )
api.proto:42message
api.proto:287string entry = 1
optional comment = 2
string user_uuid = 3
stable principal; required, client From is not trusted
rpc CompleteTask (, )
api.proto:15message
api.proto:148string worker_id = 1
string task_id = 2
uint64 lease_epoch = 3
rpc CreateGroup (, )
api.proto:58group
message
api.proto:345string actor_uuid = 1
string id = 2
string name = 3
string description = 4
string picture = 5
bool private = 6
rpc DeleteComment (, )
api.proto:43message
api.proto:293string entry = 1
string comment = 2
string user = 3
legacy profile ID; kept for wire compat, not an authz fallback
string user_uuid = 4
stable principal; required
rpc DeleteEntry (, )
api.proto:40rpc DeleteGroup (, )
api.proto:65message
api.proto:406DeleteGroupRequest soft-deletes a Group. actor_uuid must be a Group admin or super, per docs/group.md; the last admin may delete the whole Group.
string actor_uuid = 1
string group_uuid = 2
rpc EnqueueTask (, )
api.proto:13message
api.proto:125string type = 1
bytes payload = 2
uint32 payload_version = 3
string idempotency_key = 4
int64 run_at_ms = 5
message
api.proto:133optional task = 1
bool already_exists = 2
rpc FailTask (, )
api.proto:16message
api.proto:154string worker_id = 1
string task_id = 2
uint64 lease_epoch = 3
string error = 4
message
api.proto:161FailTaskOutcome outcome = 1
int64 next_run_at_ms = 2
rpc FetchEntry (, )
api.proto:37Entry page return Feed as well
rpc FetchFeed (, )
api.proto:33message
api.proto:218placeholder - Always true, indicating the entity is the placeholder body - The text we use for the placeholder on FriendFeed, e.g., "3 more comments" for comments or "234 other people" for likes num - The number of comments or likes excluded. For example, if the body is "3 more comments", then num would be 3. Example: http://friendfeed-api.com/v2/feed/bret?maxcomments=auto&maxlikes=auto
string id = 1
int32 start = 2
int32 page_size = 3
bool raw = 4
Include raw text entry and comment bodies in addition to the HTML bodies included by default. The raw text bodies are available as rawBody on all returned entries and comments. This also adds rawLink on all entries.
int32 max_comments = 5
NOTICE: this is not the same as original friendfeed api auto should be default it not set. if max_comments set to 1, then all comments should returned.
int32 max_likes = 6
string profile_uuid = 7
string cursor = 8
Cursor pagination is opt-in so existing Start/PageSize callers keep their historical behavior. Cursor values are opaque to clients.
bool cursor_paging = 9
string viewer_uuid = 10
UUID of the user viewing this feed. Used for private group access control. Optional for backwards compatibility; if empty, assumes public access only.
rpc FetchGraph (, )
api.proto:20message
feed.proto:126social graph
map<string, > following = 1
map<string, > followers = 2
map<string, > admins = 3
map<string, > feeds = 4
map<string, > services = 5
rpc FetchInteractionFeed (, )
api.proto:34message
api.proto:247string profile_uuid = 1
InteractionKind kind = 2
string cursor = 3
int32 page_size = 4
string viewer_uuid = 5
message
api.proto:261optional profile = 1
repeated items = 2
string next_cursor = 3
rpc FetchProfile (, )
api.proto:19rpc ForceArchiveFeed (stream , )
api.proto:31rpc GetGroup (, )
api.proto:66message
api.proto:412GetGroupRequest reads one Group's metadata plus the viewer's relationship.
string group_uuid = 1
string viewer_uuid = 2
session user; empty means anonymous
message
api.proto:419GroupView is Group metadata plus the viewer's member/admin status, per docs/group.md's read contract. It never embeds member lists.
optional group = 1
bool is_member = 2
bool is_admin = 3
bool has_pending_request = 4
true when the viewer has a pending follow request against this Group.
rpc GraphFollow (, )
api.proto:21message
feed.proto:134string profile_uuid = 1
string feed_uuid = 2
string action = 3
message
feed.proto:140bool followed = 1
bool requested = 2
true when the action created a pending follow request instead of an edge (private target awaiting approval).
rpc JoinGroup (, )
api.proto:59rpc LeaveGroup (, )
api.proto:60rpc LikeEntry (, )
api.proto:41message
api.proto:281string entry = 1
string user = 2
bool like = 3
rpc ListFeedServices (, )
api.proto:53message
api.proto:313string actor_uuid = 1
string target_feed_uuid = 2
message
api.proto:318repeated services = 1
map<string, > states = 2
rpc ListFollowRequests (, )
api.proto:75message
api.proto:452ListFollowRequestsRequest pages the pending requests against one feed. actor must be allowed to approve them (owner / Group admin / super).
string actor_uuid = 1
string feed_uuid = 2
int32 limit = 3
Max requests to return (default 100)
string cursor = 4
Opaque continuation token from previous response
message
api.proto:465repeated requests = 1
string next_cursor = 2
Empty when iteration is complete
rpc ListGroupMembers (, )
api.proto:67message
api.proto:473ListGroupMembersRequest pages a Group's membership. Follower edges are the sole membership source; cursor follows the same contract as ListUserGroups (last scanned edge, never a business ID).
string group_uuid = 1
int32 limit = 2
Max members to return (default 100, cap 200)
string cursor = 3
Opaque continuation token from previous response
string viewer_uuid = 4
session user; required for private Groups
message
api.proto:487ListGroupMembersResponse returns a page of Group members.
repeated members = 1
string next_cursor = 2
Empty when iteration is complete
rpc ListGroups (, )
api.proto:69message
api.proto:394ListGroups reads the global activity-ordered discovery index. It is public metadata and deliberately carries no viewer or relationship state.
int32 limit = 1
default 30, cap 100
string cursor = 2
opaque GroupIndex position
message
api.proto:399repeated groups = 1
string next_cursor = 2
rpc ListUserGroups (, )
api.proto:68message
api.proto:378ListUserGroupsRequest reads the Groups a user has joined. Streams through the user's Follow edges, filtering for Type=="group" Profiles.
string user_uuid = 1
int32 limit = 2
Max Groups to return (default 100, cap 200)
string cursor = 3
Opaque continuation token from previous response
bool order_by_activity = 4
Sidebar-only materialized activity order; cursor is not used in this mode.
message
api.proto:387ListUserGroupsResponse returns a page of Groups the user follows.
repeated groups = 1
string next_cursor = 2
Empty when iteration is complete
rpc PostEntry (, )
api.proto:38rpc PostFeedinfo (, )
api.proto:24rpc FetchFeedinfo(ProfileRequest) returns (Feedinfo) {}
message
feed.proto:194/feedinfo - Feed information Return information about the feed with the specified feed id: http://friendfeed-api.com/v2/feedinfo/feed id The response is a feed, plus the following fields: subscriptions[]? - The users and groups this feed is subscribed to subscribers[]? - The users subscribed to this feed admins[]{}? - For groups, the list of group administrators feeds[]? - For special feeds, the feeds that are contained within this feed. For example, for a friend list feed, this property lists all of the users/groups in the friend list. services[]{}? - Services associated with the feed (e.g., Twitter or an imported blog) * id - the service's id, e.g., "picasa" * name - the service's official name, e.g., "Picasa Web Albums" * url - the official URL of the service, e.g., "http://picasaweb.google.com/" * icon - the URL of the favicon for this service * profile? - the profile URL for this service, if any * username? - the username for this service, if any
string uuid = 1
Feed
string id = 2
string name = 3
string picture = 4
string description = 5
string type = 6
One of "user", "group", or "special"
bool private = 7
true if the feed is private
repeated string commands = 8
repeated entries = 9
repeated following = 10
Feedinfo
repeated followers = 11
repeated admins = 12
repeated feeds = 13
for list
repeated services = 14
rpc PostTweet (, )
api.proto:39message
feed.proto:324string id = 1
string created_at = 2
string text = 3
optional user = 4
bool is_retweet = 5
share without adding comment
bool is_quote = 6
share with added comment
optional retweet = 7
repeated medias = 8
int32 reply_count = 9
int32 retweet_count = 10
int32 quote_count = 11
int32 favorite_count = 12
int32 view_count = 13
string in_reply_to = 14
rpc PutOAuth (, )
api.proto:46rpc RefreshFeedService (, )
api.proto:55message
api.proto:330string actor_uuid = 1
string target_feed_uuid = 2
string service_id = 3
rpc RejectFollowRequest (, )
api.proto:74rpc RemoveFeedService (, )
api.proto:52message
api.proto:307string actor_uuid = 1
string target_feed_uuid = 2
string service_id = 3
rpc RemoveGroupAdmin (, )
api.proto:62rpc RemoveGroupMember (, )
api.proto:63rpc RenewTaskLease (, )
api.proto:17message
api.proto:166string worker_id = 1
string task_id = 2
uint64 lease_epoch = 3
rpc RequestFollow (, )
api.proto:71message
api.proto:435bool requested = 1
true when a pending request now exists; false when the actor already follows the target and no request was needed.
rpc Search (, )
api.proto:44message
api.proto:336string query = 1
int32 start = 2
int32 page_size = 3
string viewer_uuid = 4
viewer_uuid carries the session user so private-Group results can be filtered server-side per docs/group.md; empty means anonymous.
rpc SetFeedServiceEnabled (, )
api.proto:54message
api.proto:323string actor_uuid = 1
string target_feed_uuid = 2
string service_id = 3
bool enabled = 4
rpc UpdateGroup (, )
api.proto:64message
api.proto:368UpdateGroupRequest edits a Group's mutable metadata. actor_uuid must be a Group admin or super, per docs/group.md's manage_group permission. id, type and private are not editable through this RPC.
string actor_uuid = 1
string group_uuid = 2
string name = 3
string description = 4
string picture = 5
service Realtime
realtime.proto:25Realtime is deliberately separate from the legacy Api service so its server-streaming lifecycle and generated stubs can evolve independently.
rpc SubscribeRealtimeEvents (, stream )
realtime.proto:26message
realtime.proto:19string subscriber_id = 1
message
realtime.proto:12string viewer_uuid = 1
RealtimeEventType type = 2
string object_uuid = 3
int64 activity_at_ms = 4
message
feed.proto:372Comment id - The id of the comment date - The date the comment was posted. body - The HTML body of the comment. URLs are turned into links. from{} - The user or group who posted this comment, a feed object via{}? - present if comment was created by a third party application. * name - the name of the application, e.g., "BuddyFeed" * url - URL of the source, e.g., "http://www.codewalrus.com/buddyfeed/" commands[]? - List of allowed commands for the authenticated user: "edit", "delete"
Used in: , ,
string id = 1
string date = 2
string body = 3
string rawBody = 4
optional from = 5
optional via = 6
repeated string commands = 7
bool placeholder = 8
when maxcomments=auto on feed
int32 num = 9
message
feed.proto:297Entry id - The FriendFeed entry id, used to add comments/likes to the entry url - URL of the entry page on the FriendFeed website. date - The date the entry was posted. body - The HTML body of the entry. URLs are turned into links. A best effort is made to resolve shortened URLs and use the final destination as the title of the link. from{} - The user or group who posted this entry, a feed object to[]{}? - List of feeds to which this entry was published, a list of feed objects comments[]{}? - list of comments ordered by date likes[]{}? - list of likes for this entry, ordered to present the authenticated user's friends first, and then all other other people who liked the entry thumbnails[]{}? - List of thumbnails * url - Image URL * link - The URL the thumbnail should link to * width? - Image width * height? - Image height * player? - the player for this media file (e.g., the YouTube.com <embed> code) files[]{}? - List of files attached to this entry * url - File URL * type - File MIME type (e.g., "application/pdf") * name - File name * icon - URL of file type icon. Always 16x16. * size? - File size in bytes via{}? - If present, the application or service that created the entry. * name - The name of the entry source, e.g., "Google Reader", "Bookmarklet" * url - URL of the entry source geo{}? - Present if the entry contains geographic information * lat - The latitude * long - The longitude commands[]? - List of allowed commands for the authenticated user: "comment", "like", "unlike", "edit", "delete", "hide", "unhide"
Used as request type in: Api.ArchiveFeed, Api.ForceArchiveFeed, Api.PostEntry
Used as response type in: Api.CommentEntry, Api.DeleteComment, Api.LikeEntry, Api.PostEntry, Api.PostTweet
Used as field type in: , ,
string id = 1
entry uuid with prefix: "e/"
string url = 2
string date = 3
string title = 17
string body = 4
string rawBody = 5
FIXME: use bytes
string rawLink = 6
optional from = 7
repeated to = 8
repeated comments = 9
repeated likes = 10
repeated thumbnails = 11
repeated files = 12
optional via = 13
optional geo = 14
repeated string commands = 15
string profile_uuid = 16
custom filed TODO: duplicated with from field
string feed_uuid = 18
string type = 19
message
api.proto:267Used as request type in: Api.DeleteEntry, Api.FetchEntry
Used as response type in: Api.DeleteEntry
string uuid = 1
string user = 2
string viewer_uuid = 3
UUID of the user viewing this entry. Used for private group access control. Optional for backwards compatibility; if empty, assumes public access only.
Used in:
FAIL_TASK_OUTCOME_UNSPECIFIED = 0
FAIL_TASK_OUTCOME_RETRY = 1
FAIL_TASK_OUTCOME_DEAD = 2
message
feed.proto:158Feed id - The feed id, e.g., "bret" or "bret/comments" name - Display name of the feed, e.g., "Bret Taylor" sup_id - Simple Update Protocol description? - Profile description, an HTML string type - One of "user", "group", or "special" private - true if the feed is private. commands[]? - List of allowed commands for the authenticated user on this feed: "subscribe", "unsubscribe", "post", "dm", "admin" Full feeds have all of the fields above, plus the following field: entries[]{} - List of the entries in this feed.
Used as response type in: Api.FetchEntry, Api.FetchFeed, Api.Search
Used as field type in: , ,
string uuid = 1
string id = 2
string name = 3
string picture = 4
string description = 5
string type = 6
One of "user", "group", or "special"
bool private = 7
true if the feed is private
repeated string commands = 8
repeated entries = 9
string next_cursor = 10
Opaque positions used only by cursor-paged profile and timeline feeds.
bool has_pending_follow_request = 11
true when the viewer has a pending follow request against this feed.
message
feed.proto:243services[]{}? - Services associated with the feed (e.g., Twitter or an imported blog) * id - the service's id, e.g., "picasa" * name - the service's official name, e.g., "Picasa Web Albums" * url - the official URL of the service, e.g., "http://picasaweb.google.com/" * icon - the URL of the favicon for this service * profile? - the profile URL for this service, if any * username? - the username for this service, if any
Used as response type in: Api.AddFeedService, Api.SetFeedServiceEnabled
Used as field type in: , ,
string id = 1
string name = 2
string icon = 3
string profile = 4
string username = 5
optional oauth = 6
int64 created = 7
int64 updated = 8
string kind = 9
string service_uuid = 10
bool enabled = 11
string added_by_uuid = 12
string authorized_by_uuid = 13
message
feed.proto:60string service_uuid = 1
string target_feed_uuid = 2
string service_id = 3
message
api.proto:172Used as response type in: Api.ArchiveFeed, Api.ForceArchiveFeed
string id = 1
int32 entry_count = 2
string date_start = 3
string date_end = 4
int32 elapsed_time = 5
user = 0
group = 1
special = 2
message
feed.proto:420File url - File URL type - File MIME type (e.g., "application/pdf") name - File name icon - URL of file type icon. Always 16x16. size? - File size in bytes
Used in:
string url = 1
string type = 2
string name = 3
string icon = 4
int32 size = 5
message
feed.proto:218not really used see: server.GraphFollow
string id = 1
string name = 2
string type = 3
message
api.proto:444FollowRequestAction approves or rejects one pending request. actor_uuid must be the feed owner (user feed) or a Group admin/super; target_uuid is the requester.
Used as request type in: Api.ApproveFollowRequest, Api.RejectFollowRequest
string actor_uuid = 1
string feed_uuid = 2
string target_uuid = 3
message
api.proto:460FollowRequestItem is one pending request with the requester's Profile.
Used in:
optional requester = 1
string requested_at = 2
message
feed.proto:224string id = 1
string name = 2
string type = 3
message
api.proto:481GroupMember is one member Profile with its admin-role flag.
Used in:
optional profile = 1
bool is_admin = 2
message
api.proto:359GroupMembershipRequest covers Join/Leave/AddGroupAdmin/RemoveGroupAdmin/ RemoveGroupMember. actor_uuid is the caller whose authorization is checked server-side; target_uuid is the member being acted on. For JoinGroup/LeaveGroup, actor_uuid and target_uuid are the same user acting on their own membership.
Used as request type in: Api.AddGroupAdmin, Api.JoinGroup, Api.LeaveGroup, Api.RemoveGroupAdmin, Api.RemoveGroupMember
string actor_uuid = 1
string group_uuid = 2
string target_uuid = 3
message
feed.proto:68HomeRebuildPayload maintains one viewer's Home cache after a Follow edge changes. Legacy payloads with only viewer_uuid request a full rebuild.
string viewer_uuid = 1
string feed_uuid = 2
string action = 3
add or remove
uint32 limit = 4
add only; currently 100
message
api.proto:255Used in:
optional entry = 1
optional like = 2
optional latest_comment = 3
Used in:
INTERACTION_KIND_UNSPECIFIED = 0
INTERACTION_KIND_LIKE = 1
INTERACTION_KIND_COMMENT = 2
message
feed.proto:390Like date from{} - The user who liked the parent entry.
Used in: ,
string date = 1
optional from = 2
string body = 3
when maxlikes=auto on feed
bool placeholder = 8
int32 num = 9
message
feed.proto:437geographic information
Used in:
double latitude = 1
double longitude = 2
message
feed.proto:86Used as request type in: Api.BindUserFeed, Api.PutOAuth
Used as response type in: Api.BindUserFeed
Used as field type in:
string uuid = 1
string user_id = 2
User info from oauth2 providers sequence
string name = 3
login
string nick_name = 4
string avater_url = 5
string email = 6
string access_token = 7
string access_token_secret = 10
string provider = 8
string avatar_url = 11
string description = 12
message
feed.proto:105id map
Used as response type in: Api.CreateGroup, Api.FetchProfile, Api.PostFeedinfo, Api.PutOAuth, Api.UpdateGroup
Used as field type in: , , , , , , ,
string uuid = 1
the FriendFeed UUID
string id = 2
v1 nickname or v2 id, in URL
string name = 3
the user's full name, display name
string picture = 9
string type = 4
One of "user", "group", or "special"
bool private = 5
true if the feed is private
string description = 7
bool deleted = 10
mark deletion, will purge all related data later
bool is_super = 11
super admin
message
api.proto:275Used as request type in: Api.FetchGraph, Api.FetchProfile
string uuid = 1
string id = 2
Resolve by profile ID when uuid is empty.
Used in:
REALTIME_EVENT_UNSPECIFIED = 0
REALTIME_EVENT_TIMELINE_DIRTY = 1
REALTIME_EVENT_NOTIFICATIONS_DIRTY = 2
message
api.proto:430RequestFollow asks to follow a private feed (user feed or Group). The actor is the requester; approval comes from the feed owner or a Group admin via FollowRequestAction.
Used as request type in: Api.CancelFollowRequest, Api.RequestFollow
string actor_uuid = 1
string feed_uuid = 2
message
feed.proto:23string uuid = 1
string kind = 2
string canonical_url = 3
string title = 4
string site_url = 5
string icon_url = 6
int64 created_at_ms = 7
int64 updated_at_ms = 8
string fetch_url = 9
Mutable endpoint learned from a verified permanent redirect. canonical_url remains the immutable identity used to derive uuid.
message
feed.proto:56string service_uuid = 1
message
feed.proto:37Used in:
string service_uuid = 1
string etag = 2
string last_modified = 3
int64 last_fetch_ms = 4
int64 next_fetch_ms = 5
uint32 consecutive_failures = 6
int32 http_status = 7
uint32 empty_fetches = 8
string last_error = 9
string status = 10
active, degraded, or dead. Empty is active for existing rows.
uint32 permanent_failures = 11
uint32 delivery_failures = 12
int64 last_success_ms = 13
int64 dead_at_ms = 14
int64 permanent_failure_since_ms = 15
private = 0
public = 1
message
api.proto:99Used as response type in: Api.RenewTaskLease
Used as field type in: , ,
string id = 1
string type = 2
bytes payload = 3
uint32 payload_version = 4
string idempotency_key = 5
TaskState state = 6
int64 run_at_ms = 7
uint32 attempts = 8
uint32 max_attempts = 9
int64 lease_until_ms = 10
string leased_by = 11
uint64 lease_epoch = 12
string last_error = 13
int64 created_at_ms = 14
int64 updated_at_ms = 15
int64 claimed_at_ms = 16
message
api.proto:118optional task = 1
TaskCompletionStatus status = 2
string last_error = 3
int64 finished_at_ms = 4
Used in:
TASK_COMPLETION_STATUS_UNSPECIFIED = 0
TASK_COMPLETION_STATUS_OK = 1
TASK_COMPLETION_STATUS_DEAD = 2
Used in:
TASK_STATE_UNSPECIFIED = 0
TASK_STATE_READY = 1
TASK_STATE_INFLIGHT = 2
message
feed.proto:406thumbnails - List of thumbnails * url - Image URL * link - The URL the thumbnail should link to * width? - Image width * height? - Image height * player? - the player for this media file (e.g., the YouTube.com <embed> code)
Used in: ,
string url = 1
string link = 2
int32 width = 3
int32 height = 4
string player = 5
message
feed.proto:352Used in:
string id = 1
string created_at = 2
string name = 3
string screen_name = 4
string profile_image_url = 5
string description = 6
int64 followers_count = 7
message
feed.proto:431Via name - the name of the application, e.g., "BuddyFeed" url - URL of the source, e.g., "http://www.codewalrus.com/buddyfeed/"
Used in: ,
string name = 1
string url = 2