> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# POI Descriptions
## OpenAPI
````yaml openapi/zh/brave-search.json GET /apis/v1/brave/local/descriptions
openapi: 3.1.0
info:
description: ''
title: Brave Search
version: '1'
x-aisa-capabilities:
idempotency: Idempotency-Key
max_price: X-AISA-Max-Price-USD
quote:
header: X-AISA-Cost-Mode
value: quote
x-aisa-configured-paths:
- /apis/v1/brave/images/search
- /apis/v1/brave/llm/context
- /apis/v1/brave/local/descriptions
- /apis/v1/brave/local/place_search
- /apis/v1/brave/local/pois
- /apis/v1/brave/news/search
- /apis/v1/brave/spellcheck/search
- /apis/v1/brave/suggest/search
- /apis/v1/brave/videos/search
- /apis/v1/brave/web/rich
- /apis/v1/brave/web/search
x-aisa-document:
facts_hash: bfca7fbdc322363be69051cbb659ceb6830c024f0f2f839d53c6ac80f1ac360c
generator_version: '2'
protocol_version: '1'
schema_version: '1'
composer_version: '13'
response_pending: []
document_hash: sha256:43ac90d547b4acdf6817aa626a8b8339da83b049b076535c100777fdabb2bbe9
x-aisa-plans:
builder: 1
display_plan: payg
payg: 1
similarweb_payg: 1
team: 1
version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
x-aisa-provider: brave-search
x-aisa-catalogs:
brave-search:
title: Brave Search
description: ''
x-aisa-document:
facts_hash: bfca7fbdc322363be69051cbb659ceb6830c024f0f2f839d53c6ac80f1ac360c
generator_version: '2'
protocol_version: '1'
schema_version: '1'
x-aisa-plans:
builder: 1
display_plan: payg
payg: 1
similarweb_payg: 1
team: 1
version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
x-aisa-capabilities:
idempotency: Idempotency-Key
max_price: X-AISA-Max-Price-USD
quote:
header: X-AISA-Cost-Mode
value: quote
servers:
- url: https://api.aisa.one
security:
- bearerAuth: []
paths:
/apis/v1/brave/local/descriptions:
get:
tags:
- default
summary: POI Descriptions
operationId: any_brave_search_apis_v1_brave_local_descriptions
parameters:
- name: accept
in: header
required: false
description: The default supported media type is application/json.
schema:
allOf:
- type: string
enum:
- application/json
- '*/*'
title: Accept
- default: application/json
title: Media type
description: The default supported media type is application/json.
examples:
- application/json
deprecated: false
examples:
'0':
value: application/json
- name: api-version
in: header
required: false
description: >-
The API version to use. This is denoted by the
format YYYY-MM-DD. Default is the
latest that is available. Read more about API versioning.
schema:
anyOf:
- type: string
- type: 'null'
title: API version
description: >-
The API version to use. This is denoted by the
format YYYY-MM-DD. Default is the
latest that is available. Read more about API versioning.
deprecated: false
- name: cache-control
in: header
required: false
description: >-
Brave Search will return cached content by default.
To prevent caching set the Cache-Control header to
no-cache. This is currently done as
best effort.
schema:
anyOf:
- type: string
enum:
- no-cache
const: no-cache
title: CacheControl
- type: 'null'
title: Cache control
description: >-
Brave Search will return cached content by
default. To prevent caching set the Cache-Control
header to no-cache. This is currently
done as best effort.
deprecated: false
- name: user-agent
in: header
required: false
description: >-
The user agent originating the request. Brave search
can utilize the user agent to provide a different
experience depending on the device as described by the
string. The user agent should follow the commonly
used browser agent strings on each platform. For
more information on curating user agents, see RFC
9110.
schema:
anyOf:
- type: string
- type: 'null'
title: User agent
description: >-
The user agent originating the request. Brave
search can utilize the user agent to provide a
different experience depending on the device as
described by the string. The user agent should
follow the commonly used browser agent strings on
each platform. For more information on curating user
agents, see RFC
9110.
deprecated: false
examples:
Android:
value: >-
Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like
Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36
description: Android
iOS:
value: >-
Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X)
AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63
Mobile/15E148 Safari/604.1
description: iOS
macOS:
value: >-
Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36
description: macOS
Windows:
value: >-
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36
description: Windows
- name: ids
in: query
required: true
description: >-
A list of unique identifiers for the location. The ids are valid
only for 8 hours.
schema:
type: array
items:
type: string
minItems: 1
maxItems: 20
description: >-
A list of unique identifiers for the location. The ids are valid
only for 8 hours.
title: Ids
deprecated: false
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_LocalDescriptionsSearchApiResponse
default:
content:
application/json:
schema: {}
description: >-
Error response; upstream passthrough responses may use provider
formats
components:
schemas:
ResponseE3Baaa015480_LocalDescriptionsSearchApiResponse:
properties:
type:
type: string
enum:
- local_descriptions
const: local_descriptions
title: Type
default: local_descriptions
results:
anyOf:
- items:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_LocationDescription
- type: 'null'
type: array
- type: 'null'
title: Results
description: >-
The list of location descriptions for the given location
identifiers.
type: object
title: LocalDescriptionsSearchApiResponse
ResponseE3Baaa015480_LocationDescription:
properties:
type:
type: string
enum:
- local_description
const: local_description
title: Type
description: >-
The type of a location description. The value is always
local_description.
default: local_description
id:
type: string
title: Id
description: A temporary id of the location with this description.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: AI generated description of the location with the given id.
type: object
required:
- id
title: LocationDescription
description: AI generated description of a location result.
securitySchemes:
bearerAuth:
scheme: bearer
type: http
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.