Searchly API

Similartiy

searchSimilarityByContent

Endpoint for an end-user client to search similarity by content.


/similarity/by_content

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/searchly/similarity/by_content"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimilartiyApi;

import java.io.File;
import java.util.*;

public class SimilartiyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        SimilartiyApi apiInstance = new SimilartiyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String contentType = contentType_example; // String | application/json
        String accept = accept_example; // String | application/json
          = ; //  | Body wrapper for the request.
        try {
            inline_response_200 result = apiInstance.searchSimilarityByContent(apiecoKey, contentType, accept, );
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimilartiyApi#searchSimilarityByContent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimilartiyApi;

public class SimilartiyApiExample {

    public static void main(String[] args) {
        SimilartiyApi apiInstance = new SimilartiyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String contentType = contentType_example; // String | application/json
        String accept = accept_example; // String | application/json
          = ; //  | Body wrapper for the request.
        try {
            inline_response_200 result = apiInstance.searchSimilarityByContent(apiecoKey, contentType, accept, );
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimilartiyApi#searchSimilarityByContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *contentType = contentType_example; // application/json
String *accept = accept_example; // application/json
 * = ; // Body wrapper for the request.

SimilartiyApi *apiInstance = [[SimilartiyApi alloc] init];

[apiInstance searchSimilarityByContentWith:apiecoKey
    contentType:contentType
    accept:accept
    :
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var SearchlyApi = require('searchly_api');
var defaultClient = SearchlyApi.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new SearchlyApi.SimilartiyApi()

var apiecoKey = apiecoKey_example; // {String} 

var contentType = contentType_example; // {String} application/json

var accept = accept_example; // {String} application/json

var  = ; // {} Body wrapper for the request.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchSimilarityByContent(apiecoKey, contentType, accept, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchSimilarityByContentExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new SimilartiyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var contentType = contentType_example;  // String | application/json
            var accept = accept_example;  // String | application/json
            var  = new (); //  | Body wrapper for the request.

            try
            {
                inline_response_200 result = apiInstance.searchSimilarityByContent(apiecoKey, contentType, accept, );
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimilartiyApi.searchSimilarityByContent: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SimilartiyApi();
$apiecoKey = apiecoKey_example; // String | 
$contentType = contentType_example; // String | application/json
$accept = accept_example; // String | application/json
$ = ; //  | Body wrapper for the request.

try {
    $result = $api_instance->searchSimilarityByContent($apiecoKey, $contentType, $accept, $);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimilartiyApi->searchSimilarityByContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimilartiyApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SimilartiyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $contentType = contentType_example; # String | application/json
my $accept = accept_example; # String | application/json
my $ = WWW::SwaggerClient::Object::->new(); #  | Body wrapper for the request.

eval { 
    my $result = $api_instance->searchSimilarityByContent(apiecoKey => $apiecoKey, contentType => $contentType, accept => $accept,  => $);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimilartiyApi->searchSimilarityByContent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SimilartiyApi()
apiecoKey = apiecoKey_example # String | 
contentType = contentType_example # String | application/json
accept = accept_example # String | application/json
 =  #  | Body wrapper for the request.

try: 
    api_response = api_instance.search_similarity_by_content(apiecoKey, contentType, accept, )
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimilartiyApi->searchSimilarityByContent: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
content-type*
String
application/json
Required
accept*
String
application/json
Required
Body parameters
Name Description
*

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 403 - Invalid input

searchSimilarityBySong

Endpoint for an end-user client to search similarity by song identifiers


/similarity/by_song

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/searchly/similarity/by_song?song_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimilartiyApi;

import java.io.File;
import java.util.*;

public class SimilartiyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        SimilartiyApi apiInstance = new SimilartiyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String contentType = contentType_example; // String | application/json
        String accept = accept_example; // String | application/json
        BigDecimal songId = 8.14; // BigDecimal | Song identifier.
        try {
            inline_response_200 result = apiInstance.searchSimilarityBySong(apiecoKey, contentType, accept, songId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimilartiyApi#searchSimilarityBySong");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimilartiyApi;

public class SimilartiyApiExample {

    public static void main(String[] args) {
        SimilartiyApi apiInstance = new SimilartiyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String contentType = contentType_example; // String | application/json
        String accept = accept_example; // String | application/json
        BigDecimal songId = 8.14; // BigDecimal | Song identifier.
        try {
            inline_response_200 result = apiInstance.searchSimilarityBySong(apiecoKey, contentType, accept, songId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimilartiyApi#searchSimilarityBySong");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *contentType = contentType_example; // application/json
String *accept = accept_example; // application/json
BigDecimal *songId = 8.14; // Song identifier.

SimilartiyApi *apiInstance = [[SimilartiyApi alloc] init];

[apiInstance searchSimilarityBySongWith:apiecoKey
    contentType:contentType
    accept:accept
    songId:songId
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var SearchlyApi = require('searchly_api');
var defaultClient = SearchlyApi.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new SearchlyApi.SimilartiyApi()

var apiecoKey = apiecoKey_example; // {String} 

var contentType = contentType_example; // {String} application/json

var accept = accept_example; // {String} application/json

var songId = 8.14; // {BigDecimal} Song identifier.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchSimilarityBySong(apiecoKey, contentType, accept, songId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchSimilarityBySongExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new SimilartiyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var contentType = contentType_example;  // String | application/json
            var accept = accept_example;  // String | application/json
            var songId = 8.14;  // BigDecimal | Song identifier.

            try
            {
                inline_response_200 result = apiInstance.searchSimilarityBySong(apiecoKey, contentType, accept, songId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimilartiyApi.searchSimilarityBySong: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SimilartiyApi();
$apiecoKey = apiecoKey_example; // String | 
$contentType = contentType_example; // String | application/json
$accept = accept_example; // String | application/json
$songId = 8.14; // BigDecimal | Song identifier.

try {
    $result = $api_instance->searchSimilarityBySong($apiecoKey, $contentType, $accept, $songId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimilartiyApi->searchSimilarityBySong: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimilartiyApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SimilartiyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $contentType = contentType_example; # String | application/json
my $accept = accept_example; # String | application/json
my $songId = 8.14; # BigDecimal | Song identifier.

eval { 
    my $result = $api_instance->searchSimilarityBySong(apiecoKey => $apiecoKey, contentType => $contentType, accept => $accept, songId => $songId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimilartiyApi->searchSimilarityBySong: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SimilartiyApi()
apiecoKey = apiecoKey_example # String | 
contentType = contentType_example # String | application/json
accept = accept_example # String | application/json
songId = 8.14 # BigDecimal | Song identifier.

try: 
    api_response = api_instance.search_similarity_by_song(apiecoKey, contentType, accept, songId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimilartiyApi->searchSimilarityBySong: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
content-type*
String
application/json
Required
accept*
String
application/json
Required
Query parameters
Name Description
song_id*
BigDecimal
Song identifier.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 403 - Invalid input

Song

searchSong

Endpoint for an end-user client to search songs from the database given a String query.


/song/search

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/searchly/song/search?query="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SongApi;

import java.io.File;
import java.util.*;

public class SongApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        SongApi apiInstance = new SongApi();
        String apiecoKey = apiecoKey_example; // String | 
        String contentType = contentType_example; // String | application/json
        String accept = accept_example; // String | application/json
        String query = query_example; // String | query
        try {
            inline_response_200_1 result = apiInstance.searchSong(apiecoKey, contentType, accept, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SongApi#searchSong");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SongApi;

public class SongApiExample {

    public static void main(String[] args) {
        SongApi apiInstance = new SongApi();
        String apiecoKey = apiecoKey_example; // String | 
        String contentType = contentType_example; // String | application/json
        String accept = accept_example; // String | application/json
        String query = query_example; // String | query
        try {
            inline_response_200_1 result = apiInstance.searchSong(apiecoKey, contentType, accept, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SongApi#searchSong");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *contentType = contentType_example; // application/json
String *accept = accept_example; // application/json
String *query = query_example; // query

SongApi *apiInstance = [[SongApi alloc] init];

[apiInstance searchSongWith:apiecoKey
    contentType:contentType
    accept:accept
    query:query
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var SearchlyApi = require('searchly_api');
var defaultClient = SearchlyApi.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new SearchlyApi.SongApi()

var apiecoKey = apiecoKey_example; // {String} 

var contentType = contentType_example; // {String} application/json

var accept = accept_example; // {String} application/json

var query = query_example; // {String} query


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchSong(apiecoKey, contentType, accept, query, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchSongExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new SongApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var contentType = contentType_example;  // String | application/json
            var accept = accept_example;  // String | application/json
            var query = query_example;  // String | query

            try
            {
                inline_response_200_1 result = apiInstance.searchSong(apiecoKey, contentType, accept, query);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SongApi.searchSong: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SongApi();
$apiecoKey = apiecoKey_example; // String | 
$contentType = contentType_example; // String | application/json
$accept = accept_example; // String | application/json
$query = query_example; // String | query

try {
    $result = $api_instance->searchSong($apiecoKey, $contentType, $accept, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SongApi->searchSong: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SongApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SongApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $contentType = contentType_example; # String | application/json
my $accept = accept_example; # String | application/json
my $query = query_example; # String | query

eval { 
    my $result = $api_instance->searchSong(apiecoKey => $apiecoKey, contentType => $contentType, accept => $accept, query => $query);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SongApi->searchSong: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SongApi()
apiecoKey = apiecoKey_example # String | 
contentType = contentType_example # String | application/json
accept = accept_example # String | application/json
query = query_example # String | query

try: 
    api_response = api_instance.search_song(apiecoKey, contentType, accept, query)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SongApi->searchSong: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
content-type*
String
application/json
Required
accept*
String
application/json
Required
Query parameters
Name Description
query*
String
query
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 403 - Invalid input