AI natural language search

POST /api/v1/search/natural

Search using natural language queries.

Operation ID: natural_language_search_api_v1_search_natural_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

201 Successful Response

Schema: NLSearchResponse

interpreted_query string required

How the AI interpreted the query

results array · NLSearchResultItem NLSearchResultItem

5 fields

entity_type string required: Type of entity
entity_id string required: Entity ID
title string required: Display title
subtitle string: Additional context
score number required: Relevance score

total integer

Total results

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/search/natural

bash

curl -X POST 'https://api.ondayzero.com/api/v1/search/natural' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d ''

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/search/natural', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {}

response = httpx.post("https://api.ondayzero.com/api/v1/search/natural", headers=headers, json=payload)
data = response.json()