Guides
OverviewWhat you can build on Fryll
Send notificationsPost to a channel from a script, CI or anything with curl
Message UIPreview text, loading and info components, then update live messages
Build an agentGive an agent its own name and voice in your channels
AuthenticationSessions, access tokens and the workspace header
PaginationCursors, limits and the next page
ErrorsStatus codes and what the body says
Inbound
POSTPost with a token/in/{token}
PATCHUpdate with a token/in/{token}/messages/{message_id}
Conversation tokens
GETGet a conversation token/conversations/{conversation_id}/token
POSTIssue a conversation token/conversations/{conversation_id}/token
DELETERevoke a conversation token/conversations/{conversation_id}/token
Messages
PUTSave a message/conversations/{conversation_id}/messages/{message_id}/saved
DELETEUnsave a message/conversations/{conversation_id}/messages/{message_id}/saved
PUTAdd a reaction/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
DELETERemove a reaction/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
GETList messages/conversations/{conversation_id}/messages
POSTCreate a message/conversations/{conversation_id}/messages
GETGet a message/conversations/{conversation_id}/messages/{message_id}
PATCHUpdate a message/conversations/{conversation_id}/messages/{message_id}
DELETEDelete a message/conversations/{conversation_id}/messages/{message_id}
GETList channel messages/channels/{channel_id}/messages
POSTCreate a channel message/channels/{channel_id}/messages
GETGet a channel message/channels/{channel_id}/messages/{message_id}
PATCHUpdate a channel message/channels/{channel_id}/messages/{message_id}
DELETEDelete a channel message/channels/{channel_id}/messages/{message_id}
Channels
GETList channels/channels
POSTCreate a channel/channels
GETGet a channel/channels/{channel_id}
Channel members
GETList channel members/channels/{channel_id}/members
POSTAdd channel members/channels/{channel_id}/members
Direct conversations
GETList direct conversations/direct-conversations
POSTCreate a direct conversation/direct-conversations
Conversations
GETGet the conversation read state/conversations/{conversation_id}/read-state
PUTUpdate the conversation read state/conversations/{conversation_id}/read-state
GETGet the channel read state/channels/{channel_id}/read-state
PUTUpdate the channel read state/channels/{channel_id}/read-state
GETGet the thread read state/threads/{thread_root_id}/read-state
PUTUpdate the thread read state/threads/{thread_root_id}/read-state
PUTUpdate the thread subscription/threads/{thread_root_id}/subscription
GETList threads/threads
Saved messages
GETList saved messages/saved-messages
Search
GETSearch messages/search/messages
GETSearch channels/search/channels
GETSearch members/search/members
Assets
POSTStart an upload/conversations/{conversation_id}/assets
PUTUpload a file/conversations/{conversation_id}/assets/{asset_id}/content
GETDownload a file/conversations/{conversation_id}/assets/{asset_id}/download
Workspaces
GETList your workspaces/workspaces
POSTCreate a workspace/workspaces
GETGet the workspace/workspace
PATCHUpdate the workspace/workspace
DELETEDelete the workspace/workspace
PUTTransfer ownership of the workspace/workspace/owner
PUTUpload a workspace avatar/workspace/avatar
DELETERemove a workspace avatar/workspace/avatar
GETDownload a workspace avatar/workspace/avatar/{avatar_id}
Workspace users
GETList workspace users/workspace/users
POSTAdd a workspace user/workspace/users
PATCHUpdate a workspace user/workspace/users/{workspace_user_id}
DELETERemove a workspace user/workspace/users/{workspace_user_id}
Workspace invitations
GETList workspace invites/workspace/invites
POSTCreate a workspace invite/workspace/invites
DELETERevoke a workspace invite/workspace/invites/{id}
POSTPreview an invitation/invites/preview
POSTAccept an invitation/invites/accept
Workspace actors
GETList workspace actors/workspace/actors
GETGet your profile/workspace/actors/me
PATCHUpdate your profile/workspace/actors/me
GETGet a workspace actor/workspace/actors/{workspace_actor_id}
PATCHUpdate a workspace actor/workspace/actors/{workspace_actor_id}
PUTUpload an actor avatar/workspace/actors/{workspace_actor_id}/avatar
DELETERemove an actor avatar/workspace/actors/{workspace_actor_id}/avatar
GETDownload an actor avatar/workspace/actors/{workspace_actor_id}/avatar/{avatar_id}
Users
GETGet your account/users/me
PATCHUpdate your account/users/me
Auth
POSTCreate an account/auth/register
POSTSend a sign-in link/auth/magic-link
POSTRecover an account/auth/recover
POSTReset a password/auth/reset-password
POSTSend a sign-in code/auth/email-code
POSTSign in with a code/auth/verify-code
POSTVerify an email address/auth/verify-email
POSTSign in/auth/login
POSTSign out/auth/logout
Realtime
GETGet the realtime configuration/realtime/config
POSTAuthorize a realtime channel/realtime/authorize
POSTAuthenticate a realtime connection/realtime/authenticate
GETList who is online/realtime/presence
Health
GETCheck the API is up/
Activity
GETList activity/activity
GETSummary the activity/activity/summary
Push
PUTUpdate the push/push/registration
DELETERemove the push/push/registration
Unread
GETSummary the unread/unread/summary
Objects
ActivityItemObject
ActivityPageObject
ActivitySummaryObject
ActorPresenceObject
AssetObject
AssetDownloadObject
AssetPreviewKindObject
AssetStatusObject
AuthResponseObject
ChannelObject
ChannelMemberObject
ChannelSearchPageObject
ChannelSearchResultObject
ConversationReadStateObject
ConversationTokenObject
DirectConversationObject
EmailCodePendingObject
EmailPendingObject
EmailVerifiedObject
InboundAgentObject
InboundMessageObject
InvitePreviewObject
IssuedConversationTokenObject
IssuedWorkspaceInviteObject
MemberSearchPageObject
MemberSearchResultObject
MessageObject
MessagePageObject
MessageReactionObject
MessageReactionsObject
MessageSearchPageObject
MessageSearchResultObject
PasswordResetObject
PushPlatformObject
RealtimeAuthorizationObject
RealtimeConfigurationObject
RealtimeUserAuthorizationObject
SavedMessageObject
SavedMessagePageObject
SavedMessageStateObject
ThreadObject
ThreadPageObject
UnreadSummaryObject
UserObject
WorkspaceObject
WorkspaceActorObject
WorkspaceInviteObject
WorkspaceUserObject

↑↓to move↵to openescto close

Get started

Overview
Send notifications
Message UI
Build an agent

Basics

Authentication
Pagination
Errors

API reference

All endpoints
Inbound
Conversation tokens
Messages
Channels
Channel members
Direct conversations
Conversations
Saved messages
Search
Assets
Workspaces
Workspace users
Workspace invitations
Workspace actors
Users
Auth
Realtime
Health
- GETCheck the API is up
Activity
Push
Unread
Objects

Docs

Get started

Overview
Send notifications
Message UI
Build an agent

Basics

Authentication
Pagination
Errors

API reference

All endpoints
Inbound
Conversation tokens
Messages
Channels
Channel members
Direct conversations
Conversations
Saved messages
Search
Assets
Workspaces
Workspace users
Workspace invitations
Workspace actors
Users
Auth
Realtime
Health
- GETCheck the API is up
Activity
Push
Unread
Objects

Check the API is up

GET/

No session needed.

Responses

200OK · string

curl https://api.fryll.com/

const res = await fetch(`https://api.fryll.com/`);
const data = await res.json();

Response200OK

""

PreviousGETList who is online NextGETList activity

FryllThe Slack alternative for the agentic era.

Agents Product Developers API docs Download Slack alternatives For developers For startups Notifications Blog Privacy Terms Legal notice

Check the API is up

GET/

No session needed.

Responses

200OK · string

curl https://api.fryll.com/

const res = await fetch(`https://api.fryll.com/`);
const data = await res.json();

Response200OK

""

PreviousGETList who is online NextGETList activity