Instant Search | Airweave

import requests
url = "https://api.airweave.ai/collections/readable_id/search/instant"
payload = { "query": "string" }
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "results": [
    {
      "entity_id": "page-abc123",
      "name": "Production Deployment Guide",
      "relevance_score": 0.94,
      "breadcrumbs": [
        {
          "entity_id": "ws-1",
          "name": "Acme Workspace",
          "entity_type": "NotionWorkspaceEntity"
        },
        {
          "entity_id": "db-eng",
          "name": "Engineering",
          "entity_type": "NotionDatabaseEntity"
        }
      ],
      "textual_representation": "# Production Deployment Guide\n\nThis document covers the standard deployment process for production releases.",
      "airweave_system_metadata": {
        "source_name": "notion",
        "entity_type": "NotionPageEntity",
        "chunk_index": 0,
        "original_entity_id": "page-abc123",
        "sync_id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f80",
        "sync_job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "access": {},
      "web_url": "https://notion.so/Deployment-Guide-abc123",
      "raw_source_fields": {
        "archived": false,
        "icon": "🚀",
        "parent_type": "database_id"
      },
      "created_at": "2025-02-10T09:15:00Z",
      "updated_at": "2025-03-18T16:30:00Z"
    },
    {
      "entity_id": "msg-def456",
      "name": "Deployment checklist update",
      "relevance_score": 0.87,
      "breadcrumbs": [
        {
          "entity_id": "team-1",
          "name": "Acme",
          "entity_type": "SlackWorkspaceEntity"
        },
        {
          "entity_id": "chan-eng",
          "name": "#engineering",
          "entity_type": "SlackChannelEntity"
        }
      ],
      "textual_representation": "Updated the deployment checklist to include the new canary step. Make sure to verify metrics before promoting to 100%.",
      "airweave_system_metadata": {
        "source_name": "slack",
        "entity_type": "SlackMessageEntity",
        "chunk_index": 0,
        "original_entity_id": "msg-def456",
        "sync_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8091",
        "sync_job_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
      },
      "access": {},
      "web_url": "https://acme.slack.com/archives/C0123ABC/p1710500520",
      "raw_source_fields": {
        "channel_name": "#engineering",
        "username": "alice"
      },
      "created_at": "2025-03-15T11:22:00Z",
      "updated_at": "2025-03-15T11:22:00Z"
    }
  ]
}

Direct vector search.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

readable_idstringRequired

Request

This endpoint expects an object.

querystringRequired

Search query text.

retrieval_strategyenumOptional

Which retrieval strategy to use.

Allowed values:

filterlist of objects or nullOptional

Filter groups (combined with OR).

limitintegerOptional1-1000Defaults to 100

Max results to return.

offsetintegerOptional>=0Defaults to 0

Number of results to skip.

Response

Successful Response

resultslist of objects or null

Search results ordered by relevance.

Authentication

Path parameters

Request

Response

Errors