[Closed Alpha] Search documents
[Closed Alpha] Search documents using a query string and return relevant results.
{
"success": true,
"documents": {
"posts": [
{
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"read_time_minutes": 5,
"file_attachments_count": 1,
"reactions_count": 10,
"comments_count": 2,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"cover_image_url": "https://example.com/my-image.png",
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
],
"comments": [
{
"id": "3e8d8ad8-c25d-4194-a8ae-11c39eaef919",
"created_at": "2024-02-01 04:04:39.198523+00",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"parent_post_id": "w6sy87nsu78w",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"file_attachments_count": 1,
"reactions_count": 10,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"parent_post": {
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post"
},
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Search query string
1"search term"
Response
Post
"w6sy87nsu78w"
"2024-02-01 04:04:39.198523+00"
"My Post"
"my-post"
"91795199-9d00-47c7-bd6e-d4049bb63451"
"03ff107d-099f-4426-81a6-a04690d7afz3"
The estimated time to read the post in minutes
5
1
10
2
Slack Message
"1519c63a-f8cf-4897-a76e-ef556d5fd915"
The Slack message timestamp
1737338258.891569
The message in Slack blocks format for rich text input element.
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [{ "text": "Hello, world!", "type": "text" }]
}
]
}
]
The Slack message content in mrkdwn format
"This is the message mrkdwn text."
The URL permalink to the Slack message
"https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ"
The ID of the top-most parent Slack message, if this is a threaded reply
"97d5c5d6-d036-4223-9bd3-876a0cf47751"
"03ff107d-099f-4426-81a6-a04690d7afz3"
"2024-02-01 04:04:39.198523+00"
"John D."
"John"
"Doe"
"U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead. "U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
References to external entities mentioned in the contents of the Slack blocks
The users tagged in the Slack blocks
"03ff107d-099f-4426-81a6-a04690d7afz3"
"2024-02-01 04:04:39.198523+00"
"John D."
"John"
"Doe"
"U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
The custom emojis used in the Slack blocks
Slack Custom Emoji usage
The URLs used in the Slack blocks
Slack Blocks URL usage
0-indexed order of the URL in the Slack blocks
0
Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text
false
Whether the URL refers to an image
true
Whether the URL refers to a video
false
"https://example.com/tacos.png"
The URL of the cover image for the post
"https://example.com/my-image.png"
Comment
"3e8d8ad8-c25d-4194-a8ae-11c39eaef919"
"2024-02-01 04:04:39.198523+00"
"91795199-9d00-47c7-bd6e-d4049bb63451"
"w6sy87nsu78w"
"03ff107d-099f-4426-81a6-a04690d7afz3"
1
10
Slack Message
"1519c63a-f8cf-4897-a76e-ef556d5fd915"
The Slack message timestamp
1737338258.891569
The message in Slack blocks format for rich text input element.
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [{ "text": "Hello, world!", "type": "text" }]
}
]
}
]
The Slack message content in mrkdwn format
"This is the message mrkdwn text."
The URL permalink to the Slack message
"https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ"
The ID of the top-most parent Slack message, if this is a threaded reply
"97d5c5d6-d036-4223-9bd3-876a0cf47751"
Post summary
"w6sy87nsu78w"
"2024-02-01 04:04:39.198523+00"
"My Post"
"my-post"
"03ff107d-099f-4426-81a6-a04690d7afz3"
"2024-02-01 04:04:39.198523+00"
"John D."
"John"
"Doe"
"U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead. "U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
References to external entities mentioned in the contents of the Slack blocks
The users tagged in the Slack blocks
"03ff107d-099f-4426-81a6-a04690d7afz3"
"2024-02-01 04:04:39.198523+00"
"John D."
"John"
"Doe"
"U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
The custom emojis used in the Slack blocks
Slack Custom Emoji usage
The name of the aliased emoji, if this is an alias
"wow"
"https://example.com/wow.png"
The URLs used in the Slack blocks
Slack Blocks URL usage
0-indexed order of the URL in the Slack blocks
0
Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text
false
Whether the URL refers to an image
true
Whether the URL refers to a video
false
"https://example.com/tacos.png"
Was this page helpful?
{
"success": true,
"documents": {
"posts": [
{
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"read_time_minutes": 5,
"file_attachments_count": 1,
"reactions_count": 10,
"comments_count": 2,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"cover_image_url": "https://example.com/my-image.png",
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
],
"comments": [
{
"id": "3e8d8ad8-c25d-4194-a8ae-11c39eaef919",
"created_at": "2024-02-01 04:04:39.198523+00",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"parent_post_id": "w6sy87nsu78w",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"file_attachments_count": 1,
"reactions_count": 10,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"parent_post": {
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post"
},
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
]
}
}