---
url: /apidocs/humanity.md
---
## Humanity API

Humanity API simulates work of matchmaking questionnaire.

| Endpoint | Method | Description |
|-----|-----|-----|
| [humanity:getQuestionnaireTemplate](#humanity-get-questionnaire-template) | websocket | Humanity: get questionnaire template |
| [humanity:listSearchCards](#humanity-list-search-cards) | websocket | Humanity: list search cards |
| [humanity:updateSearchCard](#humanity-update-search-card) | websocket | Humanity: update search card |
| [humanity:searchBySearchCard](#humanity-search-rooms-by-search-card) | websocket | Humanity: search rooms by search card |
| [humanity:searchCardUpdated](#humanity-search-card-updated-event) | websocketEvent | Humanity: search card updated event |

### Humanity: get questionnaire template

**Method:** websocket

**Endpoint:** humanity:getQuestionnaireTemplate

**Description:** Api returns same structure as matchmaking:getQuestionnaireTemplate, but with professional matrix values

**Request:**

**Response:**

### Humanity: list search cards

**Method:** websocket

**Endpoint:** humanity:listSearchCards

**Description:** Api returns search cards for professional matrix.

**Request:**

**Response:**

### Humanity: update search card

**Method:** websocket

**Endpoint:** humanity:updateSearchCard

**Description:** Api updates search card for professional matrix

**Request:**

**Response:**

### Humanity: search rooms by search card

**Method:** websocket

**Endpoint:** humanity:searchBySearchCard

**Description:** Api returns list of rooms according to search card criteria.

Api returns PRIVATE rooms as well, so there could be scenario when user doesn't have permission to view room, and should ask room owner for access.

**Request:**

**Response:**

### Humanity: search card updated event

**Event:** humanity:searchCardUpdated

**Data:**

## Models

#### Room

#### Resource

#### Resource Origin

#### Geolocation

#### Dimensions

#### Resource Data Audio

#### Resource Data Video

#### Resource Data Amazon

#### Resource Data Imdb

#### Resource Data Youtube

#### Resource Data Vimeo

#### Resource Data Pinterest

#### Resource Data Pixabay

#### Resource Data Facebook

#### Resource Data Remote Url

#### Live Stream Data

#### AI Generation Data

#### Resource Data Directory

#### Google Drive

#### Channel Data

#### Enrichment Data

#### Programmatic Action with children

#### Programmatic Action

#### Room Style

#### Room Panel

#### Geometry

#### XYZ

#### Room Prop

#### User Simple

#### Storyline

#### Camera Position

#### XYZW