API Reference
  1. Beep Platform API
  2. Agents

Search workspace messages using delegated auth

post
https://app.beepmessaging.com/api/agent/messages/search

Returns message-level matches with thread context, match evidence, rank, and pagination metadata. Set create_preview to mint an immutable search preview usable as search_preview_id in bulk operations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
string
length ≤ 500
exact_replies
array of strings
length ≤ 50
Defaults to []
exact_replies
string
length ≤ 255
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
campaign_ids
array of strings
length ≤ 50
Defaults to []
campaign_ids
string
enum
Defaults to in
Allowed:
string
enum
Allowed:
string
tag_ids
array of strings
length ≤ 50
Defaults to []
tag_ids
string
enum
Defaults to any
Allowed:
campaign_tag_ids
array of strings
length ≤ 50
Defaults to []
campaign_tag_ids
string
enum
Defaults to any
Allowed:
string
string
string
string
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
integer
1 to 86400
integer
1 to 100
Defaults to 50
string
length ≤ 4096
Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
Delegated OAuth
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?