> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.navisavitravel.com/llms.txt.

# ATLAS natural language video search

GET https://api.navisavitravel.com/v1/search

Search for videos using a natural language query. Pass any descriptive phrase — such as `luxury rooftop hotels in Tokyo` or `sunset beach walks in Greece` — and the endpoint returns matching videos. The response includes a `filters` field showing what was applied, which can be useful for debugging or display.

Requires the `videos.atlas_search` permission.

For simpler keyword or point-of-interest searches, use the `search` parameter on `GET /v1/videos` instead — it requires only the `videos.read` permission.

Set `includeCoordinates=true` to also receive a `coordinates` array of up to 500 map points for the full result set of the query, for rendering a map alongside the results.

Reference: https://api-docs.navisavitravel.com/api-reference/videos/atlas-search

## Authentication

- `x-api-key` header (required) — API key issued with your NaviSavi plan

## Servers

- `https://api.navisavitravel.com` (Production, default)
- `https://api-dev.navisavitravel.com` (Development)

## Request

### Query parameters

- `page` (integer, optional, default: 1) — Page number (1-based)
- `limit` (integer, optional, default: 20) — Results per page (max 100)
- `q` (string, required) — Natural language search query (maximum 200 characters)
- `includeCoordinates` (enum, optional) — When `true`, include a `coordinates` array of up to 500 lightweight map points covering the entire result set of the query (not just the current page), suitable for rendering alongside the results. Off by default.
  - Allowed values: `true`, `false`
- `thumbnailWidth` (integer, optional, default: 1280) — Thumbnail width in pixels
- `thumbnailHeight` (integer, optional, default: 720) — Thumbnail height in pixels
- `thumbnailTime` (double, optional, default: 4) — Time offset in seconds for thumbnail frame (clamped to video duration, or 30s if unknown)
- `thumbnailType` (enum, optional, default: png) — Thumbnail image format
  - Allowed values: `png`, `jpeg`, `webp`

## Response

### 200

Search results with derived filters

- `query` (string, required) — The original query string
- `filters` (map from string to any, required) — Structured filters derived from the query by ATLAS
- `data` (list of VideoSummary, required)
- `meta` (PaginationMeta, required)
- `coordinates` (list of VideoCoordinate, optional) — Map points for the entire filtered result set (not just the current page), capped at 500. Present only when `includeCoordinates=true`. Independent of pagination, so request it once (e.g. on page 1) and reuse it while paging the same query.

## Errors

### 400 Bad Request Error

Invalid request parameters

- `error` (string, required)
- `details` (map from string to any, optional)

### 403 Forbidden Error

Missing or invalid API key

- `error` (string, required)
- `details` (map from string to any, optional)

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `details` (map from string to any, optional)

## Types

### VideoSummary

- `id` (string, required)
- `title` (string, required)
- `description` (string, required)
- `publisher` (VideoSummaryPublisher, required)
- `duration` (double, required, nullable)
- `thumbnailUrl` (string, required)
- `clipUrl` (string, required, nullable)
- `thumbnails` (VideoSummaryThumbnails, required)

### PaginationMeta

- `page` (integer, required)
- `limit` (integer, required)
- `total` (integer, required)
- `totalPages` (integer, required)

### VideoCoordinate

- `id` (string, required)
- `lat` (double, required)
- `lng` (double, required)
- `title` (string, required)
- `thumbnailUrl` (string, required)

### VideoSummaryPublisher

- `@type` (string, required)
- `name` (string, required)
- `url` (string, required)

### VideoSummaryThumbnails

- `jpeg` (string, required)
- `png` (string, required)
- `webp` (string, required)

## Examples

**Response**

```json
{
  "query": "luxury rooftop hotels in Tokyo",
  "filters": {},
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "publisher": {
        "@type": "string",
        "name": "string",
        "url": "string"
      },
      "duration": 1.1,
      "thumbnailUrl": "string",
      "clipUrl": "string",
      "thumbnails": {
        "jpeg": "string",
        "png": "string",
        "webp": "string"
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 142,
    "totalPages": 8
  },
  "coordinates": [
    {
      "id": "string",
      "lat": 1.1,
      "lng": 1.1,
      "title": "string",
      "thumbnailUrl": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.navisavitravel.com/v1/search"

querystring = {"q":"luxury rooftop hotels in Tokyo"}

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.navisavitravel.com/v1/search?q=luxury+rooftop+hotels+in+Tokyo")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```