Skip to main content

​
Document Sources and IDs

Below is a list of all currently supported sources
Source ValueConnectorDocument ID Format PatternExample
SLACKSlack{channel_id}_{date}C1234567890_2024-01-15
GITHUB_PRSGitHub{repo_id}_pr_{pr_number}123456789_pr_12345
GITHUB_CODEGitHubgithub_file_{owner}/{repo}/{file_path}github_file_octocat/Hello-World/README.md
NOTIONNotionnotion_page_{page_id}notion_page_abcdefgh-1234-6789-0zxy-w01234567890
LINEARLinearissue_{issue_id}issue_11223344-5566-7788-9900-aabbccddeeff
GOOGLE_DRIVEGoogle Drivegoogle_drive_file_{file_id}google_drive_file_1a2b3c4d5e6f7g8h9i0j
GOOGLE_EMAILGoogle Emailgoogle_email_message_{message_id}google_email_message_18a1b2c3d4e5f6g7
JIRAJirajira_issue_{issue_id}jira_issue_10218
CONFLUENCEConfluenceconfluence_page_{page_id}confluence_page_123456789
HUBSPOT_DEALHubSpothubspot_deal_{record_id}hubspot_deal_12345678
HUBSPOT_CONTACTHubSpothubspot_contact_{record_id}hubspot_contact_99887766
HUBSPOT_TICKETHubSpothubspot_ticket_{record_id}hubspot_ticket_87654321
HUBSPOT_COMPANYHubSpothubspot_company_{record_id}hubspot_company_11223344
SALESFORCESalesforcesalesforce_{object_type}_{record_id}salesforce_account_001xx000003DGb2AAG
GONGGonggong_call_{call_id}gong_call_1234567890123456789
GATHERGathergather_meeting_{meeting_id}gather_meeting_a1b2c3d4-e5f6-7890-abcd-ef1234567890

​
SearchFilters

The SearchFilters object is used by Search Tools to narrow down search results

SearchFilters Properties

​
sources
string[]
List of document sources to filter by. See Document Sources for available values
​
date_from
string
Start date in YYYY-MM-DD format. Only return documents created on or after this date
​
date_to
string
End date in YYYY-MM-DD format. Only return documents created on or before this date
​
provenance
string
Source-specific filter to narrow results within a connector (e.g., Slack channel name, GitHub repository name, Linear team name). See Provenance Filters for details
​
document_id
string
Exact document ID to retrieve. When provided, all other filters are ignored and only this specific document is returned

​
Provenance Filters

The filters.provenance parameter allows you to narrow search results within a specific connector (e.g., search within a specific Slack channel or GitHub repository).
Provenance Filtering RequirementsTo use provenance filtering, you must:
  • Specify exactly one source in filters.sources
  • Use a source that supports provenance (see table below)
Attempting to use provenance with multiple sources or an unsupported source will result in an error.
Supported sources and provenance value formats:
SourceProvenance Value Format
SLACKChannel name OR channel ID
GITHUB_PRSRepository name
GITHUB_CODERepository name
LINEARTeam name

​
File Attachments

The Agent Tools can accept file attachments as an array of FileAttachment objects.
​
name
string
required
Filename with extension (e.g., "document.pdf", "image.png")
​
mimetype
string
required
MIME type of the file (e.g., "application/pdf", "image/png", "text/plain")
​
content
string
required
Base64 encoded file content