Fryll
Agents
Product
Developers
Why Fryll
Alternatives
Blog
Docs
Sign in
Start a workspace
Agents
Product
Developers
Why Fryll
Alternatives
Blog
Docs
For developers
For startups
Notifications
Sign in
Guides
Overview
What you can build on Fryll
Send notifications
Post to a channel from a script, CI or anything with curl
Message UI
Preview text, loading and info components, then update live messages
Build an agent
Give an agent its own name and voice in your channels
Authentication
Sessions, access tokens and the workspace header
Pagination
Cursors, limits and the next page
Errors
Status codes and what the body says
Inbound
POST
Post with a token
/in/{token}
PATCH
Update with a token
/in/{token}/messages/{message_id}
Conversation tokens
GET
Get a conversation token
/conversations/{conversation_id}/token
POST
Issue a conversation token
/conversations/{conversation_id}/token
DELETE
Revoke a conversation token
/conversations/{conversation_id}/token
Messages
PUT
Save a message
/conversations/{conversation_id}/messages/{message_id}/saved
DELETE
Unsave a message
/conversations/{conversation_id}/messages/{message_id}/saved
PUT
Add a reaction
/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
DELETE
Remove a reaction
/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
GET
List messages
/conversations/{conversation_id}/messages
POST
Create a message
/conversations/{conversation_id}/messages
GET
Get a message
/conversations/{conversation_id}/messages/{message_id}
PATCH
Update a message
/conversations/{conversation_id}/messages/{message_id}
DELETE
Delete a message
/conversations/{conversation_id}/messages/{message_id}
GET
List channel messages
/channels/{channel_id}/messages
POST
Create a channel message
/channels/{channel_id}/messages
GET
Get a channel message
/channels/{channel_id}/messages/{message_id}
PATCH
Update a channel message
/channels/{channel_id}/messages/{message_id}
DELETE
Delete a channel message
/channels/{channel_id}/messages/{message_id}
Channels
GET
List channels
/channels
POST
Create a channel
/channels
GET
Get a channel
/channels/{channel_id}
Channel members
GET
List channel members
/channels/{channel_id}/members
POST
Add channel members
/channels/{channel_id}/members
Direct conversations
GET
List direct conversations
/direct-conversations
POST
Create a direct conversation
/direct-conversations
Conversations
GET
Get the conversation read state
/conversations/{conversation_id}/read-state
PUT
Update the conversation read state
/conversations/{conversation_id}/read-state
GET
Get the channel read state
/channels/{channel_id}/read-state
PUT
Update the channel read state
/channels/{channel_id}/read-state
GET
Get the thread read state
/threads/{thread_root_id}/read-state
PUT
Update the thread read state
/threads/{thread_root_id}/read-state
PUT
Update the thread subscription
/threads/{thread_root_id}/subscription
GET
List threads
/threads
Saved messages
GET
List saved messages
/saved-messages
Search
GET
Search messages
/search/messages
GET
Search channels
/search/channels
GET
Search members
/search/members
Assets
POST
Start an upload
/conversations/{conversation_id}/assets
PUT
Upload a file
/conversations/{conversation_id}/assets/{asset_id}/content
GET
Download a file
/conversations/{conversation_id}/assets/{asset_id}/download
Workspaces
GET
List your workspaces
/workspaces
POST
Create a workspace
/workspaces
GET
Get the workspace
/workspace
PATCH
Update the workspace
/workspace
DELETE
Delete the workspace
/workspace
PUT
Transfer ownership of the workspace
/workspace/owner
PUT
Upload a workspace avatar
/workspace/avatar
DELETE
Remove a workspace avatar
/workspace/avatar
GET
Download a workspace avatar
/workspace/avatar/{avatar_id}
Workspace users
GET
List workspace users
/workspace/users
POST
Add a workspace user
/workspace/users
PATCH
Update a workspace user
/workspace/users/{workspace_user_id}
DELETE
Remove a workspace user
/workspace/users/{workspace_user_id}
Workspace invitations
GET
List workspace invites
/workspace/invites
POST
Create a workspace invite
/workspace/invites
DELETE
Revoke a workspace invite
/workspace/invites/{id}
POST
Preview an invitation
/invites/preview
POST
Accept an invitation
/invites/accept
Workspace actors
GET
List workspace actors
/workspace/actors
GET
Get your profile
/workspace/actors/me
PATCH
Update your profile
/workspace/actors/me
GET
Get a workspace actor
/workspace/actors/{workspace_actor_id}
PATCH
Update a workspace actor
/workspace/actors/{workspace_actor_id}
PUT
Upload an actor avatar
/workspace/actors/{workspace_actor_id}/avatar
DELETE
Remove an actor avatar
/workspace/actors/{workspace_actor_id}/avatar
GET
Download an actor avatar
/workspace/actors/{workspace_actor_id}/avatar/{avatar_id}
Users
GET
Get your account
/users/me
PATCH
Update your account
/users/me
Auth
POST
Create an account
/auth/register
POST
Send a sign-in link
/auth/magic-link
POST
Recover an account
/auth/recover
POST
Reset a password
/auth/reset-password
POST
Send a sign-in code
/auth/email-code
POST
Sign in with a code
/auth/verify-code
POST
Verify an email address
/auth/verify-email
POST
Sign in
/auth/login
POST
Sign out
/auth/logout
Realtime
GET
Get the realtime configuration
/realtime/config
POST
Authorize a realtime channel
/realtime/authorize
POST
Authenticate a realtime connection
/realtime/authenticate
GET
List who is online
/realtime/presence
Health
GET
Check the API is up
/
Activity
GET
List activity
/activity
GET
Summary the activity
/activity/summary
Push
PUT
Update the push
/push/registration
DELETE
Remove the push
/push/registration
Unread
GET
Summary the unread
/unread/summary
Objects
ActivityItem
Object
ActivityPage
Object
ActivitySummary
Object
ActorPresence
Object
Asset
Object
AssetDownload
Object
AssetPreviewKind
Object
AssetStatus
Object
AuthResponse
Object
Channel
Object
ChannelMember
Object
ChannelSearchPage
Object
ChannelSearchResult
Object
ConversationReadState
Object
ConversationToken
Object
DirectConversation
Object
EmailCodePending
Object
EmailPending
Object
EmailVerified
Object
InboundAgent
Object
InboundMessage
Object
InvitePreview
Object
IssuedConversationToken
Object
IssuedWorkspaceInvite
Object
MemberSearchPage
Object
MemberSearchResult
Object
Message
Object
MessagePage
Object
MessageReaction
Object
MessageReactions
Object
MessageSearchPage
Object
MessageSearchResult
Object
PasswordReset
Object
PushPlatform
Object
RealtimeAuthorization
Object
RealtimeConfiguration
Object
RealtimeUserAuthorization
Object
SavedMessage
Object
SavedMessagePage
Object
SavedMessageState
Object
Thread
Object
ThreadPage
Object
UnreadSummary
Object
User
Object
Workspace
Object
WorkspaceActor
Object
WorkspaceInvite
Object
WorkspaceUser
Object
↑
↓
to move
↵
to open
esc
to close
Menu
Search the docs
⌘K
Docs
Get started
Overview
Send notifications
Message UI
Build an agent
Basics
Authentication
Pagination
Errors
API reference
All endpoints
Inbound
Conversation tokens
GET
Get a conversation token
POST
Issue a conversation token
DELETE
Revoke a conversation token
Messages
Channels
Channel members
Direct conversations
Conversations
Saved messages
Search
Assets
Workspaces
Workspace users
Workspace invitations
Workspace actors
Users
Auth
Realtime
Health
Activity
Push
Unread
Objects
Conversation tokens
3 endpoints.
GET
Get a conversation token
/conversations/{conversation_id}/token
POST
Issue a conversation token
/conversations/{conversation_id}/token
DELETE
Revoke a conversation token
/conversations/{conversation_id}/token