### Response Sample for Get Installers

Source: https://docs.ayon.dev/api

This is a sample JSON response when retrieving a list of installers. It details each installer with its filename, platform, size, checksum, sources, version, and Python-related information.

```json
{
  "installers": [
    {
      "filename": "ayon_installer_1.2.3_windows.exe",
      "platform": "windows",
      "size": 0,
      "checksum": "string",
      "checksumAlgorithm": "md5",
      "sources": [
        {
          "type": "http",
          "url": "https://example.com/file.zip"
}
],
      "version": "1.2.3",
      "pythonVersion": "3.11",
      "pythonModules": {
        "requests": "2.25.1",
        "pydantic": "1.8.2"
},
      "runtimePythonModules": {
        "requests": "2.25.1",
        "pydantic": "1.8.2"
}
}
]

}
```

--------------------------------

### Response Sample for Get Release Info

Source: https://docs.ayon.dev/api

This JSON response provides detailed information about a specific release, including its addons, installers, and dependency packages.

```json
{
  "name": "2023.08-Kitsu",
  "label": "2D Animation",
  "release": "2023.08",
  "description": "2D Animation",
  "icon": "skeleton",
  "createdAt": "2019-08-24T14:15:22Z",
  "mandatoryAddons": [
    "string"
],
  "addons": [
    {
      "name": "maya",
      "title": "Maya",
      "description": "Maya is a 3D computer graphics application",
      "orgName": "ynput-official",
      "orgTitle": "Ynput",
      "icon": "https://example.com/maya.png",
      "tags": [
        "string"
],
      "flags": [
        "string"
],
      "latestVersion": "1.0.0",
      "links": [
        {
          "type": "github",
          "url": "https://github.com/ynput/ayon-maya"
}
],
      "available": true,
      "currentProductionVersion": "1.0.0",
      "currentLatestVersion": "1.0.0",
      "isOutdated": false,
      "version": "1.0.0",
      "url": "https://example.com/maya-1.0.0.zip",
      "altUrl": "https://example2.com/maya-1.0.0.zip",
      "checksum": "a1b2c3d4e5f6g7h8i9j0",
      "ayonVersion": "1.2.0",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "isInstalled": false,
      "isProduction": false,
      "isCompatible": false
}
],
  "installers": [
    {
      "filename": "ayon_installer_1.2.3_windows.exe",
      "platform": "windows",
      "size": 0,
      "checksum": "string",
      "checksumAlgorithm": "md5",
      "sources": [
        {
          "type": "http",
          "url": "https://example.com/file.zip"
}
],
      "version": "1.2.3",
      "pythonVersion": "3.11",
      "pythonModules": {
        "requests": "2.25.1",
        "pydantic": "1.8.2"
},
      "runtimePythonModules": {
        "requests": "2.25.1",
        "pydantic": "1.8.2"
}
}
],
  "dependencyPackages": [
    {
      "filename": "ayon_installer_1.2.3_windows.exe",
      "platform": "windows",
      "size": 0,
      "checksum": "string",
      "checksumAlgorithm": "md5",
      "sources": [
        {
          "type": "http",
          "url": "https://example.com/file.zip"
}
],
      "installerVersion": "1.2.3",
      "sourceAddons": {
        "ftrack": "1.2.3",
        "maya": "2.4"
},
      "pythonModules": {
        "requests": "2.25.1",
        "pydantic": "1.8.2"
}
}
]
}
```

--------------------------------

### Create Installer

Source: https://docs.ayon.dev/api

Creates a new installer with specified details. It can take a URL for the addon zip file and options to overwrite existing installers.

```APIDOC
## Create Installer

### Description
Creates a new installer with specified details. It can take a URL for the addon zip file and options to overwrite existing installers.

### Method
POST

### Endpoint
/api/desktop/installers

### Parameters
#### Query Parameters
- **url** (string) - Required - URL to the addon zip file
- **overwrite** (boolean) - Optional - Deprecated. Use the force parameter.
- **force** (boolean) - Optional - Default: false - Overwrite existing installer

#### Request Body
- **filename** (string) - Required - Name of the package file
- **platform** (string) - Required - Enum: "windows" "linux" "darwin"
- **size** (integer) - Optional - Size of the installer
- **checksum** (string) - Optional - Checksum of the installer
- **checksumAlgorithm** (string) - Optional - Enum: "md5" "sha1" "sha256"
- **sources** (Array of objects) - Optional - List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.
- **version** (string) - Required - Version of the installer
- **pythonVersion** (string) - Required - Version of Python that the installer is created with
- **pythonModules** (object) - Optional - Mapping of module name:version used to create the installer
- **runtimePythonModules** (object) - Optional - Mapping of module_name:version used to run the installer

### Request Example
```json
{
  "filename": "ayon_installer_1.2.3_windows.exe",
  "platform": "windows",
  "size": 0,
  "checksum": "string",
  "checksumAlgorithm": "md5",
  "sources": [
    {
      "type": "http",
      "url": "https://example.com/file.zip"
    }
  ],
  "version": "1.2.3",
  "pythonVersion": "3.11",
  "pythonModules": {
    "requests": "2.25.1",
    "pydantic": "1.8.2"
  },
  "runtimePythonModules": {
    "requests": "2.25.1",
    "pydantic": "1.8.2"
  }
}
```

### Response
#### Success Response (201)
- **eventId** (string) - The ID of the event.

#### Response Example
```json
{
  "eventId": "string"
}
```
```

--------------------------------

### Upload Installer File

Source: https://docs.ayon.dev/api

Uploads an installer file to the server.

```APIDOC
## Upload Installer File

### Description
Uploads an installer file to the server.

### Method
PUT

### Endpoint
/api/desktop/installers/{filename}

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the file to upload.

### Response
#### Success Response (204)
Indicates a successful upload.

#### Response Example
```json
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
```
```

--------------------------------

### Request Sample for Create Installer

Source: https://docs.ayon.dev/api

This JSON payload is used to create a new installer. It requires details such as filename, platform, version, and Python version, along with optional checksum and sources.

```json
{
  "filename": "ayon_installer_1.2.3_windows.exe",
  "platform": "windows",
  "size": 0,
  "checksum": "string",
  "checksumAlgorithm": "md5",
  "sources": [
    {
      "type": "http",
      "url": "https://example.com/file.zip"
}
],
  "version": "1.2.3",
  "pythonVersion": "3.11",
  "pythonModules": {
    "requests": "2.25.1",
    "pydantic": "1.8.2"
},
  "runtimePythonModules": {
    "requests": "2.25.1",
    "pydantic": "1.8.2"
}

}
```

--------------------------------

### Response Sample for Addon Installation Status

Source: https://docs.ayon.dev/api

This JSON response details the status of addon installation tasks. It includes a list of items, each with an ID, topic, description, addon details, user, status, and timestamps. It also indicates if a restart is required.

```json
{
  "items": [
    {
      "id": "string",
      "topic": "addon.install",
      "description": "string",
      "addonName": "string",
      "addonVersion": "string",
      "user": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
}
],
  "restartRequired": true

}
```

--------------------------------

### List Installers

Source: https://docs.ayon.dev/api

Retrieve a list of available installers based on specified criteria such as version, platform, and variant.

```APIDOC
## GET /api/desktop/installers

### Description
List installers.

### Method
GET

### Endpoint
/api/desktop/installers

### Parameters
#### Query Parameters
- **version** (string) - Optional - Version of the package.
- **platform** (string) - Optional - Platform of the package. Enum: "windows", "linux", "darwin".
- **variant** (string) - Optional - Variant of the package. Enum: "production", "staging".

### Responses
#### Success Response (200)
Successful Response.
#### Error Response (422)
Validation Error.
```

--------------------------------

### Response Sample for Get Releases

Source: https://docs.ayon.dev/api

This is a sample JSON response for the 'Get Releases' endpoint, showing the structure of license information and sync status.

```json
{
  "licenses": [
    { }
],
  "syncedAt": 0
}
```

--------------------------------

### Get Installed Addons List

Source: https://docs.ayon.dev/api

Retrieves a list of all installed addons, including their status and installation details. Indicates if a restart is required.

```APIDOC
## Get Installed Addons List

### Description
Retrieves a list of all installed addons, including their status and installation details. Indicates if a restart is required.

### Method
GET

### Endpoint
/api/addons/install

### Response
#### Success Response (200)
- **items** (array) - List of installed addons.
  - **id** (string)
  - **topic** (string)
  - **description** (string)
  - **addonName** (string)
  - **addonVersion** (string)
  - **user** (string)
  - **status** (string)
  - **createdAt** (string)
  - **updatedAt** (string)
- **restartRequired** (boolean)

### Response Example
```json
{
  "items": [
    {
      "id": "string",
      "topic": "addon.install",
      "description": "string",
      "addonName": "string",
      "addonVersion": "string",
      "user": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "restartRequired": true
}
```
```

--------------------------------

### Download Installer File

Source: https://docs.ayon.dev/api

Downloads a specific installer file by its filename.

```APIDOC
## Download Installer File

### Description
Downloads a specific installer file by its filename.

### Method
GET

### Endpoint
/api/desktop/installers/{filename}

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the file to download.

### Response
#### Success Response (200)
Returns the installer file content.

#### Response Example
```json
null
```
```

--------------------------------

### GET /projects/{project_name}/products/{product_id}

Source: https://docs.ayon.dev/api

Retrieves a specific product by its project name and product ID.

```APIDOC
## GET /projects/{project_name}/products/{product_id}

### Description
Retrieve a product by its ID.

### Method
GET

### Endpoint
/api/projects/{project_name}/products/{product_id}

### Parameters
#### Path Parameters
- **project_name** (string) - Required - Project name ^[a-zA-Z0-9_]*$
- **product_id** (string) - Required - Product ID (32 characters, hexadecimal) Example: af10c8f0e9b111e9b8f90242ac130003

### Response
#### Success Response (200)
- **id** (string) - Product ID.
- **name** (string) - Product name.
- **folderId** (string) - ID of the folder the product belongs to.
- **productType** (string) - Type of the product.
- **productBaseType** (string) - Base type of the product.
- **path** (string) - File path of the product.
- **attrib** (object) - Attributes of the product.
  - **productGroup** (string)
  - **description** (string)
- **data** (object) - Additional data associated with the product.
- **active** (boolean) - Indicates if the product is active.
- **ownAttrib** (Array of strings) - List of own attributes.
- **status** (string) - Current status of the product.
- **tags** (Array of strings) - Tags associated with the product.
- **createdBy** (string) - User who created the product.
- **updatedBy** (string) - User who last updated the product.
- **createdAt** (string) - Timestamp of creation.
- **updatedAt** (string) - Timestamp of last update.

#### Response Example
```json
{
  "id": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  "name": "modelMain",
  "folderId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  "productType": "modelMain",
  "productBaseType": "model",
  "path": "/assets/characters/xenomorph/modelMain",
  "attrib": {
    "productGroup": "string",
    "description": "A very nice entity"
  },
  "data": { },
  "active": true,
  "ownAttrib": [
    "frameStart",
    "frameEnd"
  ],
  "status": "In progress",
  "tags": [
    "flabadob",
    "blip",
    "blop",
    "blup"
  ],
  "createdBy": "Moe",
  "updatedBy": "Homer",
  "createdAt": "2023-01-01T00:00:00+00:00",
  "updatedAt": "2023-01-01T00:00:00+00:00"
}
```
```

--------------------------------

### Get Enum Response Example

Source: https://docs.ayon.dev/api

Example response for retrieving enum values. It details the structure of each enum value, including its value, label, description, and other metadata.

```json
[
  {
    "value": "my_value",
    "label": "My Value",
    "description": "Description of My value",
    "fulltext": [
      "my",
      "value"
    ],
    "group": "string",
    "icon": "dashboard",
    "color": "#FF0000",
    "disabled": false,
    "disabledMessage": "This option is not available"
  }

]
```

--------------------------------

### Get Attribute List

Source: https://docs.ayon.dev/api

Retrieves a list of all attributes and their associated configurations. This endpoint is useful for understanding the current attribute setup.

```APIDOC
## Get Attribute List

### Description
Return a list of attributes and their configuration.

### Method
GET

### Endpoint
/api/attributes

### Responses
#### Success Response (200)
- **attributes** (array) - A list of attribute objects, each containing name, position, scope, data, and builtin status.

### Response Example
```json
{
  "attributes": [
    {
      "name": "my_attribute",
      "position": 12,
      "scope": [
        "folder",
        "task"
      ],
      "data": {
        "type": "string",
        "title": "My attribute",
        "description": "Value of my attribute",
        "example": "value1",
        "default": null,
        "gt": 0,
        "ge": 0,
        "lt": 0,
        "le": 0,
        "minLength": 0,
        "maxLength": 0,
        "minItems": 0,
        "maxItems": 0,
        "regex": "^[a-zA-Z0-9_]+$",
        "enum": [
          {
            "value": "value1",
            "label": "Value 1"
          },
          {
            "value": "value2",
            "label": "Value 2"
          },
          {
            "value": "value3",
            "label": "Value 3"
          }
        ],
        "enumResolver": "folder_types",
        "enumResolverSettings": {
          "someSetting": "someValue"
        },
        "inherit": true
      },
      "builtin": false
    }
  ]
}
```
```

--------------------------------

### List Bundles Response Sample

Source: https://docs.ayon.dev/api

This is a sample JSON response when listing bundles. It details the structure of a bundle object, including its name, creation date, addons, installer version, dependencies, and various flags.

```json
[
  {
    "id": "string",
    "label": "string",
    "type": "fixed",
    "valid": true,
    "note": "string",
    "exp": 0,
    "max": 0,
    "used": 0,
    "meta": { }
  }

]
```

--------------------------------

### Get Working View Response Example

Source: https://docs.ayon.dev/api

This JSON object represents the response when retrieving the working view for a specific type. It includes detailed settings and metadata about the view.

```json
{
  "id": "string",
  "label": "To review",
  "scope": "project",
  "owner": "steve",
  "visibility": "public",
  "working": true,
  "position": 0,
  "accessLevel": 0,
  "settings": {
    "showHierarchy": true,
    "rowHeight": 0,
    "groupBy": "string",
    "groupSortByDesc": false,
    "showEmptyGroups": false,
    "sortBy": "string",
    "sortDesc": false,
    "filter": {
      "conditions": [
        {
          "key": "summary/newValue",
          "value": "New value",
          "operator": "eq"
}
],
      "operator": "and"
},
    "folderFilter": {
      "conditions": [
        {
          "key": "summary/newValue",
          "value": "New value",
          "operator": "eq"
}
],
      "operator": "and"
},
    "sliceType": "string",
    "columns": [
      {
        "name": "name",
        "pinned": true,
        "width": 120
},
      {
        "name": "status",
        "pinned": true,
        "width": 120
},
      {
        "name": "assignees",
        "width": 120
},
      {
        "name": "attrib.priority",
        "width": 120
}
]
},
  "access": { },
  "viewType": "overview"

}
```

--------------------------------

### Patch Installer

Source: https://docs.ayon.dev/api

Updates the sources for an existing installer. This allows changing where the installer can be downloaded from.

```APIDOC
## Patch Installer

### Description
Updates the sources for an existing installer. This allows changing where the installer can be downloaded from.

### Method
PATCH

### Endpoint
/api/desktop/installers/{filename}

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the installer file to update.

#### Request Body
- **sources** (Array of objects) - Required - List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.
  - **type** (string) - Required - Enum: "server" "http" - If set to server, the file is stored on the server. If set to http, the file is downloaded from the specified URL.
  - **url** (string) - Optional - URL to download the file from. Only used if type is http.

### Request Example
```json
{
  "sources": [
    {
      "type": "http",
      "url": "https://example.com/file.zip"
    }
  ]
}
```

### Response
#### Success Response (204)
Indicates the sources were successfully updated.
```

--------------------------------

### Response Sample for Get Releases (Detailed)

Source: https://docs.ayon.dev/api

This sample JSON response details available releases, including names, labels, versions, and associated addons.

```json
{
  "releases": [
    {
      "name": "2023.08-Kitsu",
      "label": "2D Animation",
      "release": "2023.08",
      "description": "2D Animation",
      "icon": "skeleton",
      "createdAt": "2019-08-24T14:15:22Z",
      "mandatoryAddons": [
        "string"
],
      "isLatest": true,
      "addons": [
        "string"
]
}
],
  "detail": ""
}
```

--------------------------------

### Get Entity Watchers

Source: https://docs.ayon.dev/api

Get watchers of an entity.

```APIDOC
## GET /api/projects/{project_name}/{entity_type}/{entity_id}/watchers

### Description
Get watchers of an entity.

### Method
GET

### Endpoint
/api/projects/{project_name}/{entity_type}/{entity_id}/watchers

### Parameters
#### Path Parameters
- **project_name** (string) - Required - Project name ^[a-zA-Z0-9_]*$
- **entity_type** (string) - Required - Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional).
- **entity_id** (string) - Required - Entity ID = 32 characters ^[0-9a-f]{32}$

### Response
#### Success Response (200)
- **watchers** (array of strings) - List of watchers for the entity.

#### Response Example
```json
{
  "watchers": [
    "user1",
    "user2"
  ]
}
```
```

--------------------------------

### Delete Installer File

Source: https://docs.ayon.dev/api

Deletes a specific installer file by its filename.

```APIDOC
## Delete Installer File

### Description
Deletes a specific installer file by its filename.

### Method
DELETE

### Endpoint
/api/desktop/installers/{filename}

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the file to delete.

### Response
#### Success Response (204)
Indicates a successful deletion.

#### Response Example
```json
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
```
```

--------------------------------

### Project Response Sample

Source: https://docs.ayon.dev/api

This JSON object details a project's configuration, including its name, code, folder types, task types, link types, statuses, tags, and attributes.

```json
{
  "name": "awesome_project",
  "code": "prj",
  "library": false,
  "folderTypes": [
    {
      "name": "string",
      "original_name": "string",
      "shortName": "",
      "color": "#cccccc",
      "icon": "folder"
    }
  ],
  "taskTypes": [
    {
      "name": "string",
      "original_name": "string",
      "shortName": "",
      "color": "#cccccc",
      "icon": "task_alt"
    }
  ],
  "linkTypes": [
    {
      "name": "reference|version|version",
      "link_type": "reference",
      "input_type": "version",
      "output_type": "version",
      "data": {
        "color": "#ff0000"
      }
    }
  ],
  "statuses": [
    {
      "name": "string",
      "original_name": "string",
      "shortName": "PRG",
      "state": "in_progress",
      "icon": "play_arrow",
      "color": "#3498db",
      "scope": [
        "folder",
        "product",
        "version",
        "representation",
        "task",
        "workfile"
      ]
    }
  ],
  "tags": [
    {
      "name": "string",
      "original_name": "string",
      "color": "#3498db"
    }
  ],
  "config": { },
  "attrib": {
    "priority": "urgent",
    "fps": 25,
    "resolutionWidth": 1920,
    "resolutionHeight": 1080,
    "pixelAspect": 1,
    "clipIn": 1,
    "clipOut": 1,
    "frameStart": 1001,
    "frameEnd": 1001,
    "handleStart": 0,
    "handleEnd": 0,
    "startDate": "2021-01-01T00:00:00+00:00",
    "endDate": "2021-01-01T00:00:00+00:00",
    "description": "A very nice entity"
  },
  "data": { },
  "active": true,
  "ownAttrib": [
    "frameStart",
    "frameEnd"
  ],
  "createdAt": "2023-01-01T00:00:00+00:00",
  "updatedAt": "2023-01-01T00:00:00+00:00"

}
```

--------------------------------

### Response Sample for Addon Project Settings Schema

Source: https://docs.ayon.dev/api

A sample JSON response for retrieving the schema of addon project settings.

```json
{
  "eventId": "string"
}
```

--------------------------------

### Create First Admin

Source: https://docs.ayon.dev/api

Initializes the Ayon system by creating the first administrator user and logging them in. This endpoint should be used when Ayon is started for the first time and no admin user exists.

```APIDOC
## Create First Admin

Create the first user and log in.

### Method
POST

### Endpoint
/api/onboarding/initialize

### Request Body
- **adminName** (string) - Required - Username for the administrator.
- **adminPassword** (string) - Required - Password for the administrator.
- **adminFullName** (string) - Optional - Full name of the administrator. Defaults to "".
- **adminEmail** (string) - Optional - Email address of the administrator. Defaults to "".
```

--------------------------------

### Response Sample for Create Folder

Source: https://docs.ayon.dev/api

A successful response after creating a folder, typically returning the ID of the newly created folder.

```json
{
  "id": "af10c8f0e9b111e9b8f90242ac130003"

}
```

--------------------------------

### Get Releases

Source: https://docs.ayon.dev/api

Retrieves a list of available releases from the Ayon market. Supports filtering to get all releases.

```APIDOC
## Get Releases

Get the releases

### Method
GET

### Endpoint
/api/market/releases

### Query Parameters
- **all** (boolean) - Optional - If true, returns all releases. Defaults to false.
```

--------------------------------

### Get Services Response Sample

Source: https://docs.ayon.dev/api

This is a sample response when retrieving a list of services. It includes details about each service's configuration and status.

```json
{
  "services": [
    {
      "name": "string",
      "hostname": "worker03",
      "addonName": "ftrack",
      "addonVersion": "2.0.0",
      "service": "collector",
      "shouldRun": true,
      "isRunning": true,
      "lastSeen": "2019-08-24T14:15:22Z",
      "lastSeenDelta": 0,
      "data": {
        "volumes": [
          "/tmp:/tmp"
],
        "ports": [
          "8080:8080"
],
        "memLimit": "1g",
        "user": "1000",
        "env": { },
        "storagePath": "/mnt/storage",
        "image": "ayon/ftrack-addon-leecher:2.0.0"
}
}
]

}
```

--------------------------------

### Get Anatomy Presets Response Sample

Source: https://docs.ayon.dev/api

A sample JSON response for the 'Get Anatomy Presets' endpoint, illustrating the structure of version and preset information.

```json
{
  "version": "string",
  "presets": [
    {
      "name": "string",
      "primary": true,
      "version": "string"
}
]

}
```

--------------------------------

### List Hosts Response Sample

Source: https://docs.ayon.dev/api

This is a sample response when listing all available hosts. It provides the host's name, last seen timestamp, and health status (CPU and memory usage).

```json
{
  "hosts": [
    {
      "name": "my-host",
      "lastSeen": "2026-04-10T00:04:21.854120",
      "health": {
        "cpu": 0.5,
        "mem": 42
}
}
]

}
```

--------------------------------

### Sample Response for Frontend Modules

Source: https://docs.ayon.dev/api

This JSON represents a successful response when listing frontend modules. It includes addon details and a map of module properties, each containing an array of strings.

```json
[
  {
    "addonName": "string",
    "addonVersion": "string",
    "modules": {
      "property1": [
        "string"
],
      "property2": [
        "string"
]
}
}

]
```

--------------------------------

### Get Anatomy Preset

Source: https://docs.ayon.dev/api

Retrieves a specific anatomy preset by its name. You can also use special names like `__builtin__` or `__primary__` to get default presets.

```APIDOC
## Get Anatomy Preset

### Description
Returns the anatomy preset with the given name. Use `__builtin__` or `__primary__` for default presets. `_` is an alias for the built-in preset (deprecated).

### Method
GET

### Endpoint
/api/anatomy/presets/{preset_name}

### Parameters
#### Path Parameters
- **preset_name** (string) - Required - The name of the anatomy preset to retrieve.

### Responses
#### Success Response (200)
Content type: application/json
```json
{
  "entity_naming": {
    "capitalization": "lower",
    "separator": ""
  },
  "roots": [
    {
      "name": "work",
      "windows": "C:/projects",
      "linux": "/mnt/share/projects",
      "darwin": "/Volumes/projects"
    }
  ],
  "templates": {
    "version_padding": 3,
    "version": "v{version:0>{@version_padding}}",
    "frame_padding": 4,
    "frame": "{frame:0>{@frame_padding}}",
    "work": [
      {
        "name": "string",
        "directory": "string",
        "file": "string"
      }
    ],
    "publish": [
      {
        "name": "string",
        "directory": "string",
        "file": "string"
      }
    ],
    "hero": [
      {
        "name": "string",
        "directory": "string",
        "file": "string"
      }
    ],
    "delivery": [
      {
        "name": "string",
        "directory": "string",
        "file": "string"
      }
    ],
    "staging": [
      {
        "name": "string",
        "directory": ""
      }
    ],
    "others": [
      {
        "name": "string",
        "value": ""
      }
    ]
  },
  "attributes": {
    "priority": "urgent",
    "fps": 25,
    "resolutionWidth": 1920,
    "resolutionHeight": 1080,
    "pixelAspect": 1,
    "clipIn": 1,
    "clipOut": 1,
    "frameStart": 1001,
    "frameEnd": 1001,
    "handleStart": 0,
    "handleEnd": 0,
    "startDate": "2021-01-01T00:00:00+00:00",
    "endDate": "2021-01-01T00:00:00+00:00",
    "description": "A very nice entity"
  },
  "folder_types": [
    {
      "name": "Folder",
      "shortName": "",
      "color": "#cccccc",
      "icon": "folder"
    }
  ],
  "task_types": [
    {
      "name": "Generic",
      "shortName": "gener",
      "color": "#5c6c79",
      "icon": "task_alt"
    }
  ],
  "link_types": [
    {
      "link_type": "generative",
      "input_type": "version",
      "output_type": "version",
      "color": "#3f67de",
      "style": "solid"
    }
  ],
  "statuses": [
    {
      "name": "Not ready",
      "shortName": "NRD",
      "state": "not_started",
      "icon": "fiber_new",
      "color": "#3d444f",
      "scope": [
        "folder",
        "product",
        "task"
      ]
    }
  ],
  "tags": [
    {
      "name": "important",
      "color": "#ff2450"
    }
  ],
  "product_base_types": {
    "default": {
      "color": "#cccccc",
      "icon": "deployed_code"
    },
    "definitions": [
      {
        "name": "",
        "color": "#cccccc",
        "icon": "deployed_code"
      }
    ]
  }
}
```
#### Error Response (422)
Validation Error
```

--------------------------------

### Create View Payload Example

Source: https://docs.ayon.dev/api

This is an example of the JSON payload used to create a new view. It includes settings for hierarchy, sorting, filtering, and column definitions.

```json
{
  "id": "string",
  "label": "To review",
  "working": true,
  "settings": {
    "showHierarchy": true,
    "rowHeight": 0,
    "groupBy": "string",
    "groupSortByDesc": false,
    "showEmptyGroups": false,
    "sortBy": "string",
    "sortDesc": false,
    "filter": {
      "conditions": [
        {
          "key": "summary/newValue",
          "value": "New value",
          "operator": "eq"
}
],
      "operator": "and"
},
    "folderFilter": {
      "conditions": [
        {
          "key": "summary/newValue",
          "value": "New value",
          "operator": "eq"
}
],
      "operator": "and"
},
    "sliceType": "string",
    "columns": [
      {
        "name": "name",
        "pinned": true,
        "width": 120
},
      {
        "name": "status",
        "pinned": true,
        "width": 120
},
      {
        "name": "assignees",
        "width": 120
},
      {
        "name": "attrib.priority",
        "width": 120
}
]
},
  "viewType": "overview"

}
```

--------------------------------

### Response Sample for Market Addon List

Source: https://docs.ayon.dev/api

This JSON response lists available market add-ons. Each add-on object contains details like name, title, description, organization, icon, tags, version information, and availability.

```json
{
  "addons": [
    {
      "name": "maya",
      "title": "Maya",
      "description": "Maya is a 3D computer graphics application",
      "orgName": "ynput-official",
      "orgTitle": "Ynput",
      "icon": "https://example.com/maya.png",
      "tags": [
        "string"
      ],
      "flags": [
        "string"
      ],
      "latestVersion": "1.0.0",
      "links": [
        {
          "type": "github",
          "url": "https://github.com/ynput/ayon-maya"
        }
      ],
      "available": true,
      "currentProductionVersion": "1.0.0",
      "currentLatestVersion": "1.0.0",
      "isOutdated": false
    }
  ]
}
```

--------------------------------

### Login Response Sample

Source: https://docs.ayon.dev/api

This is a sample JSON response upon successful login, containing user details and authentication tokens.

```json
{
  "detail": "Logged in as NAME",
  "error": "Unauthorized",
  "token": "TOKEN",
  "user": {
    "name": "awesome_user",
    "uiExposureLevel": 100,
    "attrib": {
      "fullName": "Jane Doe",
      "email": "jane.doe@ayon.cloud",
      "avatarUrl": "string",
      "developerMode": true
    },
    "data": { },
    "active": true,
    "ownAttrib": [
      "frameStart",
      "frameEnd"
    ],
    "createdAt": "2023-01-01T00:00:00+00:00",
    "updatedAt": "2023-01-01T00:00:00+00:00"
  },
  "redirectUrl": "/projects"
}
```

--------------------------------

### Create Session Response Sample

Source: https://docs.ayon.dev/api

This JSON sample details the response after successfully creating a new user session.

```json
{
  "user": {
    "name": "awesome_user",
    "uiExposureLevel": 100,
    "attrib": {
      "fullName": "Jane Doe",
      "email": "jane.doe@ayon.cloud",
      "avatarUrl": "string",
      "developerMode": true
    },
    "data": { },
    "active": true,
    "ownAttrib": [
      "frameStart",
      "frameEnd"
    ],
    "createdAt": "2023-01-01T00:00:00+00:00",
    "updatedAt": "2023-01-01T00:00:00+00:00"
  },
  "token": "string",
  "created": 0,
  "lastUsed": 0,
  "isService": false,
  "isApiKey": false,
  "clientInfo": {
    "ip": "string",
    "languages": [
      "string"
    ],
    "location": {
      "country": "string",
      "subdivision": "string",
      "city": "string"
    },
    "agent": {
      "platform": "string",
      "client": "string",
      "device": "string"
    },
    "site_id": "string"
  }

}
```

--------------------------------

### Get Project Roots Overrides

Source: https://docs.ayon.dev/api

Return overrides for project roots. This endpoint is used to get overrides for project roots, returning a dictionary with site IDs as keys and root path dictionaries as values.

```APIDOC
## Get Project Roots Overrides

Return overrides for project roots.
This endpoint is used to get overrides for project roots. The result is an a dictionary with site_id as a key and a dictionary with root names as keys and root paths as values.

### Method
GET

### Endpoint
/api/projects/{project_name}/roots

### Parameters
#### Path Parameters
- **project_name** (string) - Required - Project name ^[a-zA-Z0-9_]*$

### Responses
#### Success Response (200)
Returns a dictionary of project root overrides.

#### Response Example (200)
```json
{
  "property1": {
    "property1": "string",
    "property2": "string"
  },
  "property2": {
    "property1": "string",
    "property2": "string"
  }
}
```

#### Error Response (422)
Validation Error
```

--------------------------------

### List Addons

Source: https://docs.ayon.dev/api

List all available addons.

```APIDOC
## GET /api/addons

### Description
List all available addons.

### Method
GET

### Endpoint
/api/addons

### Parameters
#### Query Parameters
- **details** (boolean) - Optional - Show details. Default: false

### Response
#### Success Response (200)
- (Response body structure not detailed in source)

#### Response Example
(No example provided in source)
```

--------------------------------

### Get Project Entity URIs Request Payload

Source: https://docs.ayon.dev/api

JSON payload for the 'Get Project Entity URIs' API endpoint. Specify the entity type and a list of entity IDs to retrieve their corresponding Ayon URIs.

```json
{
  "entityType": "folder",
  "ids": [
    "string"
]

}
```

--------------------------------

### List Dependency Packages

Source: https://docs.ayon.dev/api

Fetches a list of available dependency packages for the Ayon desktop client. This includes package details like filename, platform, size, checksum, download URLs, installer version, and dependencies.

```json
{
  "packages": [
    {
      "filename": "ayon_installer_1.2.3_windows.exe",
      "platform": "windows",
      "size": 0,
      "checksum": "string",
      "checksumAlgorithm": "md5",
      "sources": [
        {
          "type": "http",
          "url": "https://example.com/file.zip"
}
],
      "installerVersion": "1.2.3",
      "sourceAddons": {
        "ftrack": "1.2.3",
        "maya": "2.4"
},
      "pythonModules": {
        "requests": "2.25.1",
        "pydantic": "1.8.2"
}
}
]

}
```

--------------------------------

### Get Licenses

Source: https://docs.ayon.dev/api

Retrieves a list of licenses. This is a cloud-only endpoint.

```APIDOC
## GET /api/market/licenses

### Description
Get list of licenses. This is a cloud-only endpoint.

### Method
GET

### Endpoint
/api/market/licenses

### Parameters
#### Query Parameters
- **refresh** (boolean) - Optional - Refresh (Default: false)

### Responses
#### Success Response (200)
Successful Response

#### Error Response (422)
Validation Error
```

--------------------------------

### Get Project Folders Response Sample

Source: https://docs.ayon.dev/api

Sample JSON response for retrieving project folders. Lists folder details including ID, label, parent ID, and position.

```json
{
  "folders": [
    {
      "id": "af10c8f0e9b111e9b8f90242ac130003",
      "label": "string",
      "parentId": "af10c8f0e9b111e9b8f90242ac130003",
      "position": 0,
      "data": {
        "color": "string",
        "icon": "string"
      }
    }
  ]
}
```

--------------------------------

### Get Server Config

Source: https://docs.ayon.dev/api

Retrieves the current server configuration.

```APIDOC
## Get Server Config
Get the server configuration.

### Method
GET

### Endpoint
/api/config

### Response
#### Success Response (200)
Successful Response.
```

--------------------------------

### Get Addon Studio Settings

Source: https://docs.ayon.dev/api

Returns the settings, including studio overrides, for a specified addon and version. Allows retrieval of addon configuration details.

```APIDOC
## Get Addon Studio Settings

### Description
Returns the settings, including studio overrides, for a specified addon and version. Allows retrieval of addon configuration details.

### Method
GET

### Endpoint
/api/addons/{addon_name}/{addon_version}/settings

### Parameters
#### Path Parameters
- **addon_name** (string) - Required - Addon Name
- **addon_version** (string) - Required - Addon Version

#### Query Parameters
- **variant** (string) - Optional - Variant (Default: "production")
```

--------------------------------

### Get User Pools

Source: https://docs.ayon.dev/api

Retrieve a list of user pools.

```APIDOC
## Get User Pools

Get list of user pools

### Method
GET

### Endpoint
/api/auth/pools

### Responses
#### Success Response (200)
Successful Response
```

--------------------------------

### Response Sample for Listing Projects

Source: https://docs.ayon.dev/api

This JSON response provides a list of projects, including details such as name, code, status, and timestamps. It also includes pagination information like the total count and number of projects shown.

```json
{
  "detail": "Showing LENGTH of COUNT projects",
  "count": 1,
  "projects": [
    {
      "name": "Example project",
      "code": "ex",
      "active": true,
      "library": false,
      "pinned": false,
      "createdAt": "2026-04-10T00:04:21.419296",
      "updatedAt": "2026-04-10T00:04:21.419300"
    }
  ]
}
```