Create a new story from json input
| X-API-KEY | string |
| templateSetId required | string Selected template id |
| workspaceId required | string Selected workspace id The user must be part of this workspace |
| title required | string Story title |
| description | string Story SEO description |
| authorSEO | string Story SEO author |
object Story poster images | |
| text required | string Story content text which will be parsed accros the slides |
required | Array of objects (CreateMediaDto) Array containing the media files |
| isTeamStory | boolean Default: false Should the story be shared with the team Defaults to true |
object Content of the CTA layer if such is present in the template | |
| userId | string Selected user id The user must be part of this workspace |
{- "templateSetId": "96308205-25da-458b-b1c1-e5e780e46782",
- "workspaceId": "68bef983-1afc-4559-b884-e66f8ea5c0b0",
- "title": "Story title",
- "description": "Funny story with cats",
- "authorSEO": "Gaetan Poggi",
- "posterImages": {
}, - "text": "Text",
- "media": "[{type: image, url: https://hatrabbits.com/wp-content/uploads/2017/01/random.jpg}, {type: image, url: https://hatrabbits.com/wp-content/uploads/2017/01/random.jpg}]",
- "isTeamStory": false,
- "userId": "68bef983-1afc-4559-b884-e66f8ea5c0b0"
}
{- "success": true
}Create a new article from json input
| X-API-KEY | string |
required | Array of objects (CreateArticleDto) |
{- "articles": [
- {
- "title": "string",
- "text": "string",
- "media": [
- {
- "type": "video",
- "url": "string",
- "videoThumbnail": "string",
- "authorCredits": "string"
}
], - "description": "string",
- "posterImages": {
}, - "authorSEO": "string"
}
]
}{- "success": true
}Fetch templates
| workspaceId required | string |
[- {
- "_id": "string",
- "description": "string",
- "workspaceId": "string",
- "title": "string",
- "teamId": "string",
- "author": "string",
- "authorSEO": {
- "type": "string",
- "name": "string"
}, - "initialWidth": { },
- "initialHeight": { },
- "cuts": [
- {
- "_id": "string",
- "index": 0,
- "position": 0,
- "video": "string",
- "ampVideo": {
- "url": "string",
- "duration": 0,
- "mute": true
}, - "ampVideoCreatedAt": "string",
- "thumbnail": "string",
- "picture": "string",
- "layers": [
- {
- "_id": "string",
- "position": 0,
- "type": "html",
- "title": "string",
- "content": {
- "html": "string",
- "shape": "string",
- "link": "string",
- "image": {
- "url": "string",
- "name": "string",
- "id": "string"
}, - "video": {
- "url": "string",
- "name": "string",
- "id": "string"
}, - "compressed": true,
- "value": "string"
}, - "settings": {
- "animateIn": "string",
- "animateInDuration": 0,
- "animateInDelay": 0,
- "animateOut": "string",
- "animateOutDuration": 0,
- "animateOutDelay": 0,
- "cropSettings": {
- "frame": {
- "translate": [
- null
], - "clipStyle": "string"
}, - "originalWidth": 0,
- "originalHeight": 0
}, - "generalSettings": {
- "innerOffsetY": "string",
- "innerOffsetX": "string",
- "offsetY": { },
- "offsetX": { },
- "margin": "string",
- "opacity": "string",
- "round": "string",
- "position": "string",
- "rotate": "string",
- "shadow": "string",
- "locked": true
}, - "layerSettings": {
- "mute": true,
- "isUnsplash": true,
- "width": 0,
- "height": 0,
- "originalWidth": 0,
- "originalHeight": 0,
- "fullscreen": true,
- "permissionForFullScreen": true,
- "fullScreenConfig": {
- "width": "string",
- "height": "string",
- "top": "string",
- "left": "string"
}, - "shapeStyles": {
- "borderColor": {
- "colorType": null,
- "type": null,
- "leftColor": null,
- "leftColorPercent": null,
- "rightColor": null,
- "rightColorPercent": null,
- "angle": null,
- "horizontalDirection": null,
- "verticalDirection": null
}, - "fillColor": {
- "colorType": null,
- "type": null,
- "leftColor": null,
- "leftColorPercent": null,
- "rightColor": null,
- "rightColorPercent": null,
- "angle": null,
- "horizontalDirection": null,
- "verticalDirection": null
}, - "thickness": 0,
- "round": "string"
}, - "locked": true,
- "isAuthorCreditsLayer": true,
- "isLayerHidden": true
}, - "ctaLayerSettings": {
- "linkTitle": "string",
- "link": "string",
- "fontColor": "string",
- "withQueries": true
}, - "linkSettings": { }
}, - "childLayers": [
- { }
], - "isTitleDirty": true
}
], - "type": "string",
- "duration": 0,
- "backgroundColor": {
- "colorType": "string",
- "type": "string",
- "leftColor": "string",
- "leftColorPercent": 0,
- "rightColor": "string",
- "rightColorPercent": 0,
- "angle": 0,
- "horizontalDirection": 0,
- "verticalDirection": 0
}
}
], - "posterPortrait3x4Url": "string",
- "posterPortrait1x1Url": "string",
- "posterLandscapeUrl": "string",
- "zoomRatio": 0,
- "googleFonts": [
- {
- "_id": "string",
- "family": "string",
- "fontType": "string",
- "weight": [
- 0
], - "variants": [
- "string"
], - "style": "string",
- "paths": { },
- "file": "string"
}
], - "fonts": [
- {
- "_id": "string",
- "family": "string",
- "fontType": "string",
- "weight": [
- 0
], - "variants": [
- "string"
], - "style": "string",
- "paths": { },
- "file": "string"
}
]
}
]