Search Collection

Search across all data sources within the specified collection.

This GET endpoint provides basic search functionality. For advanced filtering and options, use the POST /search endpoint.

Path parameters

readable_idstringRequired

The unique readable identifier of the collection to search

Query parameters

querystringRequired

The search query text to find relevant documents and data

response_typeenumOptional

Format of the response: ‘raw’ returns search results, ‘completion’ returns AI-generated answers

Allowed values:

limitintegerOptional>=1<=100Defaults to 20

Maximum number of results to return

offsetintegerOptional>=0Defaults to 0

Number of results to skip for pagination

score_thresholddouble or nullOptional>=0<=1

Minimum similarity score threshold

expansion_strategyenumOptional

Query expansion strategy (auto, llm, or no_expansion)

Allowed values:

Response

Successful Response

resultslist of maps from strings to any

Array of search result objects containing the found documents, records, or data entities.

response_typeenum

Indicates whether results are raw search matches or AI-generated completions based on the found content.

Allowed values:

statusenum

Status of the search operation indicating the quality and availability of results:
• success: Search found relevant results matching your query
• no_relevant_results: Search completed but found no sufficiently relevant matches
• no_results: Search found no results at all, possibly indicating empty collections or very specific queries

Allowed values:

completionstring or null

AI-generated natural language answer when response_type is ‘completion’. This provides natural language answers to your query based on the content found across your connected data sources.

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	organization_id="YOUR_ORGANIZATION_ID",
6	)
7	client.collections.search_collection(
8	readable_id="readable_id",
9	query="customer payment issues",
10	)

1	{
2	"results": [
3	{
4	"id": "f30bf505-cc33-4c74-920c-524eab49334c",
5	"score": 0.92,
6	"payload": {
7	"entity_id": "1207573546742333",
8	"breadcrumbs": [],
9	"source_name": "Asana",
10	"md_content": "Implement user authentication - Build secure login system with JWT tokens",
11	"md_type": "text",
12	"metadata": {
13	"project_name": "Q4 Development Sprint",
14	"assignee": "john.doe@company.com",
15	"due_date": "2024-01-20",
16	"priority": "high",
17	"tags": [
18	"authentication",
19	"security",
20	"backend"
21	]
22	},
23	"md_position": 0,
24	"md_parent_title": "Authentication Module"
25	}
26	},
27	{
28	"id": "fb6c49f7-2f9a-4000-ad50-96d1047a8f10",
29	"score": 0.87,
30	"payload": {
31	"entity_id": "1207921130902216",
32	"breadcrumbs": [],
33	"source_name": "Asana",
34	"md_content": "Review and update API authentication documentation",
35	"md_type": "text",
36	"metadata": {
37	"project_name": "Documentation Updates",
38	"assignee": "sarah.smith@company.com",
39	"status": "in_progress",
40	"last_modified": "2024-01-18T14:30:00Z"
41	},
42	"md_position": 0,
43	"md_parent_title": "API Documentation"
44	}
45	}
46	],
47	"response_type": "raw",
48	"status": "success"
49	}

Search Collection

Path parameters

Headers

Query parameters

Response

Errors