Project

Project (Tolstoy) operations

Create

POST https://api.gotolstoy.com/projects/

This endpoint allows you to create new Tolstoy

Path Parameters

NameTypeDescription

project

object

Project details - { "project": { "name": "my new project" } }

Headers

NameTypeDescription

Authorization

string

Authorization token - Bearer Token

{ "id": "1242d2ad-8179-47d2-b6a1-ce0ee8cdc359", "tolstoy": "https://player.gotolstoy.com/wc9gat7q75fu8?sneakpeek" }

Create Step

POST https://api.gotolstoy.com/projects/steps

This endpoint allows you to create new Tolstoy's part

Path Parameters

NameTypeDescription

step

object

Part details - { "step": { "projectId": "f4828e6b-849f-4794-b3ec-c365f331506a", "description": "description", "answers": [{ "next": "rqAvg", "text": "hey how are you?" }, { "next": "rqAvg", "text": "what is your age?" }], "videoId": "e899d07e-da6d-41f1-ba2f-e546e97c3a7e", "overlayText": "This is the overlay text" } }

Headers

NameTypeDescription

Authorization

string

Authorization token - Bearer Token

{"id":"7ea4e34c-8185-4f9f-a835-d1d3b05c54e6","name":"pHB58"}

Get Project

GET https://api.gotolstoy.com/projects/:id

Path Parameters

NameTypeDescription

Id

string

Project id

Headers

NameTypeDescription

Authorization

string

Authorization token - Bearer Token

{ "project" : { ... } }

Delete Project

DELETE https://api.gotolstoy.com/projects/

Headers

NameTypeDescription

Authorization

string

Authorization Token - Bearer Token

Request Body

NameTypeDescription

projectId

string

The project to be deleted

List Projects

GET https://api.gotolstoy.com/projects/

Headers

NameTypeDescription

Authorization

string

Authorization Token - Bearer Token

{ "projects": [...] }

Update Project

PUT https://api.gotolstoy.com/projects/{id}

Path Parameters

NameTypeDescription

Authorization

string

Authorization Token - Bearer Token

Request Body

NameTypeDescription

name

string

emailNotifications

array

stepsOrder

array

Update Step

PUT https://api.gotolstoy.com/projects/steps/{id}

Headers

NameTypeDescription

Authorization

string

Authorization Token - Bearer Token

Request Body

NameTypeDescription

description

string

answers

array

videoId

string

overlayText

string

answerTime

number

Delete Step

DELETE https://api.gotolstoy.com/projects/steps

Headers

NameTypeDescription

Authorization

string

Authorization Token - Bearer Token

Request Body

NameTypeDescription

stepId

string

The step to be deleted

Last updated