Module: SongtradrApiClientRuby

Defined in:
lib/songtradr_api_client_ruby/version.rb,
lib/songtradr_api_client_ruby.rb,
lib/songtradr_api_client_ruby/api_error.rb,
lib/songtradr_api_client_ruby/api_client.rb,
lib/songtradr_api_client_ruby/api/user_api.rb,
lib/songtradr_api_client_ruby/configuration.rb,
lib/songtradr_api_client_ruby/models/tag_dto.rb,
lib/songtradr_api_client_ruby/models/file_dto.rb,
lib/songtradr_api_client_ruby/models/user_dto.rb,
lib/songtradr_api_client_ruby/models/genre_dto.rb,
lib/songtradr_api_client_ruby/models/login_dto.rb,
lib/songtradr_api_client_ruby/models/title_dto.rb,
lib/songtradr_api_client_ruby/models/track_dto.rb,
lib/songtradr_api_client_ruby/api/recording_api.rb,
lib/songtradr_api_client_ruby/models/sign_up_dto.rb,
lib/songtradr_api_client_ruby/models/taggram_dto.rb,
lib/songtradr_api_client_ruby/models/file_list_dto.rb,
lib/songtradr_api_client_ruby/models/jwt_token_dto.rb,
lib/songtradr_api_client_ruby/models/save_user_dto.rb,
lib/songtradr_api_client_ruby/models/tag_small_dto.rb,
lib/songtradr_api_client_ruby/models/token_request.rb,
lib/songtradr_api_client_ruby/models/error_response.rb,
lib/songtradr_api_client_ruby/models/file_small_dto.rb,
lib/songtradr_api_client_ruby/api/allowed_values_api.rb,
lib/songtradr_api_client_ruby/models/file_upload_dto.rb,
lib/songtradr_api_client_ruby/models/party_small_dto.rb,
lib/songtradr_api_client_ruby/models/tagstrength_dto.rb,
lib/songtradr_api_client_ruby/models/tags_summary_dto.rb,
lib/songtradr_api_client_ruby/models/config_access_dto.rb,
lib/songtradr_api_client_ruby/models/field_summary_dto.rb,
lib/songtradr_api_client_ruby/models/files_summary_dto.rb,
lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb,
lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb,
lib/songtradr_api_client_ruby/models/genres_summary_dto.rb,
lib/songtradr_api_client_ruby/models/recording_list_dto.rb,
lib/songtradr_api_client_ruby/models/category_medium_dto.rb,
lib/songtradr_api_client_ruby/models/forgot_password_dto.rb,
lib/songtradr_api_client_ruby/models/recording_party_dto.rb,
lib/songtradr_api_client_ruby/models/recording_small_dto.rb,
lib/songtradr_api_client_ruby/models/update_password_dto.rb,
lib/songtradr_api_client_ruby/models/category_minimal_dto.rb,
lib/songtradr_api_client_ruby/models/contributor_type_dto.rb,
lib/songtradr_api_client_ruby/models/musical_features_dto.rb,
lib/songtradr_api_client_ruby/models/recording_medium_dto.rb,
lib/songtradr_api_client_ruby/models/config_identifier_dto.rb,
lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb,
lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb,
lib/songtradr_api_client_ruby/models/image_recognition_response.rb,
lib/songtradr_api_client_ruby/models/video_recognition_response.rb,
lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb,
lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb,
lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb,
lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb,
lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb,
lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb

Overview

#Songtradr API

#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. Authentication 1. Reach out to [email protected] to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via [email protected] if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/name/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/name/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world’s released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.

The version of the OpenAPI document: 2.1.0 Contact: [email protected] Generated by: openapi-generator.tech Generator version: 7.5.0-SNAPSHOT

Defined Under Namespace

Classes: AllowedValuesApi, ApiClient, ApiError, CategoryMediumDTO, CategoryMinimalDTO, ConfigAccessDTO, ConfigIdentifierDTO, Configuration, ContributorTypeDTO, ErrorResponse, FieldSummaryDTO, FileDTO, FileListDTO, FileSmallDTO, FileUploadDTO, FileWIthUrlDTO, FilesSummaryDTO, ForgotPasswordDTO, GenreDTO, GenreMinimalDTO, GenresSummaryDTO, ImageRecognitionResponse, InitPutRecordingAudioDTO, JwtTokenDTO, LoginDTO, MusicalFeaturesDTO, PartySmallDTO, RecordingApi, RecordingForSimilaritySearchDTO, RecordingGenrePredictionDTO, RecordingListDTO, RecordingMediumDTO, RecordingMinimalWithMusicalFeaturesDTO, RecordingMinimalWithTaggramsDTO, RecordingMinimalWithTagstrengthsDTO, RecordingPartyDTO, RecordingSmallDTO, RecordingTagSmallDTO, SaveUserDTO, SearchFilterValuesDTO, SignUpDTO, TagDTO, TagSmallDTO, TaggramDTO, TagsSummaryDTO, TagstrengthDTO, TitleDTO, TokenRequest, TrackDTO, UpdatePasswordDTO, UserApi, UserDTO, VideoRecognitionResponse

Constant Summary collapse

VERSION = 
'2.1.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

SongtradrApiClientRuby.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



81
82
83
84
85
86
87
 
# File 'lib/songtradr_api_client_ruby.rb', line 81

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end