{"info":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","description":"

Wochit Frame - White‑label Video Editor

Add Wochit Frame Editor to your platform and have your customers create professional videos swiftly and intuitively, without leaving your site.

Haven't found what you are looking for?
Please contact us for further information, business inquiries, or detailed instructions.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Wochit Frame - White‑label Video Editor","slug":"wochit-frame-whitelabel-video-editor"}],"owner":"13711385","collectionId":"c098e231-2f37-4629-b2d6-a3e9de968a42","publishedId":"2sAXxJha4w","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"06a9f4"},"publishDate":"2024-10-02T11:50:41.000Z"},"item":[{"name":"Quick Start","item":[],"id":"6f2fe82a-cdbc-4ca0-96a2-2686e5cd083c","description":"

Embedding Wochit - Overview

The Wochit Video Editor (\"Wochit Frame\") can be fully customized to fit your brand and offer the right templates for your audience. Log-in to our admin site to customize your Video Editor.

Get your video editor up and running in just 3 steps!

The general flow of the integration is as follows:

\n $\"Wochit%20Frame%20Integration%20Flow,%20how%20to%20embed%20a%20video%20editor%20in%20your%20website\"$ \n\n

Our recommendation would be to add a link or a button to your app, offering end-users to create their very own video. As can be seen in the diagram above, once an end-user chooses to create a video, this is the expected flow:

Generate A User Token for the end-user
\n
Use the token to Embed your video editor: an iFrame with your pre-customized Wochit Video Editor.
\n
Now it's our part! Inside the Wochit Video Editor, your end-user may choose from a variety of templates, visuals and sounds to make the perfect video for their business.
\n
While your customer enjoys the power of video creation, keep yourself aware of their actions. Once the video is ready, we will use a Webhook to push the video along with its metadata back to your backoffice.
\n

\n","_postman_id":"6f2fe82a-cdbc-4ca0-96a2-2686e5cd083c","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}}},{"name":"Single Account Setup","item":[{"name":"Single Account User Authentication","id":"ce869aa3-e83c-47a2-8c88-6658812381e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{secret_key}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"{{user_id}}\",\n \"email\": \"{{user_email}}\",\n \"firstName\": \"{{user_first_name}}\",\n \"lastName\": \"{{user_last_name}}\"\n }\n}"},"url":"https://authentication.wochit.com/api/v1/embedded/users/tokens","description":"

Single Account Setup - User Authentication

Generate a User Token (Single-Account Setup)

A user token must be generated and used for each video editor session. This token is mandatory for accessing the editor and is essential for securely identifying the user, linking the session to their account, and enabling the provision of relevant user analytics.

Below is the detailed API for authenticating a user entity in the Wochit platform.
During the authentication process new user entity will be created in Wochit in case this user does not exist yet and a token will be created to authenticate this user in future calls.

\n\n

Definitions:

Channel User: Your end-user interacting with your platform to create a video.
\n
Channel Client: The front-end application that communicates with the backend to fulfill user requests.
\n
Channel Server: The backend server responsible for handling requests from the front-end and communicating with external services.
\n
Wochit Service: The external video creation service that provides authentication tokens.
\n

Steps:

The Channel User clicks on the \"Create a video\" button in your application.
\n
The Channel Client (front-end) sends a request to the Channel Server (backend) to obtain a user token.
\n
The Channel Server makes an HTTP POST request to the Wochit authentication service to retrieve a user token.
\n
The Wochit service responds with the requested user token.
\n
The Channel Server returns this Wochit User Token to the Channel Client.
\n
The Channel Client then sets the Wochit User Token in the Wochit JS module for further use.
\n

Request

Call Wochit REST API to generate a user-token. This token will be used later on to open the Video Editor.

Header Parameters:

Client ID and Secret Key - these are your API keys. Please refer to our Developer Tools to obtain your keys.

NOTE: Your API keys carry many privileges, be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Body Parameters:

ID - mandatory. This is a unique identifier of your platform user.
\n
Email
\n
First Name
\n
Last Name (optional, highly recommended).
\n

These parameters will be used for statistics and usage reports.

Response

Successful response:

{\n  \"token\": {\n    \"value\": <token-value>,\n    \"expirationDate\": <token-expiration-date>\n  }\n}\n\n

The token value is the userToken. Use userToken to open the Wochit Video Editor.
The token expiration time is 24 hours from the creation time.

\n","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","embedded","users","tokens"],"host":["authentication","wochit","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"98118ee4-3450-4f4d-ae61-8135c00b7cc2","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{secret_key}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"{{user_id}}\",\n \"email\": \"{{user_email}}\",\n \"firstName\": \"{{user_first_name}}\",\n \"lastName\": \"{{user_last_name}}\"\n }\n}"},"url":"https://authentication.wochit.com/api/v1/embedded/users/tokens","description":"# User Authentication\n\n## Get a user token\n\nA user token is a unique access token that is used to authenticate the user. It allows us to securely identify the user, link it to your account, and provide you with related user analytics later on.\n\n### Request\n\nCall Wochit REST API to get a user-token. This token will be used later on to open the Video Editor.\n\n#### Header Parameters:\n* *Client ID* and *Secret Key* - these are your API keys. Please refer to our [Developer Tools](https://admin.wochit.com/developers/integration-setup) to obtain your keys.\n\nNOTE: Your API keys carry many privileges, be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\n#### Body Parameters:\n* ID - mandatory. This is a unique identifier of your platform user.\n* Email, First Name, Last Name - optional (highly recommended). These parameters will be used for statistics and usage reports.\n\n### Response\n\nSuccessful response:\n```json\n{\n \"token\": {\n \"value\": ,\n \"expirationDate\": \n }\n}\n```\n\nThe token value is the *userToken*. Use *userToken* to [open the Wochit Video Editor](/embed.html#set-configuration). \nThe token expiration time is 24 hours from the creation time.\n\n### Error handling\n\nWe use conventional HTTP response codes to indicate the success or failure of an API request. Here are some possible error responses:\n\n400 - Bad Request:\n```json\n{\n \"code\": 400,\n \"type\": \"Bad Request\",\n \"requestId\": \"cd1573f505be1e12aa023e500db50a09\",\n \"errors\": [\n {\n \"parameter\": \"use1\",\n \"message\": \"UNRECOGNIZED_PROPERTY\",\n \"details\": \"Unrecognized field \\\"use1\\\" (class models.requests.CreateInsideUserTokenRequestModel), not marked as ignorable\"\n }\n ]\n}\n```\n\n401 - Unauthorized:\n```json\n{\n \"code\": 401,\n \"type\": \"Unauthorized\",\n \"requestId\": \"a01bba8890f480fc0aef7d3723feb523\",\n \"errors\": [\n {\n \"message\": \"HTTP 401 Unauthorized\"\n }\n ]\n}\n```\n\n500 - Internal Server Error (Rare):\n```json\n{\n \"code\": 500,\n \"type\": \"Internal Server Error\",\n \"requestId\": \"90a5f277e13f78e26dbfd0d02c37f2d7\",\n \"errors\": []\n}\n```"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"token\": {\n \"value\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expirationDate\": \"2023-05-18T10:30:00Z\"\n }\n}"},{"id":"8bf2df32-65fc-4b0b-809a-162c885ca8c9","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{secret_key}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"{{user_id}}\",\n \"email\": \"{{user_email}}\",\n \"firstName\": \"{{user_first_name}}\",\n \"lastName\": \"{{user_last_name}}\"\n }\n}"},"url":"https://authentication.wochit.com/api/v1/embedded/users/tokens","description":"# User Authentication\n\n## Get a user token\n\nA user token is a unique access token that is used to authenticate the user. It allows us to securely identify the user, link it to your account, and provide you with related user analytics later on.\n\n### Request\n\nCall Wochit REST API to get a user-token. This token will be used later on to open the Video Editor.\n\n#### Header Parameters:\n* *Client ID* and *Secret Key* - these are your API keys. Please refer to our [Developer Tools](https://admin.wochit.com/developers/integration-setup) to obtain your keys.\n\nNOTE: Your API keys carry many privileges, be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\n#### Body Parameters:\n* ID - mandatory. This is a unique identifier of your platform user.\n* Email, First Name, Last Name - optional (highly recommended). These parameters will be used for statistics and usage reports.\n\n### Response\n\nSuccessful response:\n```json\n{\n \"token\": {\n \"value\": ,\n \"expirationDate\": \n }\n}\n```\n\nThe token value is the *userToken*. Use *userToken* to [open the Wochit Video Editor](/embed.html#set-configuration). \nThe token expiration time is 24 hours from the creation time.\n\n### Error handling\n\nWe use conventional HTTP response codes to indicate the success or failure of an API request. Here are some possible error responses:\n\n400 - Bad Request:\n```json\n{\n \"code\": 400,\n \"type\": \"Bad Request\",\n \"requestId\": \"cd1573f505be1e12aa023e500db50a09\",\n \"errors\": [\n {\n \"parameter\": \"use1\",\n \"message\": \"UNRECOGNIZED_PROPERTY\",\n \"details\": \"Unrecognized field \\\"use1\\\" (class models.requests.CreateInsideUserTokenRequestModel), not marked as ignorable\"\n }\n ]\n}\n```\n\n401 - Unauthorized:\n```json\n{\n \"code\": 401,\n \"type\": \"Unauthorized\",\n \"requestId\": \"a01bba8890f480fc0aef7d3723feb523\",\n \"errors\": [\n {\n \"message\": \"HTTP 401 Unauthorized\"\n }\n ]\n}\n```\n\n500 - Internal Server Error (Rare):\n```json\n{\n \"code\": 500,\n \"type\": \"Internal Server Error\",\n \"requestId\": \"90a5f277e13f78e26dbfd0d02c37f2d7\",\n \"errors\": []\n}\n```"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"type\": \"Bad Request\",\n \"requestId\": \"cd1573f505be1e12aa023e500db50a09\",\n \"errors\": [\n {\n \"parameter\": \"use1\",\n \"message\": \"UNRECOGNIZED_PROPERTY\",\n \"details\": \"Unrecognized field \\\"use1\\\" (class models.requests.CreateInsideUserTokenRequestModel), not marked as ignorable\"\n }\n ]\n}"},{"id":"f287e275-efd3-4878-94bf-0a8a16b148d0","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{secret_key}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"{{user_id}}\",\n \"email\": \"{{user_email}}\",\n \"firstName\": \"{{user_first_name}}\",\n \"lastName\": \"{{user_last_name}}\"\n }\n}"},"url":"https://authentication.wochit.com/api/v1/embedded/users/tokens","description":"# User Authentication\n\n## Get a user token\n\nA user token is a unique access token that is used to authenticate the user. It allows us to securely identify the user, link it to your account, and provide you with related user analytics later on.\n\n### Request\n\nCall Wochit REST API to get a user-token. This token will be used later on to open the Video Editor.\n\n#### Header Parameters:\n* *Client ID* and *Secret Key* - these are your API keys. Please refer to our [Developer Tools](https://admin.wochit.com/developers/integration-setup) to obtain your keys.\n\nNOTE: Your API keys carry many privileges, be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\n#### Body Parameters:\n* ID - mandatory. This is a unique identifier of your platform user.\n* Email, First Name, Last Name - optional (highly recommended). These parameters will be used for statistics and usage reports.\n\n### Response\n\nSuccessful response:\n```json\n{\n \"token\": {\n \"value\": ,\n \"expirationDate\": \n }\n}\n```\n\nThe token value is the *userToken*. Use *userToken* to [open the Wochit Video Editor](/embed.html#set-configuration). \nThe token expiration time is 24 hours from the creation time.\n\n### Error handling\n\nWe use conventional HTTP response codes to indicate the success or failure of an API request. Here are some possible error responses:\n\n400 - Bad Request:\n```json\n{\n \"code\": 400,\n \"type\": \"Bad Request\",\n \"requestId\": \"cd1573f505be1e12aa023e500db50a09\",\n \"errors\": [\n {\n \"parameter\": \"use1\",\n \"message\": \"UNRECOGNIZED_PROPERTY\",\n \"details\": \"Unrecognized field \\\"use1\\\" (class models.requests.CreateInsideUserTokenRequestModel), not marked as ignorable\"\n }\n ]\n}\n```\n\n401 - Unauthorized:\n```json\n{\n \"code\": 401,\n \"type\": \"Unauthorized\",\n \"requestId\": \"a01bba8890f480fc0aef7d3723feb523\",\n \"errors\": [\n {\n \"message\": \"HTTP 401 Unauthorized\"\n }\n ]\n}\n```\n\n500 - Internal Server Error (Rare):\n```json\n{\n \"code\": 500,\n \"type\": \"Internal Server Error\",\n \"requestId\": \"90a5f277e13f78e26dbfd0d02c37f2d7\",\n \"errors\": []\n}\n```"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 401,\n \"type\": \"Unauthorized\",\n \"requestId\": \"a01bba8890f480fc0aef7d3723feb523\",\n \"errors\": [\n {\n \"message\": \"HTTP 401 Unauthorized\"\n }\n ]\n}"},{"id":"f715a629-0c7f-484c-b247-d87e092ca57c","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{secret_key}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"{{user_id}}\",\n \"email\": \"{{user_email}}\",\n \"firstName\": \"{{user_first_name}}\",\n \"lastName\": \"{{user_last_name}}\"\n }\n}"},"url":"https://authentication.wochit.com/api/v1/embedded/users/tokens","description":"# User Authentication\n\n## Get a user token\n\nA user token is a unique access token that is used to authenticate the user. It allows us to securely identify the user, link it to your account, and provide you with related user analytics later on.\n\n### Request\n\nCall Wochit REST API to get a user-token. This token will be used later on to open the Video Editor.\n\n#### Header Parameters:\n* *Client ID* and *Secret Key* - these are your API keys. Please refer to our [Developer Tools](https://admin.wochit.com/developers/integration-setup) to obtain your keys.\n\nNOTE: Your API keys carry many privileges, be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\n#### Body Parameters:\n* ID - mandatory. This is a unique identifier of your platform user.\n* Email, First Name, Last Name - optional (highly recommended). These parameters will be used for statistics and usage reports.\n\n### Response\n\nSuccessful response:\n```json\n{\n \"token\": {\n \"value\": ,\n \"expirationDate\": \n }\n}\n```\n\nThe token value is the *userToken*. Use *userToken* to [open the Wochit Video Editor](/embed.html#set-configuration). \nThe token expiration time is 24 hours from the creation time.\n\n### Error handling\n\nWe use conventional HTTP response codes to indicate the success or failure of an API request. Here are some possible error responses:\n\n400 - Bad Request:\n```json\n{\n \"code\": 400,\n \"type\": \"Bad Request\",\n \"requestId\": \"cd1573f505be1e12aa023e500db50a09\",\n \"errors\": [\n {\n \"parameter\": \"use1\",\n \"message\": \"UNRECOGNIZED_PROPERTY\",\n \"details\": \"Unrecognized field \\\"use1\\\" (class models.requests.CreateInsideUserTokenRequestModel), not marked as ignorable\"\n }\n ]\n}\n```\n\n401 - Unauthorized:\n```json\n{\n \"code\": 401,\n \"type\": \"Unauthorized\",\n \"requestId\": \"a01bba8890f480fc0aef7d3723feb523\",\n \"errors\": [\n {\n \"message\": \"HTTP 401 Unauthorized\"\n }\n ]\n}\n```\n\n500 - Internal Server Error (Rare):\n```json\n{\n \"code\": 500,\n \"type\": \"Internal Server Error\",\n \"requestId\": \"90a5f277e13f78e26dbfd0d02c37f2d7\",\n \"errors\": []\n}\n```"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"type\": \"Internal Server Error\",\n \"requestId\": \"90a5f277e13f78e26dbfd0d02c37f2d7\",\n \"errors\": []\n}"}],"_postman_id":"ce869aa3-e83c-47a2-8c88-6658812381e6"}],"id":"0a9a0844-b13a-4664-8fa9-05863e44a181","description":"

Single Account Setup

The standard and most commonly implemented method for integrating the Wochit Video Editor into your platform. The Single Account Setup is the recommended approach for most use cases, offering a streamlined integration process.

This section covers the essential steps for integrating the Wochit Video Editor using a single account configuration. Here, you'll find the necessary API calls and processes to authenticate users and manage their access to the Wochit platform.

\n","_postman_id":"0a9a0844-b13a-4664-8fa9-05863e44a181","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}}},{"name":"Multi Account Setup","item":[{"name":"Create New Account","id":"a524eb88-98f2-44f9-8823-10f80e076285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"channel-id","value":"{{channel_id}}"},{"key":"Authorization","value":"Bearer {{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{{customer_name}}\",\n \"organization\": {\n \"partnerId\": \"{{customer_partner_id}}\"\n },\n \"adminUserRequestModel\": {\n \"firstName\": \"{{contact_first_name}}\",\n \"lastName\": \"{{contact_last_name}}\",\n \"email\": \"{{contact_email}}\",\n \"phone\": \"{{contact_phone}}\"\n },\n \"templateCategoryIds\": [\n \"1\",\"2\",\"3\"\n ]\n}"},"url":"https://studio-api.wochit.com/api/v1/customers","description":"

Multi Account Setup - Create a New Customer

Below is the detailed API for creating a new customer entity in the Wochit platform:

POST https://studio-api.wochit.com/api/v1/customers

Request Body Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Values	Description
name	String		(Required Unique) customer's name
organization.partnerId	String		(Required Unique) Your customer's unique ID. This unique ID will be used to recognize your customer in future references.
adminUserRequestModel.firstName	String		(Optional) The contact person's first name
adminUserRequestModel.lastName	String		(Optional) The contact person's last name
adminUserRequestModel.email	String		(Optional) The contact person's email
adminUserRequestModel.phone	String		(Optional) The contact person's phone number
templateCategoryIds	Array	[\"1\",\"2\",\"3\"]	(Optional) Limit customers template selection to specific categories (obtained by the channel information route)

Response

Successful response:

{\n  \"organizationId\": 12345\n}\n\n

Multi Account Setup - Retrieve Channel Information

You can retrieve data about your channel (like available template categories) in order to properly adjust your customer's settings & experience:

GET https://studio-api.wochit.com/api/v1/channels/{channelId}

Response

Successful response:

{\n  \"templateCategories\": [\n    {\n      \"id\": \"1\",\n      \"name\": \"Shopping\"\n    },\n    {\n      \"id\": \"2\",\n      \"name\": \"Blogging\"\n    }\n  ]\n}\n\n

Multi Account Setup - Update Channel

Below is the detailed API for updating an existing customer entity in the Wochit platform:
As of the PATCH HTTP method, every field that will be sent in the request will result in an update of that field in the Customer entity, otherwise, if the field will not be sent - it will not be updated.
If a 'null' value will be sent - the field will be deleted.

PATCH https://studio-api.wochit.com/api/v1/customers

Request Body Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Values	Description
organization.partnerId	String		(Required Unique) Your customer's unique ID
fieldsUpdates.hostedMedia.provider	Number	1	(Optional) Contact to Wochit support for more information
fieldsUpdates.templateCategoryIds	Array	[\"1\",\"2\",\"3\"]	(Optional) Limit customers template selection to specific categories (obtained by the channel information route)

Response

Successful response: 202 Accepted (empty body)

Multi Account Setup - User Authentication

Generate a User Token (Multi-Account Setup)

\n\n

Definitions:

Channel User: Your end-user interacting with your platform to create a video.
\n
Channel Client: The front-end application that communicates with the backend to fulfill user requests.
\n
Channel Server: The backend server responsible for handling requests from the front-end and communicating with external services.
\n
Wochit Service: The external video creation service that provides authentication tokens.
\n

Steps:

The Channel User clicks on the \"Create a video\" button in your application.
\n
The Channel Client (front-end) sends a request to the Channel Server (backend) to obtain a user token.
\n
The Channel Server makes an HTTP POST request to the Wochit authentication service to retrieve a user token.
\n
The Wochit service responds with the requested user token.
\n
The Channel Server returns this Wochit User Token to the Channel Client.
\n
The Channel Client then sets the Wochit User Token in the Wochit JS module for further use.
\n

Below is the detailed API for authenticating a user entity in the Wochit platform.
Authentication is done by calling the Wochit API. During the authentication process new user entity will be created in Wochit in case this user does not exist yet and a token will be created to authenticate this user in future calls.

Request Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
user.id	String	(Required Unique) Your unique user identifier
email	String	(Optional) The user's email
firstName	String	(Optional) The user's first name
lastName	String	(Optional) The user's last name
organization.partnerId	String	(Required Unique) Your customer's unique ID

Response

Successful response:

{\n  \"token\": {\n    \"value\":  \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n    \"expirationDate\": 1621332600000\n  }\n}\n\n

Multi Account Setup

This section covers the advanced multi-account (aka \"multi-channel\") setup for integrating the Wochit Video Editor.
Use this approach when you need to manage multiple customers under your primary account, providing a more flexible and scalable integration.

The Multi Account Setup allows you to:

Retrieve channel information
\n
Create and manage customer accounts
\n
Update existing customer settings
\n
Authenticate users within specific customer contexts
\n

This setup is ideal for platforms that serve multiple distinct customer bases or require separate configurations for different user groups.

\n","_postman_id":"f0e1efcc-8603-4410-b733-7f5cc73574ce","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}}},{"name":"Wochit Frame Javascript Module","item":[{"name":"Install the Wochit Javascript Module","item":[],"id":"1921a267-eadf-459a-8b53-4acf20390e24","description":"

The Wochit JavaScript module may be installed as an NPM package, or as an HTML script snippet.

NPM Setup

npm i @wochit/embedded\n\n

HTML Snippet Setup

<script type=\"application/javascript\">\n(function (window, document, tag, url, name, a, m) {\n    window['__wochit_object_name__'] = name;\n    window[name] =\n      window[name] ||\n      function () {\n        (window[name].q = window[name].q || []).push(arguments);\n};\n    (a = document.createElement(tag)), (m = document.getElementsByTagName(tag)[0]);\n    a.async = 1;\n    a.src = url;\n    m.parentNode.insertBefore(a, m);\n  })(window, document, 'script', 'https://embedded.wochit.com/latest.min.js', 'wt');\n</script>\n\n

\n","_postman_id":"1921a267-eadf-459a-8b53-4acf20390e24","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"22563ac7-1a28-48a9-8363-26615ead0753","id":"22563ac7-1a28-48a9-8363-26615ead0753","name":"Wochit Frame Javascript Module","type":"folder"}}},{"name":"Wochit Frame Javascript Configuration","item":[],"id":"0c3b7d1b-cefd-43ad-a745-ea57b9e0e766","description":"

Call the config() method to set up the integration context. This method must be called only once in the scope, where Client ID and userToken are easily available.

NPM Setup

import { config } from '@wochit/embedded';\nconfig({ clientId: clientId, userToken: userToken });\n\n

HTML Snippet Setup

window.wt('config', { clientId: clientId, userToken: userToken });\n\n

clientId string
Your unique Client ID.
Log-in to the Wochit Developers’ Tools to obtain your Client ID.

userToken string
A user token that is the unique key generated every time a user accesses the Wochit Video Editor, as explained above.

\n","_postman_id":"0c3b7d1b-cefd-43ad-a745-ea57b9e0e766","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"22563ac7-1a28-48a9-8363-26615ead0753","id":"22563ac7-1a28-48a9-8363-26615ead0753","name":"Wochit Frame Javascript Module","type":"folder"}}},{"name":"Open Wochit Frame Editor","item":[],"id":"0ee021a7-b222-4bc3-8fa2-e22bd6f285d6","description":"

Open Wochit Frame Editor in Your Website

Call openVideoEditor() to open your customized Wochit Video Editor in an embedded iFrame.
The following example shows how to create a button or a link that triggers the openVideoEditor action:

NPM Setup

import { openVideoEditor } from '@wochit/embedded';\ndocument.querySelector('.video-editor-btn').addEventListener('click', () => {\n  openVideoEditor({\n    videoContext: 'custom-video-context',\n  }); \n});\n\n

HTML Snippet Setup

document.querySelector('.video-editor-btn').addEventListener('click', () => {\n  window.wt('openVideoEditor', {\n    videoContext: 'custom-video-context',\n  });\n});\n\n

Customize the Wochit Video Editor

To customize the Wochit Video Editor, you may include one or more of the following parameters in the configuration object passed to the openVideoEditor function:

videoContext string (Optional)
A unique identifier to link any video being edited in the Wochit Video Editor to your internal systems. While optional, it's highly valuable for integration. Examples include customer IDs, page IDs, or any custom metadata.
This identifier is returned in Webhooks, API responses, and Javascript callbacks, enabling automated workflows and efficient video management within your ecosystem.

videoId string (Optional)
Specifying a video ID allows users to retrieve and modify either a previously generated video or a saved draft, enabling seamless continuation of editing work. (Working with Webhooks)

on object (Optional)
While your end-user interacts with the Wochit Video Editor iFrame, events will be triggered to notify you of the user's actions and allow you to react to these. (Triggered Events)

showCreativeGallery boolean (Optional)
Whether to allow users to choose from Wochit's extensive library of rights-cleared stock photos and videos image and video creative library.

showUploadGallery boolean (Optional)
Whether to allow users to upload their own content from their device.

destLanguage string (Optional)
Pass language code to adjust the Video Editor UI. Available options are: en, es, fr and de.

aspectRatios string[] (Optional)
To filter the templates with specific aspect ratios, pass a list of comma-separated aspect ratios.

galleryAssets object[] (Optional)
You may pass a list of image / video URLs. The Wochit Video Editor will show these assets under the \"My Gallery\" tab, for the end-user to choose for their video.

linkedFields object (Optional)
Wochit's Video Editor can jump-start the templates with pre-injected data, personalized to each user.

categoryNames string[] (Optional)
Each template in the template gallery belongs to one or more categories. Use the categoryNames parameter to filter the template gallery for specific categories.

categoryIds string[] (Optional)
Each template in the template gallery has its own unique identifier. Use the categoryId parameter to filter the template gallery for specific categories.

containerEl HTMLElement (Optional)
By default, the Wochit Video Editor will open as a modal in your website / app. If you wish to embed the Video Editor as an inline element inside a page, you can pass a container element to the containerEl property.

blockAiMenu boolean (Optional)
Controls the visibility of AI-powered features in the editor interface. When set to `true`, AI menu options will be hidden even for accounts with AI capabilities enabled. Defaults to `false`.
* Note that displaying AI features requires both this parameter to be `false` and appropriate account-level permissions.

templateLanguageFilter string (Optional)
Filters templates by language. To show templates in a specific language, provide the full language name (for example: 'English'). When the language filter is disabled in the admin settings, this parameter restricts available templates to the specified language only.
Set to null or omit this parameter to use system defaults.

\n","_postman_id":"0ee021a7-b222-4bc3-8fa2-e22bd6f285d6","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"22563ac7-1a28-48a9-8363-26615ead0753","id":"22563ac7-1a28-48a9-8363-26615ead0753","name":"Wochit Frame Javascript Module","type":"folder"}}},{"name":"Triggered Javascript Events","item":[],"id":"c9018007-4ef7-4570-922c-a475048bc5da","description":"

Front-End Interaction Callbacks

As the user interacts with the Wochit Video Editor, several events will be triggered. You can implement callback functions on your side to react to these events.

Important: A faster and safer way to retrieve the video file at the end of the process is by implementing a listener to a Webhook endpoint.

For technical assistance, contact Wochit support.

NPM Setup

openVideoEditor({\n    videoContext: 'my-page-context',\n    on: {\n      loaded: ($iframe) => {\n        console.log('loaded', $iframe);\n      },\n      ready: () => {\n        console.log('ready');\n      },\n      abort: (payload) => {\n        console.log('abort', payload);\n      },\n      produce: (payload) => {\n        console.log('produce', payload);\n      },\n    },\n  }); \n});\n\n

HTML Snippet Setup

  window.wt('openVideoEditor', {\n    videoContext: 'my-page-context',\n    on: {\n      loaded: ($iframe) => {\n        console.log('loaded', $iframe);\n      },\n      ready: () => {\n        console.log('ready');\n      },\n      abort: (payload) => {\n        console.log('abort', payload);\n      },\n      produce: (payload) => {\n        console.log('produce', payload);\n      },\n    },\n  });\n});\n\n

Event Types

on.loaded

Triggered when the Video Editor resources have been loaded.

on.ready

Triggered when the Video Editor is ready to use and the user can start working.

on.draft_new

Triggered when the Video Draft has been created.
Payload example:

{\n  \"videoContext\": \"ABC\",\n  \"videoId\": \"6094092472a9105747957aa3\",\n  \"awaitingAiContent\": true  // Only present for AI-generated stories\n}\n\n

The awaitingAiContent flag indicates that this draft represents an AI-requested video that is currently locked while waiting for the AI generation job to complete. This flag will only be present in the payload for AI-generated video drafts.

on.ai_draft_ready

Triggered when an AI-generated video draft is ready for editing. This event fires after the AI generation process completes and the draft becomes available for user interaction.
Payload example:

{\n  \"videoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"ABC\",\n  \"title\": \"AI Generated Video Title\"\n}\n\n

Note: This client-side event does not include the thumbnailUrl. Always use the AI Draft Ready Webhook as your primary source of data to ensure reliable and secure event handling which includes the thumbnail URL with all the required metadata.

on.draft_delete

Triggered when the Video Draft has been deleted by the user.

Payload example:

{\n  \"videoContext\": \"ABC\",\n  \"videoId\": \"6094092472a9105747957aa3\"\n}\n\n

on.produce

Triggered when the user clicks the 'Produce' button. A payload with the Wochit videoId will be passed to the event.

Payload example:

{\n  \"duration\": 18.5341,\n  \"title\": \"Video Title\",\n  \"videoContext\": \"ABC\",\n  \"videoId\": \"6094092472a9105747957aa3\",\n  \"videoState\": \"PROCESSING\"\n}\n\n

on.abort

Triggered when the user clicks the 'Exit' button or chooses to close the Video Editor.

on.produce_done

Triggered as soon as a video is produced. A payload with a link to the video and additional metadata will be passed to the event.

Payload example (Success):

{\n  \"state\": \"DONE\",\n  \"videoId\": \"6094092472a9105747957aa3\",\n  \"duration\": 35.192,\n  \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n  \"title\": \"The video title\",\n  \"videoUrl\": \"https://example.com/direct-link-to-video\",\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\"\n}\n\n

Payload example (Failure - Rare):

{\n  \"state\": \"FAILED\",\n  \"videoId\": \"6094092472a9105747957aa3\",\n  \"duration\": null,\n  \"videoContext\": null,\n  \"title\": null,\n  \"videoUrl\": null,\n  \"thumbnailUrl\": null\n}\n\n

Attribute Descriptions

state (string): Indicates the state of the video. 'PROCESSING' is the initial state, 'DONE' means successful production, 'FAILED' means production failed.
\n
wochitVideoId (string): Wochit's unique identifier for this video. Can be used to re-edit the video.
\n
duration (float): The video duration in seconds.
\n
videoContext (string): String initiated when calling openVideoEditor(). Connects the video to the video editor instance.
\n
title (string): The title of the video. Editable by the user in the video editor.
\n
videoUrl (string): Direct link to the video. Links expire after 24 hours.
\n
thumbnailUrl (string): Direct link to the video thumbnail. Links expire after 24 hours.
\n

Important: A faster and safer way to retrieve the video file at the end of the process is by implementing a listener to a Webhook endpoint.

For technical assistance, contact Wochit support.

\n","_postman_id":"c9018007-4ef7-4570-922c-a475048bc5da","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"22563ac7-1a28-48a9-8363-26615ead0753","id":"22563ac7-1a28-48a9-8363-26615ead0753","name":"Wochit Frame Javascript Module","type":"folder"}}},{"name":"Personalize the Experience","item":[],"id":"56de09c8-334d-494b-91b0-6d878cc6187d","description":"

Personalize the Experience

All default values for the Wochit Video Editor are defined in our admin tool.
However, sometimes, you may need to personalize the experience for specific users. For example - you may want to add more features to premium users; or set up a different UI language for users based on their localization. This can be done by setting overriding the defaults and passing specific parameters to the openVideoEditor() function.

Add personal asset gallery

In case your platform already stores photos or videos associated with your customer (e.g. assets they've uploaded directly to your platform), it is fairly easy to present them with their own gallery inside the Wochit Video Editor. All you have to do is pass a list of image / video URLs. These assets will be shown in the 'My Gallery' tab for the user to pick and choose for their video creation. Personalized galleries may be organized in folders.

galleryAssets: [\n  {\n    title: 'My Project',\n    assets: [\n      {\n        url: 'https://cdn1.sample.com/image1.jpg',\n        type: 'image',\n      },\n      {\n        url: 'https://cdn1.sample.com/video.mp4',\n        thumbnailUrl: 'https://cdn1.sample.com/videoThumbnail.jpg',\n        duration: 2.21, \n        type: 'video',\n      },\n    ],\n  },\n  {\n    title: 'My Profile',\n    assets: [\n      {\n        url: 'https://cdn1.sample.com/image2.jpg',\n        type: 'image',\n      },\n      {\n        url: 'https://cdn1.sample.com/video2.mp4',\n        thumbnailUrl: 'https://cdn1.sample.com/videoThumbnail2.jpg',\n        duration: 5.21, \n        type: 'video',\n      },\n    ],\n  },\n]\n\n

Linked fields

The Wochit Video Editor can jump-start the templates with pre-injected data, personalized to each user. Use Linked Fields to auto-fill texts like user name, address, project name, etc; as well as to pre-select assets for the video, such as: company logo, project pictures and so on.

Click here to learn how Linked Fields can speed up the video creation process to literally 2 clicks per video.

\n","_postman_id":"56de09c8-334d-494b-91b0-6d878cc6187d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"22563ac7-1a28-48a9-8363-26615ead0753","id":"22563ac7-1a28-48a9-8363-26615ead0753","name":"Wochit Frame Javascript Module","type":"folder"}}}],"id":"22563ac7-1a28-48a9-8363-26615ead0753","description":"

Wochit Frame Javascript Module

This section guides you through the process of embedding the Wochit Video Editor into your web application. It covers installation of the Wochit JavaScript module, configuration, opening the video editor, handling events, and personalizing the user experience.

The embedding process involves client-side JavaScript integration, allowing you to seamlessly incorporate the Wochit Video Editor into your platform. Follow the steps outlined in this section to provide your users with a powerful, customized video creation experience directly within your application.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5474b795-a7cc-4f98-83af-69507754b062","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"4e3852cb-7a2d-472d-8d4a-0ff3afe41dac","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"22563ac7-1a28-48a9-8363-26615ead0753"},{"name":"Listen To a Webhook","item":[{"name":"Video Production Webhooks","id":"5659cf44-5c7a-435b-88ca-4703102a4415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"eventType\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"...\", \n \"videoUrl\": \"...\", \n \"title\": \"...\",\n \"videoDuration\" : 0.0\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook","description":"

Video Production Webhooks

A webhook will be triggered as soon as a video is produced. A payload with a link to the video alongside some additional metadata will be pushed to your webhook endpoint.

We send a notification when a video has been produced successfully, video production has failed, or video has been deleted from the Wochit servers.

Once a video event is triggered, a POST request will be sent to the provided Webhook address. Expect the following JSON structure (the content of the object is defined according to its type):

Attributes:

type string
This property indicates the state of the video:

video.ready means that the video has been produced successfully
\n
video.failed means that the video production failed
\n
video.delete means a video was deleted
\n

wochitVideoId string
Wochit unique identifier for this video. You can use it to re-edit the video.

videoDuration float
The video duration in seconds.

videoContext string
String initiated when calling openVideoEditor(). videoContext connects the video to the video editor instance, so you can know where the video belongs to.

title string
The title of the video. The user can edit the video title in the video editor.

videoUrl string
Direct link to the video. Links have an expiration time of 24 hours so make sure you download the video to your system and use your own storage / CDN.

thumbnailUrl string
Direct link to the thumbnail (poster frame) of the video. Links have an expiration time of 24 hours so make sure to download it to your system and use your own storage / CDN.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"36497199-85bb-422d-a425-24f3e7d6a228","id":"36497199-85bb-422d-a425-24f3e7d6a228","name":"Listen To a Webhook","type":"folder"}},"urlObject":{"protocol":"https","path":["your-webhook"],"host":["your-webhook-endpoint","com"],"query":[],"variable":[]}},"response":[{"id":"c9bd3344-6241-42a3-b189-d83b97de6467","name":"Video Ready","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"state\": \"DONE\",\n \"videoId\": \"6094092472a9105747957aa3\",\n \"duration\": 35.192, \n \"videoContext\": \"VideoContext that was sent to the video editor\",\n \"title\": \"The video title\",\n \"videoUrl\": \"https://example.com/direct-link-to-video\",\n \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\" : \"video.ready\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\", \n \"videoUrl\": \"https://example.com/direct-link-to-video\", \n \"title\": \"The video title\",\n \"videoDuration\" : 35.9\n}"},{"id":"b5034db8-b782-419a-a1cf-036b26f6750d","name":"Video Production Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"state\": \"DONE\",\n \"videoId\": \"6094092472a9105747957aa3\",\n \"duration\": 35.192, \n \"videoContext\": \"VideoContext that was sent to the video editor\",\n \"title\": \"The video title\",\n \"videoUrl\": \"https://example.com/direct-link-to-video\",\n \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\" : \"video.failed\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\", \n \"videoUrl\": \"https://example.com/direct-link-to-video\", \n \"title\": \"The video title\",\n \"videoDuration\" : 35.9\n}"},{"id":"70923def-1e8c-4ba0-87f3-de23b55a3182","name":"Video Deleted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"state\": \"DONE\",\n \"videoId\": \"6094092472a9105747957aa3\",\n \"duration\": 35.192, \n \"videoContext\": \"VideoContext that was sent to the video editor\",\n \"title\": \"The video title\",\n \"videoUrl\": \"https://example.com/direct-link-to-video\",\n \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\" : \"video.delete\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"title\": \"The video title\"\n}"}],"_postman_id":"5659cf44-5c7a-435b-88ca-4703102a4415"},{"name":"Drafts Management Webhooks","id":"03d6ebc8-1f83-473e-b1b7-926ddaf2ab8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"eventType\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"...\", \n \"videoUrl\": \"...\", \n \"title\": \"...\",\n \"videoDuration\" : 0.0\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook","description":"

Drafts Management Webhooks

Webhooks are also used for managing drafts. You'll receive notifications when drafts are created, updated, or deleted.

Draft Creation

{\n  \"type\": \"draft.new\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\",\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\",    \n  \"title\": \"Draft title\"\n}\n\n

Draft Update

Triggered each time the user makes changes to a video draft.

The draft.update webhook is triggered on every autosave of the draft, but we do not send it by default. If you wish to subscribe to this event, please Contact us.

{\n  \"type\": \"draft.update\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\",\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\",    \n  \"title\": \"Updated draft title\"\n}\n\n

Draft Deletion

Triggered once a user deletes a draft within the video editor

{\n  \"type\": \"draft.delete\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\"\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\",  \n  \"title\": \"Updated draft title\"\n}\n\n

Draft Exit

Triggered once a user exits the video editor

{\n  \"type\": \"draft.exit\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\",\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\",    \n  \"title\": \"The video title\" \n}\n\n

Ensure your webhook endpoint is set up to handle these events appropriately.

Attributes:

type string
The type of the event.

videoContext string
String initiated when calling openVideoEditor(). videoContext connects the video to the Video Editor instance, so you can associate the video with the right end-user, customer or page it belongs to.

wochitVideoId string
Wochit unique identifier for this video. You can use it to re-edit the video.

thumbnailUrl string (optional)
Direct link to the thumbnail of the video. Links have an expiration time of 24 hours so make sure you download the video to your system and use your own storage / CDN.

title string
The title of the video. The title is given by the end-user.

AI Drafts Webhooks

Wochit Frame video editor offers AI-powered video creation capabilities.

This feature is available upon request. Please contact us for further information, business inquiries, or detailed instructions.

Once an AI draft video is requested by your client, the creation process may take some time.

While the AI draft creation is in progress, the video cannot be edited.
However, the Frame editor can still be initialized using the AI draft's video ID.
When users access the Frame editor during this process, they will be presented with a loading or preparation screen, indicating that the AI draft is still being generated, and then redirected to the editing page.

We recommend labeling the draft entity on your end with a specific 'AI in progress' status. This will help distinguish AI-generated drafts that are still being processed from other types of content in your system.

AI Draft Creation Webhook

We will send an ai.draft.new webhook notification when the process begins, allowing you to manage the necessary entities on your end.

{\n  \"type\": \"ai.draft.new\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\", \n  \"title\": \"Temporary AI Draft Title\"\n}\n\n

AI Draft Ready Webhook

Upon completion of the AI draft generation process, an event will be triggered indicating that the draft is ready for editing.

{\n  \"type\": \"ai.draft.ready\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\", \n  \"title\": \"AI Draft Title\",\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\"   \n}\n\n

AI Draft Failed Webhook

Although rare, AI draft generation may occasionally fail. In such cases, an 'AI Draft Failed' event will be triggered. We recommend implementing appropriate error handling to manage these infrequent occurrences and ensure a seamless user experience.

{\n  \"type\": \"draft.failed\",\n  \"wochitVideoId\": \"6094092472a9105747957aa3\",\n  \"videoContext\": \"VideoContext that was sent to the video editor\"\n  \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\",  \n  \"title\": \"Updated draft title\"\n}\n\n

Attributes:

type string
The type of the event.

wochitVideoId string
Wochit unique identifier for this video. You can use it to re-edit the video.

title string
The title of the video. The title is given by the end-user.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"36497199-85bb-422d-a425-24f3e7d6a228","id":"36497199-85bb-422d-a425-24f3e7d6a228","name":"Listen To a Webhook","type":"folder"}},"urlObject":{"protocol":"https","path":["your-webhook"],"host":["your-webhook-endpoint","com"],"query":[],"variable":[]}},"response":[{"id":"4361440f-7e4b-4b9e-9bd4-8eebd73ca4ff","name":"AI Draft New","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"eventType\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"...\", \n \"videoUrl\": \"...\", \n \"title\": \"...\",\n \"videoDuration\" : 0.0\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"type\": \"ai.draft.new\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"videoContext\": \"VideoContext that was sent to the video editor\", \n \"title\": \"Temporary AI Draft Title\"\n}"},{"id":"da96f55f-8aaf-488d-aad3-a096aca20366","name":"AI Draft Ready","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"eventType\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"...\", \n \"videoUrl\": \"...\", \n \"title\": \"...\",\n \"videoDuration\" : 0.0\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"type\": \"ai.draft.ready\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"videoContext\": \"VideoContext that was sent to the video editor\", \n \"title\": \"AI Draft Title\",\n \"thumbnailUrl\": \"http://example.com/direct-link-to-thumbnail\" \n}"},{"id":"f7b196dc-c7b5-40c6-afbe-468f0c393b11","name":"AI Draft Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\" : \"eventType\",\n \"videoContext\": \"string-sent-when-opened-the-video-editor\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"thumbnailUrl\": \"...\", \n \"videoUrl\": \"...\", \n \"title\": \"...\",\n \"videoDuration\" : 0.0\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/your-webhook"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"type\": \"ai.draft.failed\",\n \"wochitVideoId\": \"6094092472a9105747957aa3\",\n \"videoContext\": \"VideoContext that was sent to the video editor\"\n}"}],"_postman_id":"8e0cfdb0-ef71-4b68-895f-afcbf608c4b3"}],"id":"36497199-85bb-422d-a425-24f3e7d6a228","description":"

Webhooks

Webhooks allow your application to receive real-time updates about the status of videos and drafts, enabling you to take appropriate actions in your system as soon as events occur in the Wochit platform.

Define Your Webhook

You can update your Webhook URL by submitting the Integration Setup form.

Important!

If you allow your users to save drafts, ensure that no more than one user works on the draft simultaneously, as auto-save can override the other user's changes.
\n
The draft.update webhook is triggered on every autosave of the draft, but we do not send it by default. If you wish to subscribe to this event, please Contact us.
\n
The videoContext in the draft.update and draft.exit webhook is identical to the videoContext you used when first initiating the draft edit. It's strongly advised that you maintain a mapping between the wochit Video Id and the videoContext for future reference.
\n

IP whitelisting

You might need to whitelist Wochit IPs to allow receiving our Webhook calls:

54.81.68.237
\n
54.147.58.230
\n
52.1.193.159
\n
18.204.107.61
\n
100.25.120.71
\n

Need any technical assistance? Contact us!

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8c62d456-68ba-4cd4-ade6-1203df6d736c","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"ac12196f-664d-436f-b9ea-80410c24be5e","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"36497199-85bb-422d-a425-24f3e7d6a228"},{"name":"API Reference","item":[{"name":"Drafts & Videos","item":[{"name":"Clone Draft","id":"89b8cdaf-0812-48d0-9b50-c06c18a1d54b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{user_token}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.wochit.com/v1/users/drafts/{{draft_id}}/clone","description":"

Clone a video draft.
The API responses include the following attributes:

wochitVideoId (String)
Wochit unique identifier for this video. You can use it to re-edit the video.

title (String)
The title of the video. The title is given by the end-user.

thumbnail (String)
Direct link to the thumbnail of the video. Links have an expiration time of 24 hours so make sure you download the video to your system and use your own storage / CDN.

If you encounter any errors, please provide the `requestId` in the response for further assistance.

Delete an existing video draft.

For successful deletion, the response will be a `204 No Content` status code.

If you encounter any errors, please provide the `requestId` in the response for further assistance.

Clone a produced video.
The API responses include the following attributes:

wochitVideoId (String)
Wochit unique identifier for this video. You can use it to re-edit the video.

title (String)
The title of the video. The title is given by the end-user.

thumbnail (String)
Direct link to the thumbnail of the video. Links have an expiration time of 24 hours so make sure you download the video to your system and use your own storage / CDN.

If you encounter any errors, please provide the `requestId` in the response for further assistance.

Delete an existing video.

If you encounter any errors, please provide the `requestId` in the response for further assistance.

Drafts & Videos

This section covers API endpoints for managing drafts and videos.

Please note that to access these APIs, you need your Client ID and a generated User Token.
You can find the Client ID in your Developer Tools.
The user token is a unique key that should be generated each time a user accesses the Wochit Video Editor.

A draft\\produced video can be deleted or cloned only by the user who created it.
This is a default setup to help you secure your user's actions.

If you need to remove this limitation please contact us.
If you encounter any errors, please provide the `requestId` for further assistance.

\n","_postman_id":"cb97f266-ad94-4ed1-82b0-a1b6513dc125","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}}},{"name":"Template Categories","id":"b889c8a5-0c8e-4ad0-85de-356d37e4f226","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"secret-key","value":"{{secret_key}}"},{"key":"client-id","value":"{{client_id}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.wochit.com/v1/accounts/templates/categories","description":"

Template Categories

Each template in the template gallery belongs to one or more categories. You can choose the entire set of templates you'd like to include in your Video Editor in the admin panel under Templates -> Wochit Template Packages.
Have your own set of templates and categories in the admin panel under Templates -> My Templates -> Create.

Use the template IDs to filter templates when you open the video creator.
To extract the IDs of your template categories using the API, use this request.

Please refer to the Developer Tools to obtain your Client ID and Secret Key.

Response

The response will be structured in a JSON format and will include the registered and owned categories:

{\n  \"registered\": [\n    {\n      \"id\": \"62543d82f22d3777bc28986c\",\n      \"name\": \"Education\"\n    }\n  ],\n  \"owned\": [\n    {\n      \"id\": \"647f33677387131d481f2d30\",\n      \"name\": \"My Category\"\n    }\n  ]\n}\n\n

Response Properties:

registered object[]
List of categories selected in the Wochit Admin.

owned object[]
Your custom categories created using the Wochit Studio application.

id string
A Unique identifier of each category. Use the categoryIds property to filter the template gallery.
\n
name string
The Name of the category. Use the categoryNames property to filter the template gallery.
\n

If you encounter any errors, please provide the `requestId` in the response for further assistance.

API Reference

Enhance your integration by utilizing API calls to efficiently manage drafts and videos, while also enabling the extraction of template category IDs.

\n","_postman_id":"531aada4-3a4d-4432-b53d-a090692a352d","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}}},{"name":"asset server","item":[{"name":" fetch","id":"a474faec-cfcf-4ae1-a821-37c6eda2a51f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/webapi/fetch/asset?uuid=cb505c4e_c5c2_4fcf_a9c3_1dfc8c7bf986_asset_server","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}},"urlObject":{"port":"8080","path":["webapi","fetch","asset"],"host":["localhost"],"query":[{"key":"uuid","value":"cb505c4e_c5c2_4fcf_a9c3_1dfc8c7bf986_asset_server"}],"variable":[]}},"response":[],"_postman_id":"a474faec-cfcf-4ae1-a821-37c6eda2a51f"}],"id":"2a6b2058-5a66-408a-8d29-e4fe4f1d2b4f","_postman_id":"2a6b2058-5a66-408a-8d29-e4fe4f1d2b4f","description":"","auth":{"type":"bearer","bearer":{"token":"{{user_token}}"},"isInherited":true,"source":{"_postman_id":"c098e231-2f37-4629-b2d6-a3e9de968a42","id":"c098e231-2f37-4629-b2d6-a3e9de968a42","name":"Wochit API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":"{{user_token}}"}},"event":[{"listen":"prerequest","script":{"id":"2f3c39fb-2ada-4e05-b028-a631a90b5bc4","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"13c246f8-d292-43d1-9a77-a4e6e9a86d19","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"{{client_id}}\n","value":"client_id","type":"string"},{"key":"{{secret_key}}","value":"secret_key","type":"string"}]}