Sendspark

https://help.sendspark.com/en/articles/
Admin
Sendspark is an AI-powered video creation and sharing platform that enables users to record,...
Tokens:100,954
Snippets:1,629
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### API Success Response Example

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

This is an example of a successful API response, detailing video transcription and screenshot settings.

```json
{
    "endTime": 1.5,
    "_id": "65e9d420asdb79aaa896"
}
]
},
"transcription": {
    "status": "completed",
    "reemplaceWords": [
        {
            "word": "watermelon",
            "replace": "{{firstname | there}}",
            "_id": "65e9d420b39717fa79aaa897"
        }
    ],
    "language": "en"
},
"screenshot": {
    "animations": {
        "scrolling": false
    },
    "enable": true
}
}
}
```
```

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

### Successful API Response Example (200)

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

This is an example of a successful response when creating or updating a dynamic video campaign via the API. It details the structure of the returned JSON object, including campaign details, video properties, creator information, and asset URLs.

```json
{
    "_id": "33m7w2ybr75cy6fq7453sasdxpuq3ej",
    "name": "My new DV Campaign",
    "videoProperties": {
        "sharePage": {
            "calendar": {},
            "title": "",
            "buttons": []
        }
    },
    "combinedVideo": false,
    "dynamicBackground": true,
    "status": "processing",
    "creator": {
        "workspaces": {
            "lastVisited": {
                "item": "w1dnne4qcsadfsacx9mf8tym0kd",
                "role": "admin",
                "firstName": "John",
                "lastName": "Doe",
                "jobTitle": "Developer"
            },
            "list": [
                {
                    "onboardingSetup": {
                        "mainFocusOption": "other",
                        "winOption": "other",
                        "teamOption": "team",
                        "mainFocusOptionDetail": "Help Sendspark achieve greatness!",
                        "winOptionDetail": "Helping Sendspark progress towards greatness"
                    },
                    "role": "owner",
                    "item": "ixjkg1owmngc41u5ugy0mejijuequ4ql",
                    "firstName": "John",
                    "lastName": "Doe",
                    "jobTitle": "Software Engineer",
                    "_id": "ofxfvm18c885sh4p733u2basd3ig",
                    "id": "ofxfvm18c885sh4p733u2bf4bu9hg3ig"
                }
            ]
        },
        "stats": {
            "views": 0,
            "plays": 0,
            "responses": 0,
            "ctas": 0,
            "thumbsUp": 0
        },
        "settings": {
            "thumbnails": {
                "imageFormat": "animated"
            },
            "suggestions": {
                "voiceCloning": {
                    "enabled": true
                }
            },
            "instantIntegrations": [],
            "siteConnections": [
                {
                    "enabled": true,
                    "_id": "6542d4c713562f000d7d4451",
                    "integration": "6542cfe7a99a21bf8027e127",
                    "id": "6542d4c713562f000d7d4451"
                }
            ]
        },
        "_id": "h6h5p5w7bw3pme4zwtp0diahy0jv5tmq",
        "byGoogle": true,
        "role": "admin",
        "status": "pending",
        "initialized": false,
        "org": "eninqth5blvhqs4mp4gjhzu0inigcxgs",
        "name": "Davi",
        "lastName": "Duarte Pereira",
        "email": "davi@sendspark.com",
        "jobTitle": "Dev",
        "isSubscriptionTrial": true,
        "onboardingCheckList": [
            {
                "completed": true,
                "_id": "64752af21b1475000e1f5eec",
                "onboarding": "637519409555c55ef3b412e8",
                "id": "64752af21b1475000e1f5eec"
            }
         ],
        "onboardingCompleted": true,
        "links": [],
        "phone": null,
        "crmShortcuts": [
            "6580efd71442b78ab6fe4f69"
        ],
        "id": "h6h5p5w7bw3pme4zwtp0diahy0jv5tmq"
    },
    "folder": "3k0vtaysmivgbg7fne2m2ytz1i0orpdz",
    "workspace": "w1dnne4qcatrajzwy4wacx9mf8tym0kd",
    "videosAssets": [
        {
            "_id": "mb4snq9ng3g7504kzezzrala996a9k1o",
            "provider": "sendspark",
            "url": "https://sendspark.com/share/lasznwqqasdsfmqg7e1vbf1iplu4i0",
            "assetUrl": "https://stream.mux.com/JeGcygdasasLccsmTc7k6HOL/medium.mp4",
            "duration": 18.209333,
            "assetId": "ufwbawxuhu3casfmase1z6z8506"
        }
    ],
    "createdAt": "2024-03-07T14:50:08.643Z",
    "metadata": {
        "version": "2"
    },
    "features": {
        "voiceCloning": {
            "enable": false,
            "status": "completed",
            "startTime": 0.26,
            "endTime": 1.5,
            "textGeneration": "hi {{firstname | there}},
            "stability": 0.95,
            "similarityBoost": 0.2,
            "errorPayload": null
        },
        "videoSettings": {
            "animationType": "fade-out-center-to-fade-in-bottom",
            "animations": [
                {
                    "template": "fade-out-center-to-fade-in-bottom",
                    "element": "bubble",
                    "startTime": 0.5
                }
            ]
        }
    }
}
```

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

### API Response Examples

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

Provides examples of successful and error responses from the Sendspark API.

```APIDOC
## Responses

### Successful Response (200)
**Model**
```json
{
  "name": "My Dynamic Campaign",
  "videoProperties": {
    "sharePage": {
      "title": "Hello there!",
      "message": "welcome to my dynamic campaign",
      "buttons": [
        {
          "position": 1,
          "label": "string",
          "link": "http://www.sendspark.com/"
        }
      ]
    }
  },
  "metadata": {
    "version": 1
  },
  "combinedVideo": false,
  "dynamicBackground": false,
  "status": "pending",
  "creator": "okn4ra9qjlpzhs2zpuni426jizysbdcp",
  "folder": "ibdls2hjvaebvg0k4mz0zgvndbai9th7",
  "workspace": "3vwdfm4jmhfyzt1yqp0r8v3qgaocrczb",
  "videosAssets": [
    "string"
  ],
  "_id": "63f6a4145a5e755e2e8fe19d",
  "createdAt": "2021-03-01T00:00:00.000Z",
  "deletedAt": "2023-11-13",
  "prospectList": [
    {
      "_id": "63f6a4145a5e755e2e8fe19d",
      "campaign": "okn4ra9qjl3fs2zpuni426jizysbdcp",
      "contactName": "John Doe",
      "contactEmail": "johndoe@example.com",
      "company": "Example Company",
      "jobTitle": "Example jobTitle",
      "backgroundUrl": "https://example.com",
      "screenshotUrl": "https://sendspark.com",
      "valid": false,
      "bulkId": "63f6a4145a5e755e2e8fe19d",
      "status": "saved",
      "createdAt": "2023-06-02T00:57:45.447Z",
      "updatedAt": "2023-06-02T00:57:45.447Z",
      "deletedAt": "2023-11-13",
      "validationDetails": "string",
      "webhookUrl": "https://any.com/webhook/unique-url",
      "webhookEvents": [
        "video_generated_dv",
        "video_viewed",
        "video_played",
        "video_watched",
        "video_liked",
        "video_cta_clicked"
      ]
    }
  ]
}
```

### Bad Request Response (400)
**Model**
```json
{
  "statusCode": 400,
  "code": "S400-AHVE",
  "error": "Bad Request",
  "message": "Invalid request payload input"
}
```

### Forbidden Response (403)
**Model**
```json
{
  "statusCode": 403,
  "code": "S403-UPLD",
  "error": "Forbidden",
  "message": "Invalid request payload input / Any error from provider"
}
```

### Not Found Response (404)
**Model**
```json
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Resource not found or invalid access"
}
```

### Service Unavailable Response (503)
**Model**
```json
{
  "statusCode": 503,
  "error": "Service Unavailable",
  "message": "Service Unavailable"
}
```
```

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

### Successful API Response (200)

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

Example of a successful response when listing dynamic campaigns. Includes details about created campaigns and their assets.

```json
{
  "response": {
    "data": [
      {
        "_id": "997f191e810c19729de860fd",
        "name": "string",
        "creator": {
          "_id": "997f191e810c19729de860fd",
          "name": "string",
          "lastName": "string",
          "email": "name@sendspark.com"
        },
        "createdAt": "2023-11-13",
        "videosAssets": [
          {
            "_id": "997f191e810c19729de860fd",
            "provider": "sendspark",
            "url": "http://www.sendspark.com/",
            "assetUrl": "http://www.sendspark.com/",
            "duration": 3.5284,
            "assetId": "997f191e810c19729de860fd"
          }
        ],
        "folder": "997f191e810c19729de860fd",
        "workspace": "997f191e810c19729de860fd",
        "videoProperties": {
          "sharePage": {
            "title": "string",
            "message": "string",
            "buttons": [
              {
                "position": 1,
                "label": "string",
                "link": "http://www.sendspark.com/"
              }
            ]
          }
        },
        "combinedVideo": "false",
        "dynamicBackground": "true",
        "metadata": {
          "version": "1"
        },
        "status": "pending"
      }
    ],
    "links": {
      "next": {
        "offset": 0,
        "limit": 0
      }
    },
    "pagination": {
      "offset": 0,
      "limit": 0,
      "total": 0
    }
  },
  "statusCode": 204
}
```

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

### Get Prospect Data by Email

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

Use this GET request to retrieve specific prospect data associated with a dynamic campaign using their email address. Ensure you include the correct workspace and dynamic IDs in the URL.

```http
GET https://api-gw.sendspark.com/v1/workspaces/etitqth5blvhqs4mp4gjhzu0inigcxgs/dynamics/p9efq8zdoyaye9w49blvhl2wgks7r0je/prospects/dan@sendspark.com
```

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

### Create Dynamic Video Campaign Headers

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

Use these headers when making a POST request to create a new dynamic video campaign. Ensure your API secret and key are correctly formatted.

```json
{
  "x-api-secret: <your-api-secret>"
  "x-api-key: <your-api-key>"
  "Accept: application/json"
}
```

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

### Generate Dynamic Video Prospect via HTTP Request

Source: https://help.sendspark.com/en/articles/9478441-api-automatically-create-dynamic-videos-via-api

Use this HTTP POST request in Make.com to automatically create a dynamic video for a prospect. Ensure your API Key and Secret Key are correctly configured in the headers. The body contains prospect details that can be made dynamic using Make's variables.

```json
{
"processAndAuthorizeCharge": true,
"prospectDepurationConfig": {
"forceCreation": false,
"payloadDepurationStrategy": "keep-last-valid"
},
"prospect": {
"contactName": "John",
"contactEmail": "john@sendspark.com",
"company": "Sendspark",
"customfield": "",
"backgroundUrl": "https://sendspark.com"
}
}
```

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

### Create a Dynamic Video Campaign

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

This endpoint allows you to create a new dynamic video campaign. You need to provide a name for the campaign and authenticate using your API key and secret.

```APIDOC
## POST /v1/workspaces/{workspaceId}/dynamics

### Description
Creates a new dynamic video campaign.

### Method
POST

### Endpoint
`https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics`

### Headers
- **x-api-secret** (string) - Required - Your API secret key.
- **x-api-key** (string) - Required - Your API key.
- **Accept** (string) - Required - `application/json`

### Request Body
- **name** (string) - Required - The name of the dynamic campaign.

### Request Example
```json
{
  "name": "Name of dynamic campaign"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created dynamic campaign.
- **name** (string) - The name of the dynamic campaign.
- **created_at** (string) - The timestamp when the campaign was created.

#### Response Example
```json
{
  "id": "dyn_abc123xyz",
  "name": "My New Dynamic Campaign",
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

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

### Service Unavailable API Response (503)

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

Example of a 'Service Unavailable' response, indicating a temporary issue with the API server.

```json
{
  "statusCode": 503,
  "error": "Service Unavailable",
  "message": "Service Unavailable"
}
```

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

### Not Found API Response (404)

Source: https://help.sendspark.com/en/articles/9051823-api-automatically-create-dynamic-videos-via-api

Example of a 'Not Found' response, indicating that the requested resource could not be found or accessed.

```json
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Resource not found or invalid access"
}
```

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

### ChatGPT Prompt for Phonetic Pronunciations

Source: https://help.sendspark.com/en/articles/8813812-voice-cloning-with-multiple-languages

Use this prompt with ChatGPT to generate phonetic pronunciations for names, ensuring accurate voice cloning for specific dialects. Format the output as a plain list.

```text
Please provide the phonetic pronunciations for these names written out, as if you were a native German speaking from Berlin. Please format the response in a list, without the original names, bullet points or any formatting:
Sophia
Leon
Hannah
Paul
Mia
The
Ella
Luca
Mila
Finn
Lina
Liam
Lia
Emil
Leni
Louis
Clara
Henry
Lea
Ben
```
Tokens:
Raw