// Async enrichment: API returns immediately; OG data is attached in the background
await client.updateApp({ async_url_enrich_enabled: true });
// Sync enrichment: API waits for OG scraping (up to ~4s) before responding
await client.updateApp({ async_url_enrich_enabled: false });URL Previews
Overview
When you add an activity or comment that contains a URL in the text, Stream can automatically fetch Open Graph (OG) metadata and attach a preview. This works for both activities and comments. You can disable enrichment per request with skip_enrich_url.
You can also use Stream's getOG endpoint to fetch OG data on your own.
Sync vs async enrichment
async_url_enrich_enabled is an app-level setting that controls how URL enrichment is done:
- When enabled (async): The server saves the activity or comment first and enriches URLs in the background. The API responds without waiting for OG scraping.
- When disabled (sync): The server does URL enrichment before responding, with a ~4 second timeout for OG scraping.
Configure it via updateApp (server-side only):
# Async enrichment: API returns immediately; OG data is attached in the background
client.common.update_app(GetStream::Generated::Models::UpdateAppRequest.new(async_url_enrich_enabled: true))
# Sync enrichment: API waits for OG scraping (up to ~4s) before responding
client.common.update_app(GetStream::Generated::Models::UpdateAppRequest.new(async_url_enrich_enabled: false))Activities with URL enrichment
request = GetStream::Generated::Models::AddActivityRequest.new(
feeds: ['user:eric'],
type: 'post',
text: 'Check this out: https://example.com/article',
user_id: 'eric'
)
response = client.feeds.add_activity(request)
# response.activity.attachments may include OG preview when enrichment completesComments with URL enrichment
Comments support the same behavior: URLs in the comment text are enriched by default. Use skip_enrich_url: true when adding a comment to skip enrichment.
client.feeds.add_comment(
GetStream::Generated::Models::AddCommentRequest.new(
comment: 'See also: https://example.com/related',
object_id: activity_id,
object_type: 'activity',
user_id: 'alice'
)
)Skipping URL enrichment
To avoid fetching OG metadata for a given activity or comment, set skip_enrich_url to true.
# Activity
client.feeds.add_activity(
GetStream::Generated::Models::AddActivityRequest.new(
feeds: ['user:eric'],
type: 'post',
text: 'https://example.com/page',
user_id: 'eric',
skip_enrich_url: true
)
)
# Comment
client.feeds.add_comment(
GetStream::Generated::Models::AddCommentRequest.new(
comment: 'https://example.com/page',
object_id: activity_id,
object_type: 'activity',
user_id: 'alice',
skip_enrich_url: true
)
)Reading URL preview attachments
Activities and comments return an attachments array. Enriched URL previews appear as attachments with fields such as:
og_scrape_url– URL that was scrapedtitle– OG titletitle_link– OG urltext– OG descriptionimage_urlorthumb_url– OG imagetype– e.g.image,video, oraudioasset_url- link to the video/audio the link points to or empty
Use these fields to render link previews in your UI. Below: reading attachments from an activity and from a comment.
# From an activity
r = client.feeds.get_activity(activity_id)
(r.activity.attachments || []).each do |a|
# use a.title, a.image_url, a.og_scrape_url, etc.
end
# From a comment
(r.activity.latest_replies || []).each do |comment|
(comment.attachments || []).each do |a|
# use a.title, a.image_url, a.og_scrape_url, etc.
end
endURL enrichment using getOG endpoint
You can fetch Open Graph metadata for a URL without adding an activity or comment by calling the Get OG endpoint. This is useful if you want to show URL enrichment to users before an activity or comment is sent. You can then persist OG data in attachments when sending the activity or comment (make sure to set skip_enrich_url to avoid duplicate previews).
If OG data can't be fetched for the given URL, the API request is rejected with an error.
url = 'https://example.com/article'
og = client.get_og(GetStream::Generated::Models::GetOGRequest.new(url: url))
# Activity
client.feeds.add_activity(
GetStream::Generated::Models::AddActivityRequest.new(
feeds: ['user:eric'],
type: 'post',
text: "Check this out: #{url}",
user_id: 'eric',
skip_enrich_url: true,
attachments: [og.to_h]
)
)
# Comment
client.feeds.add_comment(
GetStream::Generated::Models::AddCommentRequest.new(
comment: "See also: #{url}",
object_id: activity_id,
object_type: 'activity',
user_id: 'alice',
skip_enrich_url: true,
attachments: [og.to_h]
)
)