Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.49 KB

README.md

File metadata and controls

62 lines (42 loc) · 1.49 KB
Raw

frankenstein

Using the API

To use the API, first call the start-show endpoint. This should return a show_id that you will use for the rest of the session.

To send texts to the api, send a post to interact. Example in curl

curl --header "Content-Type: application/json" \
  --request POST \
  --data '{"string":"bankds happy happy bands", "show_id": 1}' \
  http://frankenstein.hunterowens.net/interact

To get the most recent text plus Sentiment scores.

curl http://frankenstein.hunterowens.net/interact?show_id=$YOUR_SHOW_ID

To get the talk functions from the api.

curl http://frankenstein.hunterowens.net/talk?show_id=$YOUR_SHOW_ID

To get the summary themes

curl http://frankenstein.hunterowens.net/summary?show_id$YOUR_SHOW_ID

Alternatively, you can provide multiple show_ids to summary, as a comma seperate list as such: `/summary?show_ids=1,2

To list all shows and show IDs

curl http://frankenstein.hunterowens.net/list-shows

To update a show

 curl --header "Content-Type: application/json" \
  --request POST \
  --data '{"show_status":"in_progress", "show_id": 1}' \
  http://frankenstein.hunterowens.net/update-show

show_status can be one of preshow, in_progress,complete.

To save a log

curl --header "Content-Type: application/json" \
  --request POST \
    --data '{"actor": "hunter", "show_id": 2, "text": "some text", "action": "intro"}' \
      http://localhost:5000/log