# Search a directory

> Entries of one directory section matching every facet given: tools (filter by pricing), skills (by renderer), creatives (studios and designers, by specialty) or extras (articles and resources, by resource type).

`GET https://motionvideo.xyz/api/catalog/directories/search`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `section` | query | string | Yes | The directory section, as in the site's URLs. |
| `q` | query | string | No | Keywords; every word must appear in the name, description, category, renderers or specialties. |
| `filter` | query | array of string | No | The section's facet, any of them: pricing for tools, renderer for skills, specialty for creatives, resource type for extras (see `get-facets`). |
| `category` | query | array of string | No | The section's categories, any of them, ignoring case (see `get-facets`). |
| `sort` | query | string | No | One of the section's sorts (see `get-facets`); without one, the site's curated order. |
| `limit` | query | integer | No | Results per page, 1 to 100. Defaults to 24. |
| `offset` | query | integer | No | Results to skip, for the next page. Defaults to 0. |

## Example request

```bash
curl https://motionvideo.xyz/api/catalog/directories/search
```

## Responses

### 200

The matching entries.

| Header | Description |
| --- | --- |
| `Cache-Control` | Browsers reuse a response for 5 minutes and shared caches for an hour, then may serve it stale for up to a day while they revalidate. Value: `public, max-age=300, s-maxage=3600, stale-while-revalidate=86400` |

Body (`application/json`):

- `section` (string, required) One of `tools`, `skills`, `creatives`, `extras`.
- `total` (integer, required): Matches before paging.
- `limit` (integer, required)
- `offset` (integer, required)
- `entries` (array of DirectoryEntry, required)
  - `id` (string, required)
  - `name` (string, required)
  - `description` (string, required)
  - `category` (string, required): e.g. `Editor`, `AI`, `Skills`, `Studio`.
  - `url` (string (uri), required)
  - `cover` (string | null (uri), required): Cover image (WebP), or `null` without one.
  - `addedAt` (string (date), required): When the entry joined the directory (YYYY-MM-DD).
  - `pricing` (string): Tools only. One of `free`, `freemium`, `open-source`, `paid`.
  - `stars` (integer): Skills only: GitHub stars.
  - `updatedAt` (string (date-time)): Skills only: the repository's last push.
  - `renderers` (array of string): Skills only: what renders the video, most central first. One of `remotion`, `hyperframes`, `html`, `manim`, `adobe`, `blender`, `video-models`, `ffmpeg`.
  - `specialties` (array of string): Studios and designers only: what they're known for, strongest first. One of `product-films`, `explainers`, `3d`, `brand`, `ui-motion`.
  - `resourceType` (string): Resources only. One of `library`, `examples`, `prompts`, `directory`, `archive`.
  - `publishedAt` (string (date-time)): Articles only: when it was published.

### 400

A parameter is unknown or has a value it can't take.

Body (`application/json`):

- `error` (string, required) One of `invalid_parameter`.
- `parameter` (string, required)
- `message` (string, required)
- `allowed` (array of string): The values the parameter can take, when it has a fixed set.