Clarity Search API
The search API from Clarity — 10 operation(s) for search.
The search API from Clarity — 10 operation(s) for search.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/onclarity-com:onclarity-com-search-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fast Search API
version: 0.1.0
tags:
- name: Search
paths:
/api/v1/search/is-available:
get:
tags:
- Search
summary: Get Search Status
operationId: get_search_status_api_v1_search_is_available_get
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/summary:
post:
tags:
- Search
summary: Get Summary
description: 'To test this function use cURL instead of Postman, because Postman doesn''t support streaming responses.
curl -X POST --no-buffer --header "Content-Type: application/json" --header "X-Customer-Name: abyan-capital" --header "Authorization: Bearer ..." -d ''{"filters": [], "search_query":"test"}'' http://localhost:3005/api/v1/search/summary'
operationId: get_summary_api_v1_search_summary_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/research-plan:
post:
tags:
- Search
summary: Get Research Plan
operationId: get_research_plan_api_v1_search_research_plan_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/deeper-search:
post:
tags:
- Search
summary: Get Deeper Search
operationId: get_deeper_search_api_v1_search_deeper_search_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/quantify:
post:
tags:
- Search
summary: Quantify Search Query
operationId: quantify_search_query_api_v1_search_quantify_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SearchRequestQuantify'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/bullet-points:
post:
tags:
- Search
summary: List Bullet Points
operationId: list_bullet_points_api_v1_search_bullet_points_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/tickets:
post:
tags:
- Search
summary: Get Search Tickets
operationId: get_search_tickets_api_v1_search_tickets_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/trend:
post:
tags:
- Search
summary: Get Search Trend
description: Trend over time for the queried tickets, bucketed by `granularity` (`day`, `week`, `month`).
operationId: get_search_trend_api_v1_search_trend_post
security:
- HTTPBearer: []
parameters:
- name: trend_on
in: query
required: false
schema:
type: string
default: volume
title: Trend On
- name: trend_by
in: query
required: false
schema:
type: string
default: '-'
title: Trend By
- name: segment_field_name
in: query
required: false
schema:
type: string
default: company__filter
title: Segment Field Name
- name: percent_field_name
in: query
required: false
schema:
type: string
default: tags
title: Percent Field Name
- name: percent_field_value
in: query
required: false
schema:
default: bug
title: Percent Field Value
- name: granularity
in: query
required: false
schema:
type: string
default: day
title: Granularity
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/distribution:
post:
tags:
- Search
summary: Get Search Distribution
operationId: get_search_distribution_api_v1_search_distribution_post
security:
- HTTPBearer: []
parameters:
- name: distribution_of
in: query
required: false
schema:
type: string
default: volume
title: Distribution Of
- name: distribution_by
in: query
required: false
schema:
type: string
default: '-'
title: Distribution By
- name: stacked_by
in: query
required: false
schema:
type: string
default: '-'
title: Stacked By
- name: percent_field_name
in: query
required: false
schema:
type: string
default: tags
title: Percent Field Name
- name: percent_field_value
in: query
required: false
schema:
anyOf:
- {}
- type: 'null'
title: Percent Field Value
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExpansionResult'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search/analyze:
post:
tags:
- Search
summary: Analyze Search Query
operationId: analyze_search_query_api_v1_search_analyze_post
security:
- HTTPBearer: []
parameters:
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/src__routers__search__SearchRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
src__routers__search__SearchRequest:
properties:
search_query:
type: string
title: Search Query
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
additional_fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Additional Fields
default: []
custom_prompt_end:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt End
skip_cache:
type: boolean
title: Skip Cache
default: false
type: object
required:
- search_query
- filters
title: SearchRequest
QueryExpansionResult:
properties:
original_query:
anyOf:
- type: string
- type: 'null'
title: Original Query
search_query:
anyOf:
- type: string
- type: 'null'
title: Search Query
original_search_query:
anyOf:
- type: string
- type: 'null'
title: Original Search Query
corrected_query:
anyOf:
- type: string
- type: 'null'
title: Corrected Query
translated_query:
anyOf:
- type: string
- type: 'null'
title: Translated Query
custom_prompt_begin:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt Begin
custom_prompt_end:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt End
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
additional_fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Additional Fields
default: []
task:
anyOf:
- type: string
- type: 'null'
title: Task
default: summarize
is_question:
anyOf:
- type: boolean
- type: 'null'
title: Is Question
default: false
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
default: []
sorted_by:
items:
$ref: '#/components/schemas/QuerySort'
type: array
title: Sorted By
default: []
deep_search:
anyOf:
- type: boolean
- type: 'null'
title: Deep Search
default: false
calculate_nps:
anyOf:
- type: boolean
- type: 'null'
title: Calculate Nps
default: true
calculate_percent_of_total:
anyOf:
- type: boolean
- type: 'null'
title: Calculate Percent Of Total
default: true
question:
anyOf:
- type: string
- type: 'null'
title: Question
taxonomy_element_name:
anyOf:
- type: string
- type: 'null'
title: Taxonomy Element Name
sentiment:
anyOf:
- type: string
- type: 'null'
title: Sentiment
description:
anyOf:
- type: string
- type: 'null'
title: Description
limit:
anyOf:
- type: integer
- type: 'null'
title: Limit
default: 9999
offset:
anyOf:
- type: integer
- type: 'null'
title: Offset
default: 0
post_filtering:
anyOf:
- type: boolean
- type: 'null'
title: Post Filtering
default: true
chat_history:
items:
$ref: '#/components/schemas/ChatHistoryItem'
type: array
title: Chat History
default: []
trend_filters:
anyOf:
- $ref: '#/components/schemas/ExtraFilters'
- type: 'null'
distribution_filters:
anyOf:
- $ref: '#/components/schemas/ExtraFilters'
- type: 'null'
stacking_filters:
anyOf:
- $ref: '#/components/schemas/ExtraFilters'
- type: 'null'
force_refresh:
type: boolean
title: Force Refresh
default: false
use_external_urls:
anyOf:
- type: boolean
- type: 'null'
title: Use External Urls
default: false
type: object
title: QueryExpansionResult
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
SearchRequestQuantify:
properties:
search_query:
type: string
title: Search Query
original_query:
anyOf:
- type: string
- type: 'null'
title: Original Query
number_of_topics:
anyOf:
- type: integer
- type: 'null'
title: Number Of Topics
quantify_prompt:
anyOf:
- type: string
- type: 'null'
title: Quantify Prompt
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
default: []
sentiment:
anyOf:
- type: boolean
- type: 'null'
title: Sentiment
additional_fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Additional Fields
default: []
corrected_query:
anyOf:
- type: string
- type: 'null'
title: Corrected Query
translated_query:
anyOf:
- type: string
- type: 'null'
title: Translated Query
custom_prompt_begin:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt Begin
custom_prompt_end:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt End
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
tickets_limit:
anyOf:
- type: integer
- type: 'null'
title: Tickets Limit
type: object
required:
- search_query
title: SearchRequestQuantify
ChatHistoryItem:
properties:
role:
type: string
pattern: ^(assistant|user)$
title: Role
content:
type: string
title: Content
type: object
required:
- role
- content
title: ChatHistoryItem
ExtraFilters:
properties:
include_filters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Include Filters
exclude_filters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Exclude Filters
size:
type: integer
title: Size
default: 10240
type: object
title: ExtraFilters
QuerySort:
properties:
key:
type: string
title: Key
order:
anyOf:
- type: string
const: asc
- type: string
const: desc
title: Order
default: asc
type: object
required:
- key
title: QuerySort
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
QueryFilter:
properties:
type:
anyOf:
- type: string
const: exists
- type: string
const: list
- type: string
const: nested
- type: string
const: range
- type: string
const: text
title: Type
key:
type: string
title: Key
values:
anyOf:
- items:
type: string
type: array
- items:
type: integer
type: array
- items:
additionalProperties: true
type: object
type: array
- type: string
- type: 'null'
title: Values
min:
anyOf:
- type: string
- type: integer
- type: number
- type: 'null'
title: Min
max:
anyOf:
- type: string
- type: integer
- type: number
- type: 'null'
title: Max
operator:
anyOf:
- type: string
const: eq
- type: string
const: neq
- type: string
const: contains
title: Operator
default: eq
generated:
type: boolean
title: Generated
default: false
type: object
required:
- type
- key
title: QueryFilter
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
HTTPBasic:
type: http
scheme: basic