Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.3.1

Jul 21, 2026

v1.3.0

Jul 21, 2026

Changes in this version

+ func AddChatConversationKeys(client Client, conversationID string, body any, opts RequestOptions) (json.RawMessage, error)

+ func AddChatGroupMembers(client Client, conversationID string, body any, opts RequestOptions) (json.RawMessage, error)

+ func ChatConversationEventID(id string) string

+ func ChatConversationPathID(id string) string

+ func CompareChatKeyVersions(a, b string) int

+ func DownloadChatMedia(client Client, conversationID, mediaHashKey string, opts RequestOptions) ([]byte, error)

+ func GetChatConversations(client Client, maxResults int, paginationToken string, opts RequestOptions) (json.RawMessage, error)

+ func GetUserByID(client Client, userID string, opts RequestOptions) (json.RawMessage, error)

+ func InitializeChatMediaUpload(client Client, conversationID string, totalBytes int, opts RequestOptions) (sessionID, mediaHashKey string, err error)

+ func MarkChatRead(client Client, conversationID, seenUntilSequenceID string, opts RequestOptions) (json.RawMessage, error)

+ func SendChatMessage(client Client, conversationID string, body ChatSendBody, opts RequestOptions) (json.RawMessage, error)

+ func SendChatTyping(client Client, conversationID string, opts RequestOptions) (json.RawMessage, error)

+ func UploadChatMedia(client Client, sessionID, conversationID, mediaHashKey string, ...) error

+ type ChatConversationMeta struct

+ AdminIDs []string

+ GroupAvatarURL string

+ GroupName string

+ MemberIDs []string

+ MessageTTLMs *int64

+ ParticipantIDs []string

+ ScreenCaptureBlockingEnabled *bool

+ func GetChatConversation(client Client, conversationID string, opts RequestOptions) (*ChatConversationMeta, json.RawMessage, error)

+ func (m *ChatConversationMeta) AllUserIDs() []string

+ type ChatEventItem struct

+ ConversationID string

+ EncodedEvent string

+ ID string

+ IsTrusted bool

+ SenderID string

+ type ChatEventsPage struct

+ Events []ChatEventItem

+ KeyEvents []string

+ NextToken string

+ func GetChatEvents(client Client, conversationID string, maxResults int, paginationToken string, ...) (*ChatEventsPage, error)

+ type ChatPublicKey struct

+ IdentityPublicKeySignature string

+ JuiceboxConfig json.RawMessage

+ PublicKey string

+ SigningPublicKey string

+ UserID string

+ Version string

+ func GetChatPublicKeys(client Client, userID string, opts RequestOptions) ([]ChatPublicKey, error)

+ func GetChatUsersPublicKeys(client Client, userIDs []string, opts RequestOptions) ([]ChatPublicKey, error)

+ type ChatSendBody struct

+ ConversationToken string

+ EncodedMessageCreateEvent string

+ EncodedMessageEventSignature string

+ MessageID string

v1.2.3

Jul 16, 2026

v1.2.2

Jun 29, 2026

v1.2.1

Jun 29, 2026

v1.2.0

Jun 29, 2026

Changes in this version

+ func DefaultMediaCategory(mediaType string) (string, bool)

+ func DetectMediaType(filePath string) string

v1.1.1

May 14, 2026

v1.1.0

Apr 20, 2026

v1.0.3

Feb 20, 2026

v1.0.2

Feb 20, 2026

Changes in this version

+ const MediaEndpoint

+ var StreamingEndpoints = map[string]bool

+ func BlockUser(client Client, sourceUserID, targetUserID string, opts RequestOptions) (json.RawMessage, error)

+ func Bookmark(client Client, userID, postID string, opts RequestOptions) (json.RawMessage, error)

+ func CreatePost(client Client, text string, mediaIDs []string, opts RequestOptions) (json.RawMessage, error)

+ func DeletePost(client Client, postID string, opts RequestOptions) (json.RawMessage, error)

+ func ExecuteMediaStatus(mediaID, authType, username string, verbose, wait, trace bool, ...) error

+ func ExecuteMediaUpload(filePath, mediaType, mediaCategory, authType, username string, ...) error

+ func ExecuteRequest(options RequestOptions, client Client) error

+ func ExecuteStreamRequest(options RequestOptions, client Client) error

+ func ExtractCommand(url string) string

+ func ExtractMediaID(url string) string

+ func ExtractSegmentIndex(data string) string

+ func FollowUser(client Client, sourceUserID, targetUserID string, opts RequestOptions) (json.RawMessage, error)

+ func GetBookmarks(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetDMEvents(client Client, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetFollowers(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetFollowing(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetLikedPosts(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetMe(client Client, opts RequestOptions) (json.RawMessage, error)

+ func GetMentions(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetTimeline(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func GetUserPosts(client Client, userID string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func HandleMediaAppendRequest(options RequestOptions, mediaFile string, client Client) (json.RawMessage, error)

+ func HandleRequest(options RequestOptions, forceStream bool, mediaFile string, client Client) error

+ func IsMediaAppendRequest(url string, mediaFile string) bool

+ func IsStreamingEndpoint(endpoint string) bool

+ func LikePost(client Client, userID, postID string, opts RequestOptions) (json.RawMessage, error)

+ func LookupUser(client Client, username string, opts RequestOptions) (json.RawMessage, error)

+ func MuteUser(client Client, sourceUserID, targetUserID string, opts RequestOptions) (json.RawMessage, error)

+ func QuotePost(client Client, postID, text string, opts RequestOptions) (json.RawMessage, error)

+ func ReadPost(client Client, postID string, opts RequestOptions) (json.RawMessage, error)

+ func ReplyToPost(client Client, postID, text string, mediaIDs []string, opts RequestOptions) (json.RawMessage, error)

+ func Repost(client Client, userID, postID string, opts RequestOptions) (json.RawMessage, error)

+ func ResolvePostID(input string) string

+ func ResolveUsername(input string) string

+ func SearchPosts(client Client, query string, maxResults int, opts RequestOptions) (json.RawMessage, error)

+ func SendDM(client Client, participantID, text string, opts RequestOptions) (json.RawMessage, error)

+ func UnblockUser(client Client, sourceUserID, targetUserID string, opts RequestOptions) (json.RawMessage, error)

+ func Unbookmark(client Client, userID, postID string, opts RequestOptions) (json.RawMessage, error)

+ func UnfollowUser(client Client, sourceUserID, targetUserID string, opts RequestOptions) (json.RawMessage, error)

+ func UnlikePost(client Client, userID, postID string, opts RequestOptions) (json.RawMessage, error)

+ func UnmuteUser(client Client, sourceUserID, targetUserID string, opts RequestOptions) (json.RawMessage, error)

+ func Unrepost(client Client, userID, postID string, opts RequestOptions) (json.RawMessage, error)

+ type ApiClient struct

+ func NewApiClient(config *config.Config, auth *auth.Auth) *ApiClient

+ func (c *ApiClient) BuildMultipartRequest(options MultipartOptions) (*http.Request, error)

+ func (c *ApiClient) BuildRequest(requestOptions RequestOptions) (*http.Request, error)

+ func (c *ApiClient) SendMultipartRequest(options MultipartOptions) (json.RawMessage, error)

+ func (c *ApiClient) SendRequest(options RequestOptions) (json.RawMessage, error)

+ func (c *ApiClient) StreamRequest(options RequestOptions) error

+ type Client interface

+ BuildMultipartRequest func(options MultipartOptions) (*http.Request, error)

+ BuildRequest func(requestOptions RequestOptions) (*http.Request, error)

+ SendMultipartRequest func(options MultipartOptions) (json.RawMessage, error)

+ SendRequest func(options RequestOptions) (json.RawMessage, error)

+ StreamRequest func(options RequestOptions) error

+ type InitRequest struct

+ MediaCategory string

+ MediaType string

+ TotalBytes int64

+ type MediaUploader struct

+ func NewMediaUploader(client Client, filePath string, verbose, trace bool, authType string, ...) (*MediaUploader, error)

+ func NewMediaUploaderWithoutFile(client Client, verbose, trace bool, authType string, username string, ...) *MediaUploader

+ func (m *MediaUploader) Append() error

+ func (m *MediaUploader) CheckStatus() (json.RawMessage, error)

+ func (m *MediaUploader) Finalize() (json.RawMessage, error)

+ func (m *MediaUploader) GetMediaID() string

+ func (m *MediaUploader) Init(mediaType string, mediaCategory string) error

+ func (m *MediaUploader) SetMediaID(mediaID string)

+ func (m *MediaUploader) WaitForProcessing() (json.RawMessage, error)

+ type MultipartOptions struct

+ FileData []byte

+ FileField string

+ FileName string

+ FilePath string

+ FormFields map[string]string

+ type PostBody struct

+ Media *PostMedia

+ Poll *PostPoll

+ Quote *string

+ Reply *PostReply

+ Text string

+ type PostMedia struct

+ MediaIDs []string

+ type PostPoll struct

+ DurationMinutes int

+ Options []string

+ type PostReply struct

+ InReplyToPostID string

+ type RequestOptions struct

+ AuthType string

+ Data string

+ Endpoint string

+ Headers []string

+ Method string

+ Trace bool

+ Username string

+ Verbose bool