API - UCSD-E4E/Pyrenote GitHub Wiki

API Documentation

TODO: Add required data to this

Send_audio_file

  • route: /api/audios/path:file_name"
  • Method: none
  • returns a file from the backend
  • Error returns: 404, file not found

fetch_current_user_projects

  • route: /api/current_user/projects"
  • Method: get
  • returns a list of directories, each directory stuctured as {project_id, name, created_by, created_on}

fetch_data_for_project

  • route: /api/current_user/projects/int:project_id/data"
  • Method: get
  • returns a directory containing 4 lists of data, each list containing a TODO: Finsh this

get_next_data

  • route: /api/current_user/projects/int:project_id/data/int:data_value"
  • Method: get
  • returns: list of 10 audio files that user could select next from + next/previous page data

get_next_data2

  • route: /api/current_user/projects/int:project_id/data/int:dv/page/int:page_data"
  • Method: get
  • returns: list of 10 audio files that user could select next from + next/previous page data

get_next_data_unknown

  • route: /api/current_user/unknown/projects/int:project_id/data/int:data_value"
  • Method: get
  • returns: list of 10 audio files that user could select next from + next/previous page data

get_all

  • route: /api/current_user/projects/get_all"
  • Method: get
  • returns: all data that isn't a refrence

fetch_sample_for_project

  • route: /api/current_user/projects/int:project_id/sample
  • Method: get
  • returns: all the samples and thier labels for refrences
⚠️ **GitHub.com Fallback** ⚠️