# Yepic AI Integration via LowCodeAPI

## Overview

AI video generation platform for creating talking head videos and video content

## Base Endpoint

```
https://api.lowcodeapi.com/yepicai/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Yepic AI](https://yepic.ai)
2. **Get your credentials** from [credential page](https://studio.yepic.ai)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

**Auth Type**: TOKEN

## API Categories

- **Asset Endpoints** - 8 endpoints
- **Avatar Endpoints** - 3 endpoints
- **Studio Pro Videos** - 6 endpoints

## Common Endpoints

### Category: Asset Endpoints

#### Get All Assets

**Method**: `GET` | **LowCodeAPI Path**: `/v1/assets`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets?PageSize={PageSize}&Page={Page}&api_token={api_token}
```

**Description**: Retrieves details of all assets

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`PageSize` | number | No | Page Size |
|`Page` | number | No | The page number to retrieve |

---

#### Get All Avatars

**Method**: `GET` | **LowCodeAPI Path**: `/v1/avatars`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/avatars?PageSize={PageSize}&Page={Page}&api_token={api_token}
```

**Description**: Retrieves a list of all avatars available

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`PageSize` | number | No | Page Size |
|`Page` | number | No | The page number to retrieve |

---

#### Get a Single Asset

**Method**: `GET` | **LowCodeAPI Path**: `/v1/assets/id`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets/id?api_token={api_token}
```

**Description**: Retrieves details of a specific asset by its ID

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Update an Asset Partially

**Method**: `PATCH` | **LowCodeAPI Path**: `/v1/assets/id`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets/id?api_token={api_token}
```

**Description**: Update a specific asset partially by providing a JSON patch document

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Delete an Asset

**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/assets/id`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets/id?api_token={api_token}
```

**Description**: Delete a specific asset from the system

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Create a New Asset (HTML form file upload)

**Method**: `POST` | **LowCodeAPI Path**: `/v1/assets/import/file`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets/import/file?api_token={api_token}
```

**Description**: Create a new asset by uploading a file using an HTML form

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Create a New Asset (JSON base64 data)

**Method**: `POST` | **LowCodeAPI Path**: `/v1/assets/import/json`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets/import/json?api_token={api_token}
```

**Description**: Create a new asset by providing JSON data with base64 encoded file content

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Create a New Asset (URL)

**Method**: `POST` | **LowCodeAPI Path**: `/v1/assets/import/url`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/assets/import/url?api_token={api_token}
```

**Description**: Create a new asset by providing a URL to the file

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Avatar Endpoints

#### Create an Avatar

**Method**: `POST` | **LowCodeAPI Path**: `/v1/avatars`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/avatars?api_token={api_token}
```

**Description**: Creates an avatar

---

#### Get Avatars

**Method**: `GET` | **LowCodeAPI Path**: `/v1/avatars/id`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/avatars/id?api_token={api_token}
```

**Description**: Retrieves details of a specific avatar by its ID

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Update an Avatar

**Method**: `PATCH` | **LowCodeAPI Path**: `/v1/avatars/id`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/avatars/id?api_token={api_token}
```

**Description**: Updates details of a specific avatar by its ID

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

### Category: Studio Pro Videos

#### Retrieve a studio pro video by ID

**Method**: `GET` | **LowCodeAPI Path**: `/v1/talkingphotos`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/talkingphotos?api_token={api_token}
```

**Description**: Retrieves a studio pro video by its ID

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Create a studio pro video

**Method**: `POST` | **LowCodeAPI Path**: `/v1/talkingphotos`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/talkingphotos?api_token={api_token}
```

**Description**: Creates a studio pro video

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update a studio pro video

**Method**: `PATCH` | **LowCodeAPI Path**: `/v1/talkingphotos`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/talkingphotos?api_token={api_token}
```

**Description**: Updates a studio pro video

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Delete a studio pro video

**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/talkingphotos`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/talkingphotos?api_token={api_token}
```

**Description**: Deletes a studio pro video

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Replace a draft studio pro video

**Method**: `PUT` | **LowCodeAPI Path**: `/v1/talkingphotos`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/talkingphotos?api_token={api_token}
```

**Description**: Replaces a draft studio pro video

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Requeue a studio pro video by ID

**Method**: `POST` | **LowCodeAPI Path**: `/v1/videos/requeue/id`

**Full URL**:
```
https://api.lowcodeapi.com/yepicai/v1/videos/requeue/id?api_token={api_token}
```

**Description**: Requeues a studio pro video by its ID

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

## Complete Endpoint Reference

For a complete list of all 17 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/yepicai/definition`
- **Official Provider Documentation**: https://docs.yepic.ai