MonkeyLearn API Documentation

ClassifierDetail

classifierDetail

Returns information about a classifier including its settings, stats, and tags.


/v3/classifiers/{MODEL_ID}

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClassifierDetailApi;

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

public class ClassifierDetailApiExample {

    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");

        ClassifierDetailApi apiInstance = new ClassifierDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            inline_response_200_1 result = apiInstance.classifierDetail(apiecoKey, mODELID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClassifierDetailApi#classifierDetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClassifierDetailApi;

public class ClassifierDetailApiExample {

    public static void main(String[] args) {
        ClassifierDetailApi apiInstance = new ClassifierDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            inline_response_200_1 result = apiInstance.classifierDetail(apiecoKey, mODELID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClassifierDetailApi#classifierDetail");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance classifierDetailWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ClassifierDetailApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.classifierDetail(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class classifierDetailExample
    {
        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 ClassifierDetailApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                inline_response_200_1 result = apiInstance.classifierDetail(apiecoKey, mODELID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClassifierDetailApi.classifierDetail: " + 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\ClassifierDetailApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

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

# 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::ClassifierDetailApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    my $result = $api_instance->classifierDetail(apiecoKey => $apiecoKey, mODELID => $mODELID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClassifierDetailApi->classifierDetail: $@\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.ClassifierDetailApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_response = api_instance.classifier_detail(apiecoKey, mODELID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClassifierDetailApi->classifierDetail: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


Classify

classify

Classifies texts with a given classifier.


/v3/classifiers/{MODEL_ID}/classify/

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}/classify/?production_model="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClassifyApi;

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

public class ClassifyApiExample {

    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");

        ClassifyApi apiInstance = new ClassifyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String productionModel = productionModel_example; // String | Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
        Data data = ; // Data | Second text to be compared with the first text
        try {
            inline_response_200 result = apiInstance.classify(apiecoKey, mODELID, productionModel, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClassifyApi#classify");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClassifyApi;

public class ClassifyApiExample {

    public static void main(String[] args) {
        ClassifyApi apiInstance = new ClassifyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String productionModel = productionModel_example; // String | Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
        Data data = ; // Data | Second text to be compared with the first text
        try {
            inline_response_200 result = apiInstance.classify(apiecoKey, mODELID, productionModel, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClassifyApi#classify");
            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 *mODELID = mODELID_example; // 
String *productionModel = productionModel_example; // Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
Data *data = ; // Second text to be compared with the first text

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

// 
[apiInstance classifyWith:apiecoKey
    mODELID:mODELID
    productionModel:productionModel
    data:data
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ClassifyApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var productionModel = productionModel_example; // {String} Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.

var data = ; // {Data} Second text to be compared with the first text


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.classify(apiecoKey, mODELID, productionModel, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class classifyExample
    {
        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 ClassifyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var productionModel = productionModel_example;  // String | Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
            var data = new Data(); // Data | Second text to be compared with the first text

            try
            {
                // 
                inline_response_200 result = apiInstance.classify(apiecoKey, mODELID, productionModel, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClassifyApi.classify: " + 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\ClassifyApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$productionModel = productionModel_example; // String | Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
$data = ; // Data | Second text to be compared with the first text

try {
    $result = $api_instance->classify($apiecoKey, $mODELID, $productionModel, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClassifyApi->classify: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClassifyApi;

# 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::ClassifyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $productionModel = productionModel_example; # String | Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
my $data = WWW::SwaggerClient::Object::Data->new(); # Data | Second text to be compared with the first text

eval { 
    my $result = $api_instance->classify(apiecoKey => $apiecoKey, mODELID => $mODELID, productionModel => $productionModel, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClassifyApi->classify: $@\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.ClassifyApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
productionModel = productionModel_example # String | Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
data =  # Data | Second text to be compared with the first text

try: 
    # 
    api_response = api_instance.classify(apiecoKey, mODELID, productionModel, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClassifyApi->classify: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
data *
Query parameters
Name Description
production_model*
String
Indicates if the classifications are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings or by using the Classifier deploy API endpoint.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


CreateClassifier

createClassifier

Creates a new classifier.


/v3/classifiers

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateClassifierApi;

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

public class CreateClassifierApiExample {

    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");

        CreateClassifierApi apiInstance = new CreateClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        NewClassifier_1 newClassifier = ; // NewClassifier_1 | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            inline_response_200_4 result = apiInstance.createClassifier(apiecoKey, newClassifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClassifierApi#createClassifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateClassifierApi;

public class CreateClassifierApiExample {

    public static void main(String[] args) {
        CreateClassifierApi apiInstance = new CreateClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        NewClassifier_1 newClassifier = ; // NewClassifier_1 | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            inline_response_200_4 result = apiInstance.createClassifier(apiecoKey, newClassifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClassifierApi#createClassifier");
            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; // 
NewClassifier_1 *newClassifier = ; // Accepts parameters in the request body as a JSON with the following attributes:

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

// 
[apiInstance createClassifierWith:apiecoKey
    newClassifier:newClassifier
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.CreateClassifierApi()

var apiecoKey = apiecoKey_example; // {String} 

var newClassifier = ; // {NewClassifier_1} Accepts parameters in the request body as a JSON with the following attributes:


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createClassifier(apiecoKey, newClassifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createClassifierExample
    {
        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 CreateClassifierApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var newClassifier = new NewClassifier_1(); // NewClassifier_1 | Accepts parameters in the request body as a JSON with the following attributes:

            try
            {
                // 
                inline_response_200_4 result = apiInstance.createClassifier(apiecoKey, newClassifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateClassifierApi.createClassifier: " + 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\CreateClassifierApi();
$apiecoKey = apiecoKey_example; // String | 
$newClassifier = ; // NewClassifier_1 | Accepts parameters in the request body as a JSON with the following attributes:

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

# 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::CreateClassifierApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $newClassifier = WWW::SwaggerClient::Object::NewClassifier_1->new(); # NewClassifier_1 | Accepts parameters in the request body as a JSON with the following attributes:

eval { 
    my $result = $api_instance->createClassifier(apiecoKey => $apiecoKey, newClassifier => $newClassifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateClassifierApi->createClassifier: $@\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.CreateClassifierApi()
apiecoKey = apiecoKey_example # String | 
newClassifier =  # NewClassifier_1 | Accepts parameters in the request body as a JSON with the following attributes:

try: 
    # 
    api_response = api_instance.create_classifier(apiecoKey, newClassifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateClassifierApi->createClassifier: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
newClassifier *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


CreateCustomField

createCustomField

Creates a new custom field in a workflow.


/v3/workflows/[MODEL_ID]/custom-fields

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/[MODEL_ID]/custom-fields?name=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateCustomFieldApi;

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

public class CreateCustomFieldApiExample {

    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");

        CreateCustomFieldApi apiInstance = new CreateCustomFieldApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String name = name_example; // String | The name of the field. It must be unique on this workflow.
        String type = type_example; // String | The type of the data of the field. It must be one of string, date, text, integer, float, bool.
        try {
            inline_response_200_13 result = apiInstance.createCustomField(apiecoKey, mODELID, name, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateCustomFieldApi#createCustomField");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateCustomFieldApi;

public class CreateCustomFieldApiExample {

    public static void main(String[] args) {
        CreateCustomFieldApi apiInstance = new CreateCustomFieldApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String name = name_example; // String | The name of the field. It must be unique on this workflow.
        String type = type_example; // String | The type of the data of the field. It must be one of string, date, text, integer, float, bool.
        try {
            inline_response_200_13 result = apiInstance.createCustomField(apiecoKey, mODELID, name, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateCustomFieldApi#createCustomField");
            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 *mODELID = mODELID_example; // 
String *name = name_example; // The name of the field. It must be unique on this workflow.
String *type = type_example; // The type of the data of the field. It must be one of string, date, text, integer, float, bool.

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

// 
[apiInstance createCustomFieldWith:apiecoKey
    mODELID:mODELID
    name:name
    type:type
              completionHandler: ^(inline_response_200_13 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.CreateCustomFieldApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var name = name_example; // {String} The name of the field. It must be unique on this workflow.

var type = type_example; // {String} The type of the data of the field. It must be one of string, date, text, integer, float, bool.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCustomField(apiecoKey, mODELID, name, type, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCustomFieldExample
    {
        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 CreateCustomFieldApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var name = name_example;  // String | The name of the field. It must be unique on this workflow.
            var type = type_example;  // String | The type of the data of the field. It must be one of string, date, text, integer, float, bool.

            try
            {
                // 
                inline_response_200_13 result = apiInstance.createCustomField(apiecoKey, mODELID, name, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateCustomFieldApi.createCustomField: " + 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\CreateCustomFieldApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$name = name_example; // String | The name of the field. It must be unique on this workflow.
$type = type_example; // String | The type of the data of the field. It must be one of string, date, text, integer, float, bool.

try {
    $result = $api_instance->createCustomField($apiecoKey, $mODELID, $name, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateCustomFieldApi->createCustomField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateCustomFieldApi;

# 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::CreateCustomFieldApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $name = name_example; # String | The name of the field. It must be unique on this workflow.
my $type = type_example; # String | The type of the data of the field. It must be one of string, date, text, integer, float, bool.

eval { 
    my $result = $api_instance->createCustomField(apiecoKey => $apiecoKey, mODELID => $mODELID, name => $name, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateCustomFieldApi->createCustomField: $@\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.CreateCustomFieldApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
name = name_example # String | The name of the field. It must be unique on this workflow.
type = type_example # String | The type of the data of the field. It must be one of string, date, text, integer, float, bool.

try: 
    # 
    api_response = api_instance.create_custom_field(apiecoKey, mODELID, name, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateCustomFieldApi->createCustomField: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
name*
String
The name of the field. It must be unique on this workflow.
Required
type*
String
The type of the data of the field. It must be one of string, date, text, integer, float, bool.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


CreateStep

createStep

Creates a new step in a workflow.


/v3/workflows/{MODEL_ID}/steps

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}/steps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateStepApi;

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

public class CreateStepApiExample {

    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");

        CreateStepApi apiInstance = new CreateStepApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Data_4 data = ; // Data_4 | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            data_4 result = apiInstance.createStep(apiecoKey, mODELID, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateStepApi#createStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateStepApi;

public class CreateStepApiExample {

    public static void main(String[] args) {
        CreateStepApi apiInstance = new CreateStepApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Data_4 data = ; // Data_4 | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            data_4 result = apiInstance.createStep(apiecoKey, mODELID, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateStepApi#createStep");
            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 *mODELID = mODELID_example; // 
Data_4 *data = ; // Accepts parameters in the request body as a JSON with the following attributes:

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

// 
[apiInstance createStepWith:apiecoKey
    mODELID:mODELID
    data:data
              completionHandler: ^(data_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.CreateStepApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var data = ; // {Data_4} Accepts parameters in the request body as a JSON with the following attributes:


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStep(apiecoKey, mODELID, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createStepExample
    {
        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 CreateStepApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var data = new Data_4(); // Data_4 | Accepts parameters in the request body as a JSON with the following attributes:

            try
            {
                // 
                data_4 result = apiInstance.createStep(apiecoKey, mODELID, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateStepApi.createStep: " + 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\CreateStepApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$data = ; // Data_4 | Accepts parameters in the request body as a JSON with the following attributes:

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

# 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::CreateStepApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $data = WWW::SwaggerClient::Object::Data_4->new(); # Data_4 | Accepts parameters in the request body as a JSON with the following attributes:

eval { 
    my $result = $api_instance->createStep(apiecoKey => $apiecoKey, mODELID => $mODELID, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateStepApi->createStep: $@\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.CreateStepApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
data =  # Data_4 | Accepts parameters in the request body as a JSON with the following attributes:

try: 
    # 
    api_response = api_instance.create_step(apiecoKey, mODELID, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateStepApi->createStep: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


CreateTag

createTag

Creates a new tag in a classifier.


/v3/classifiers/{MODEL_ID}/tags

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateTagApi;

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

public class CreateTagApiExample {

    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");

        CreateTagApi apiInstance = new CreateTagApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        NewTag_1 newTag = ; // NewTag_1 | 
        try {
            NewTag_1 result = apiInstance.createTag(apiecoKey, mODELID, newTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateTagApi#createTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateTagApi;

public class CreateTagApiExample {

    public static void main(String[] args) {
        CreateTagApi apiInstance = new CreateTagApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        NewTag_1 newTag = ; // NewTag_1 | 
        try {
            NewTag_1 result = apiInstance.createTag(apiecoKey, mODELID, newTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateTagApi#createTag");
            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 *mODELID = mODELID_example; // 
NewTag_1 *newTag = ; // 

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

// 
[apiInstance createTagWith:apiecoKey
    mODELID:mODELID
    newTag:newTag
              completionHandler: ^(NewTag_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.CreateTagApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var newTag = ; // {NewTag_1} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTag(apiecoKey, mODELID, newTag, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTagExample
    {
        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 CreateTagApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var newTag = new NewTag_1(); // NewTag_1 | 

            try
            {
                // 
                NewTag_1 result = apiInstance.createTag(apiecoKey, mODELID, newTag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateTagApi.createTag: " + 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\CreateTagApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$newTag = ; // NewTag_1 | 

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

# 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::CreateTagApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $newTag = WWW::SwaggerClient::Object::NewTag_1->new(); # NewTag_1 | 

eval { 
    my $result = $api_instance->createTag(apiecoKey => $apiecoKey, mODELID => $mODELID, newTag => $newTag);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateTagApi->createTag: $@\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.CreateTagApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
newTag =  # NewTag_1 | 

try: 
    # 
    api_response = api_instance.create_tag(apiecoKey, mODELID, newTag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateTagApi->createTag: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
newTag *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


CreateWorkflow

createWorkflow

Creates a new workflow.


/v3/workflows

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateWorkflowApi;

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

public class CreateWorkflowApiExample {

    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");

        CreateWorkflowApi apiInstance = new CreateWorkflowApi();
        String apiecoKey = apiecoKey_example; // String | 
        Data_3 data = ; // Data_3 | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            data_3 result = apiInstance.createWorkflow(apiecoKey, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateWorkflowApi#createWorkflow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateWorkflowApi;

public class CreateWorkflowApiExample {

    public static void main(String[] args) {
        CreateWorkflowApi apiInstance = new CreateWorkflowApi();
        String apiecoKey = apiecoKey_example; // String | 
        Data_3 data = ; // Data_3 | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            data_3 result = apiInstance.createWorkflow(apiecoKey, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateWorkflowApi#createWorkflow");
            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; // 
Data_3 *data = ; // Accepts parameters in the request body as a JSON with the following attributes:

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

// 
[apiInstance createWorkflowWith:apiecoKey
    data:data
              completionHandler: ^(data_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.CreateWorkflowApi()

var apiecoKey = apiecoKey_example; // {String} 

var data = ; // {Data_3} Accepts parameters in the request body as a JSON with the following attributes:


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createWorkflow(apiecoKey, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createWorkflowExample
    {
        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 CreateWorkflowApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var data = new Data_3(); // Data_3 | Accepts parameters in the request body as a JSON with the following attributes:

            try
            {
                // 
                data_3 result = apiInstance.createWorkflow(apiecoKey, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateWorkflowApi.createWorkflow: " + 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\CreateWorkflowApi();
$apiecoKey = apiecoKey_example; // String | 
$data = ; // Data_3 | Accepts parameters in the request body as a JSON with the following attributes:

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

# 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::CreateWorkflowApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $data = WWW::SwaggerClient::Object::Data_3->new(); # Data_3 | Accepts parameters in the request body as a JSON with the following attributes:

eval { 
    my $result = $api_instance->createWorkflow(apiecoKey => $apiecoKey, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateWorkflowApi->createWorkflow: $@\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.CreateWorkflowApi()
apiecoKey = apiecoKey_example # String | 
data =  # Data_3 | Accepts parameters in the request body as a JSON with the following attributes:

try: 
    # 
    api_response = api_instance.create_workflow(apiecoKey, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateWorkflowApi->createWorkflow: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


DeleteClassifier

deleteClassifier

This endpoint deletes a classifier. This action cannot be undone.


/v3/classifiers/{MODEL_ID}

Usage and SDK Samples

curl -X DELETE -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteClassifierApi;

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

public class DeleteClassifierApiExample {

    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");

        DeleteClassifierApi apiInstance = new DeleteClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.deleteClassifier(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClassifierApi#deleteClassifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteClassifierApi;

public class DeleteClassifierApiExample {

    public static void main(String[] args) {
        DeleteClassifierApi apiInstance = new DeleteClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.deleteClassifier(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClassifierApi#deleteClassifier");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance deleteClassifierWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.DeleteClassifierApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteClassifier(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteClassifierExample
    {
        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 DeleteClassifierApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                apiInstance.deleteClassifier(apiecoKey, mODELID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteClassifierApi.deleteClassifier: " + 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\DeleteClassifierApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

try {
    $api_instance->deleteClassifier($apiecoKey, $mODELID);
} catch (Exception $e) {
    echo 'Exception when calling DeleteClassifierApi->deleteClassifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteClassifierApi;

# 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::DeleteClassifierApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    $api_instance->deleteClassifier(apiecoKey => $apiecoKey, mODELID => $mODELID);
};
if ($@) {
    warn "Exception when calling DeleteClassifierApi->deleteClassifier: $@\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.DeleteClassifierApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_instance.delete_classifier(apiecoKey, mODELID)
except ApiException as e:
    print("Exception when calling DeleteClassifierApi->deleteClassifier: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


DeleteStep

deleteStep

This endpoint deletes a Step from a classifier. This action cannot be undone.


/v3/workflows/{MODEL_ID}/tags/{STEP_ID}

Usage and SDK Samples

curl -X DELETE -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}/tags/{STEP_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteStepApi;

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

public class DeleteStepApiExample {

    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");

        DeleteStepApi apiInstance = new DeleteStepApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String sTEPID = sTEPID_example; // String | 
        try {
            apiInstance.deleteStep(apiecoKey, mODELID, sTEPID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteStepApi#deleteStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteStepApi;

public class DeleteStepApiExample {

    public static void main(String[] args) {
        DeleteStepApi apiInstance = new DeleteStepApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String sTEPID = sTEPID_example; // String | 
        try {
            apiInstance.deleteStep(apiecoKey, mODELID, sTEPID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteStepApi#deleteStep");
            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 *mODELID = mODELID_example; // 
String *sTEPID = sTEPID_example; // 

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

// 
[apiInstance deleteStepWith:apiecoKey
    mODELID:mODELID
    sTEPID:sTEPID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.DeleteStepApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var sTEPID = sTEPID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteStep(apiecoKey, mODELID, sTEPID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteStepExample
    {
        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 DeleteStepApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var sTEPID = sTEPID_example;  // String | 

            try
            {
                // 
                apiInstance.deleteStep(apiecoKey, mODELID, sTEPID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteStepApi.deleteStep: " + 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\DeleteStepApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$sTEPID = sTEPID_example; // String | 

try {
    $api_instance->deleteStep($apiecoKey, $mODELID, $sTEPID);
} catch (Exception $e) {
    echo 'Exception when calling DeleteStepApi->deleteStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteStepApi;

# 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::DeleteStepApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $sTEPID = sTEPID_example; # String | 

eval { 
    $api_instance->deleteStep(apiecoKey => $apiecoKey, mODELID => $mODELID, sTEPID => $sTEPID);
};
if ($@) {
    warn "Exception when calling DeleteStepApi->deleteStep: $@\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.DeleteStepApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
sTEPID = sTEPID_example # String | 

try: 
    # 
    api_instance.delete_step(apiecoKey, mODELID, sTEPID)
except ApiException as e:
    print("Exception when calling DeleteStepApi->deleteStep: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
STEP_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


DeleteTag

deleteTag

This endpoint deletes a tag from a classifier. This action cannot be undone.


/v3/classifiers/{MODEL_ID}/tags/{TAG_ID}

Usage and SDK Samples

curl -X DELETE -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}/tags/{TAG_ID}?move_data_to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteTagApi;

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

public class DeleteTagApiExample {

    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");

        DeleteTagApi apiInstance = new DeleteTagApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String tAGID = tAGID_example; // String | 
        Integer moveDataTo = 56; // Integer | It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional.
        try {
            apiInstance.deleteTag(apiecoKey, mODELID, tAGID, moveDataTo);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteTagApi#deleteTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteTagApi;

public class DeleteTagApiExample {

    public static void main(String[] args) {
        DeleteTagApi apiInstance = new DeleteTagApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String tAGID = tAGID_example; // String | 
        Integer moveDataTo = 56; // Integer | It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional.
        try {
            apiInstance.deleteTag(apiecoKey, mODELID, tAGID, moveDataTo);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteTagApi#deleteTag");
            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 *mODELID = mODELID_example; // 
String *tAGID = tAGID_example; // 
Integer *moveDataTo = 56; // It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional. (optional)

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

// 
[apiInstance deleteTagWith:apiecoKey
    mODELID:mODELID
    tAGID:tAGID
    moveDataTo:moveDataTo
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.DeleteTagApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var tAGID = tAGID_example; // {String} 

var opts = { 
  'moveDataTo': 56 // {Integer} It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTag(apiecoKey, mODELID, tAGID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTagExample
    {
        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 DeleteTagApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var tAGID = tAGID_example;  // String | 
            var moveDataTo = 56;  // Integer | It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional. (optional) 

            try
            {
                // 
                apiInstance.deleteTag(apiecoKey, mODELID, tAGID, moveDataTo);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteTagApi.deleteTag: " + 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\DeleteTagApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$tAGID = tAGID_example; // String | 
$moveDataTo = 56; // Integer | It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional.

try {
    $api_instance->deleteTag($apiecoKey, $mODELID, $tAGID, $moveDataTo);
} catch (Exception $e) {
    echo 'Exception when calling DeleteTagApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteTagApi;

# 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::DeleteTagApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $tAGID = tAGID_example; # String | 
my $moveDataTo = 56; # Integer | It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional.

eval { 
    $api_instance->deleteTag(apiecoKey => $apiecoKey, mODELID => $mODELID, tAGID => $tAGID, moveDataTo => $moveDataTo);
};
if ($@) {
    warn "Exception when calling DeleteTagApi->deleteTag: $@\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.DeleteTagApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
tAGID = tAGID_example # String | 
moveDataTo = 56 # Integer | It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional. (optional)

try: 
    # 
    api_instance.delete_tag(apiecoKey, mODELID, tAGID, moveDataTo=moveDataTo)
except ApiException as e:
    print("Exception when calling DeleteTagApi->deleteTag: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
TAG_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
move_data_to
Integer
It’s a tag ID. The data that was tagged with the deleted tag will be tagged with this new tag. This parameter is optional.

Responses

Status: 200 - Successful

Status: 405 - Invalid input


DeleteWorkflow

deleteWorkflow

This endpoint deletes a workflow. This action cannot be undone.


/v3/workflows/{MODEL_ID}

Usage and SDK Samples

curl -X DELETE -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteWorkflowApi;

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

public class DeleteWorkflowApiExample {

    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");

        DeleteWorkflowApi apiInstance = new DeleteWorkflowApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.deleteWorkflow(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteWorkflowApi#deleteWorkflow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteWorkflowApi;

public class DeleteWorkflowApiExample {

    public static void main(String[] args) {
        DeleteWorkflowApi apiInstance = new DeleteWorkflowApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.deleteWorkflow(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteWorkflowApi#deleteWorkflow");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance deleteWorkflowWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.DeleteWorkflowApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteWorkflow(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteWorkflowExample
    {
        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 DeleteWorkflowApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                apiInstance.deleteWorkflow(apiecoKey, mODELID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteWorkflowApi.deleteWorkflow: " + 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\DeleteWorkflowApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

try {
    $api_instance->deleteWorkflow($apiecoKey, $mODELID);
} catch (Exception $e) {
    echo 'Exception when calling DeleteWorkflowApi->deleteWorkflow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteWorkflowApi;

# 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::DeleteWorkflowApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    $api_instance->deleteWorkflow(apiecoKey => $apiecoKey, mODELID => $mODELID);
};
if ($@) {
    warn "Exception when calling DeleteWorkflowApi->deleteWorkflow: $@\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.DeleteWorkflowApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_instance.delete_workflow(apiecoKey, mODELID)
except ApiException as e:
    print("Exception when calling DeleteWorkflowApi->deleteWorkflow: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


DeployClassifier

deployClassifier

Deploys the current model to production. Note that the old production model will be overwritten and lost. The model must be trained in order to be deployed. This action cannot be undone..


/v3/classifiers/{MODEL_ID}/deploy

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}/deploy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployClassifierApi;

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

public class DeployClassifierApiExample {

    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");

        DeployClassifierApi apiInstance = new DeployClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.deployClassifier(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployClassifierApi#deployClassifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployClassifierApi;

public class DeployClassifierApiExample {

    public static void main(String[] args) {
        DeployClassifierApi apiInstance = new DeployClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.deployClassifier(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployClassifierApi#deployClassifier");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance deployClassifierWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.DeployClassifierApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deployClassifier(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deployClassifierExample
    {
        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 DeployClassifierApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                apiInstance.deployClassifier(apiecoKey, mODELID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployClassifierApi.deployClassifier: " + 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\DeployClassifierApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

try {
    $api_instance->deployClassifier($apiecoKey, $mODELID);
} catch (Exception $e) {
    echo 'Exception when calling DeployClassifierApi->deployClassifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeployClassifierApi;

# 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::DeployClassifierApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    $api_instance->deployClassifier(apiecoKey => $apiecoKey, mODELID => $mODELID);
};
if ($@) {
    warn "Exception when calling DeployClassifierApi->deployClassifier: $@\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.DeployClassifierApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_instance.deploy_classifier(apiecoKey, mODELID)
except ApiException as e:
    print("Exception when calling DeployClassifierApi->deployClassifier: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


EditClassifier

editClassifier

Updates a classifier name, description, and settings.


/v3/classifiers/{MODEL_ID}

Usage and SDK Samples

curl -X PATCH -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EditClassifierApi;

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

public class EditClassifierApiExample {

    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");

        EditClassifierApi apiInstance = new EditClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        NewClassifier newClassifier = ; // NewClassifier | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            inline_response_200_2 result = apiInstance.editClassifier(apiecoKey, mODELID, newClassifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EditClassifierApi#editClassifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EditClassifierApi;

public class EditClassifierApiExample {

    public static void main(String[] args) {
        EditClassifierApi apiInstance = new EditClassifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        NewClassifier newClassifier = ; // NewClassifier | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            inline_response_200_2 result = apiInstance.editClassifier(apiecoKey, mODELID, newClassifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EditClassifierApi#editClassifier");
            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 *mODELID = mODELID_example; // 
NewClassifier *newClassifier = ; // Accepts parameters in the request body as a JSON with the following attributes:

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

// 
[apiInstance editClassifierWith:apiecoKey
    mODELID:mODELID
    newClassifier:newClassifier
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.EditClassifierApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var newClassifier = ; // {NewClassifier} Accepts parameters in the request body as a JSON with the following attributes:


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editClassifier(apiecoKey, mODELID, newClassifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editClassifierExample
    {
        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 EditClassifierApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var newClassifier = new NewClassifier(); // NewClassifier | Accepts parameters in the request body as a JSON with the following attributes:

            try
            {
                // 
                inline_response_200_2 result = apiInstance.editClassifier(apiecoKey, mODELID, newClassifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EditClassifierApi.editClassifier: " + 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\EditClassifierApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$newClassifier = ; // NewClassifier | Accepts parameters in the request body as a JSON with the following attributes:

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

# 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::EditClassifierApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $newClassifier = WWW::SwaggerClient::Object::NewClassifier->new(); # NewClassifier | Accepts parameters in the request body as a JSON with the following attributes:

eval { 
    my $result = $api_instance->editClassifier(apiecoKey => $apiecoKey, mODELID => $mODELID, newClassifier => $newClassifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EditClassifierApi->editClassifier: $@\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.EditClassifierApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
newClassifier =  # NewClassifier | Accepts parameters in the request body as a JSON with the following attributes:

try: 
    # 
    api_response = api_instance.edit_classifier(apiecoKey, mODELID, newClassifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditClassifierApi->editClassifier: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
newClassifier *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


EditTag

editTag

Updates a tag in a classifier.


/v3/classifiers/{MODEL_ID}/tags/{TAG_ID}

Usage and SDK Samples

curl -X PATCH -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}/tags/{TAG_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EditTagApi;

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

public class EditTagApiExample {

    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");

        EditTagApi apiInstance = new EditTagApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String tAGID = tAGID_example; // String | 
        NewTag newTag = ; // NewTag | 
        try {
            NewTag result = apiInstance.editTag(apiecoKey, mODELID, tAGID, newTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EditTagApi#editTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EditTagApi;

public class EditTagApiExample {

    public static void main(String[] args) {
        EditTagApi apiInstance = new EditTagApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String tAGID = tAGID_example; // String | 
        NewTag newTag = ; // NewTag | 
        try {
            NewTag result = apiInstance.editTag(apiecoKey, mODELID, tAGID, newTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EditTagApi#editTag");
            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 *mODELID = mODELID_example; // 
String *tAGID = tAGID_example; // 
NewTag *newTag = ; // 

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

// 
[apiInstance editTagWith:apiecoKey
    mODELID:mODELID
    tAGID:tAGID
    newTag:newTag
              completionHandler: ^(NewTag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.EditTagApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var tAGID = tAGID_example; // {String} 

var newTag = ; // {NewTag} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editTag(apiecoKey, mODELID, tAGID, newTag, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editTagExample
    {
        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 EditTagApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var tAGID = tAGID_example;  // String | 
            var newTag = new NewTag(); // NewTag | 

            try
            {
                // 
                NewTag result = apiInstance.editTag(apiecoKey, mODELID, tAGID, newTag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EditTagApi.editTag: " + 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\EditTagApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$tAGID = tAGID_example; // String | 
$newTag = ; // NewTag | 

try {
    $result = $api_instance->editTag($apiecoKey, $mODELID, $tAGID, $newTag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditTagApi->editTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EditTagApi;

# 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::EditTagApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $tAGID = tAGID_example; # String | 
my $newTag = WWW::SwaggerClient::Object::NewTag->new(); # NewTag | 

eval { 
    my $result = $api_instance->editTag(apiecoKey => $apiecoKey, mODELID => $mODELID, tAGID => $tAGID, newTag => $newTag);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EditTagApi->editTag: $@\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.EditTagApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
tAGID = tAGID_example # String | 
newTag =  # NewTag | 

try: 
    # 
    api_response = api_instance.edit_tag(apiecoKey, mODELID, tAGID, newTag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditTagApi->editTag: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
TAG_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
newTag *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


Extract

extract

Extracts information from texts with a given extractor.


/v3/extractors/[MODEL_ID]/extract

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/extractors/[MODEL_ID]/extract?production_model="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExtractApi;

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

public class ExtractApiExample {

    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");

        ExtractApi apiInstance = new ExtractApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Data_2 data = ; // Data_2 | A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
        Boolean productionModel = true; // Boolean | Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.
        try {
            inline_response_200_7 result = apiInstance.extract(apiecoKey, mODELID, data, productionModel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtractApi#extract");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExtractApi;

public class ExtractApiExample {

    public static void main(String[] args) {
        ExtractApi apiInstance = new ExtractApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Data_2 data = ; // Data_2 | A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
        Boolean productionModel = true; // Boolean | Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.
        try {
            inline_response_200_7 result = apiInstance.extract(apiecoKey, mODELID, data, productionModel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtractApi#extract");
            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 *mODELID = mODELID_example; // 
Data_2 *data = ; // A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
Boolean *productionModel = true; // Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.

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

// 
[apiInstance extractWith:apiecoKey
    mODELID:mODELID
    data:data
    productionModel:productionModel
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ExtractApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var data = ; // {Data_2} A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .

var productionModel = true; // {Boolean} Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.extract(apiecoKey, mODELID, data, productionModel, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class extractExample
    {
        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 ExtractApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var data = new Data_2(); // Data_2 | A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
            var productionModel = true;  // Boolean | Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.

            try
            {
                // 
                inline_response_200_7 result = apiInstance.extract(apiecoKey, mODELID, data, productionModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExtractApi.extract: " + 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\ExtractApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$data = ; // Data_2 | A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
$productionModel = true; // Boolean | Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.

try {
    $result = $api_instance->extract($apiecoKey, $mODELID, $data, $productionModel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExtractApi->extract: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExtractApi;

# 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::ExtractApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $data = WWW::SwaggerClient::Object::Data_2->new(); # Data_2 | A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
my $productionModel = true; # Boolean | Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.

eval { 
    my $result = $api_instance->extract(apiecoKey => $apiecoKey, mODELID => $mODELID, data => $data, productionModel => $productionModel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExtractApi->extract: $@\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.ExtractApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
data =  # Data_2 | A list of up to 500 data elements to extract from. Each element must be either a string with the text or a data object .
productionModel = true # Boolean | Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.

try: 
    # 
    api_response = api_instance.extract(apiecoKey, mODELID, data, productionModel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExtractApi->extract: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
data *
Query parameters
Name Description
production_model*
Boolean
Indicates if the extractions are performed by the production model. Only use this parameter on custom models. Note that you first need to deploy your model to production either from the UI model settings.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


ExtractorDetail

extractorDetail

Returns information about an extractor.


/v3/extractors/[MODEL_ID]

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/extractors/[MODEL_ID]"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExtractorDetailApi;

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

public class ExtractorDetailApiExample {

    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");

        ExtractorDetailApi apiInstance = new ExtractorDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            inline_response_200_8 result = apiInstance.extractorDetail(apiecoKey, mODELID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtractorDetailApi#extractorDetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExtractorDetailApi;

public class ExtractorDetailApiExample {

    public static void main(String[] args) {
        ExtractorDetailApi apiInstance = new ExtractorDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            inline_response_200_8 result = apiInstance.extractorDetail(apiecoKey, mODELID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtractorDetailApi#extractorDetail");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance extractorDetailWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ExtractorDetailApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.extractorDetail(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class extractorDetailExample
    {
        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 ExtractorDetailApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                inline_response_200_8 result = apiInstance.extractorDetail(apiecoKey, mODELID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExtractorDetailApi.extractorDetail: " + 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\ExtractorDetailApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

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

# 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::ExtractorDetailApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    my $result = $api_instance->extractorDetail(apiecoKey => $apiecoKey, mODELID => $mODELID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExtractorDetailApi->extractorDetail: $@\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.ExtractorDetailApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_response = api_instance.extractor_detail(apiecoKey, mODELID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExtractorDetailApi->extractorDetail: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


ListClassifiers

listClassifiers

Returns all the available classifiers for the user. This includes their custom models, public models, and models shared in the teams the user belongs to. This endpoint supports pagination.


/v3/classifiers

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers?page=&per_page=&order_by="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListClassifiersApi;

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

public class ListClassifiersApiExample {

    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");

        ListClassifiersApi apiInstance = new ListClassifiersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Integer page = 56; // Integer | The page number to be retrieved.
        Integer perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
        String orderBy = orderBy_example; // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.
        try {
            inline_response_200_3 result = apiInstance.listClassifiers(apiecoKey, mODELID, page, perPage, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListClassifiersApi#listClassifiers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListClassifiersApi;

public class ListClassifiersApiExample {

    public static void main(String[] args) {
        ListClassifiersApi apiInstance = new ListClassifiersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Integer page = 56; // Integer | The page number to be retrieved.
        Integer perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
        String orderBy = orderBy_example; // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.
        try {
            inline_response_200_3 result = apiInstance.listClassifiers(apiecoKey, mODELID, page, perPage, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListClassifiersApi#listClassifiers");
            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 *mODELID = mODELID_example; // 
Integer *page = 56; // The page number to be retrieved.
Integer *perPage = 56; // The maximum number of items the page should have. The maximum allowed value is 50.
String *orderBy = orderBy_example; // Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

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

// 
[apiInstance listClassifiersWith:apiecoKey
    mODELID:mODELID
    page:page
    perPage:perPage
    orderBy:orderBy
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ListClassifiersApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var page = 56; // {Integer} The page number to be retrieved.

var perPage = 56; // {Integer} The maximum number of items the page should have. The maximum allowed value is 50.

var orderBy = orderBy_example; // {String} Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listClassifiers(apiecoKey, mODELID, page, perPage, orderBy, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listClassifiersExample
    {
        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 ListClassifiersApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var page = 56;  // Integer | The page number to be retrieved.
            var perPage = 56;  // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
            var orderBy = orderBy_example;  // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

            try
            {
                // 
                inline_response_200_3 result = apiInstance.listClassifiers(apiecoKey, mODELID, page, perPage, orderBy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListClassifiersApi.listClassifiers: " + 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\ListClassifiersApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$page = 56; // Integer | The page number to be retrieved.
$perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
$orderBy = orderBy_example; // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

try {
    $result = $api_instance->listClassifiers($apiecoKey, $mODELID, $page, $perPage, $orderBy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListClassifiersApi->listClassifiers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListClassifiersApi;

# 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::ListClassifiersApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $page = 56; # Integer | The page number to be retrieved.
my $perPage = 56; # Integer | The maximum number of items the page should have. The maximum allowed value is 50.
my $orderBy = orderBy_example; # String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

eval { 
    my $result = $api_instance->listClassifiers(apiecoKey => $apiecoKey, mODELID => $mODELID, page => $page, perPage => $perPage, orderBy => $orderBy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListClassifiersApi->listClassifiers: $@\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.ListClassifiersApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
page = 56 # Integer | The page number to be retrieved.
perPage = 56 # Integer | The maximum number of items the page should have. The maximum allowed value is 50.
orderBy = orderBy_example # String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

try: 
    # 
    api_response = api_instance.list_classifiers(apiecoKey, mODELID, page, perPage, orderBy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListClassifiersApi->listClassifiers: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
page*
Integer
The page number to be retrieved.
Required
per_page*
Integer
The maximum number of items the page should have. The maximum allowed value is 50.
Required
order_by*
String
Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


ListExtractors

listExtractors

Returns all the available extractors for the user. This includes their custom models, public models, and models shared in the teams the user belongs to. This endpoint supports pagination.


/v3/extractors

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/extractors?page=&per_page=&order_by="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListExtractorsApi;

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

public class ListExtractorsApiExample {

    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");

        ListExtractorsApi apiInstance = new ListExtractorsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Integer page = 56; // Integer | The page number to be retrieved.
        Integer perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
        String orderBy = orderBy_example; // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.
        try {
            inline_response_200_3 result = apiInstance.listExtractors(apiecoKey, mODELID, page, perPage, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListExtractorsApi#listExtractors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListExtractorsApi;

public class ListExtractorsApiExample {

    public static void main(String[] args) {
        ListExtractorsApi apiInstance = new ListExtractorsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Integer page = 56; // Integer | The page number to be retrieved.
        Integer perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
        String orderBy = orderBy_example; // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.
        try {
            inline_response_200_3 result = apiInstance.listExtractors(apiecoKey, mODELID, page, perPage, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListExtractorsApi#listExtractors");
            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 *mODELID = mODELID_example; // 
Integer *page = 56; // The page number to be retrieved.
Integer *perPage = 56; // The maximum number of items the page should have. The maximum allowed value is 50.
String *orderBy = orderBy_example; // Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

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

// 
[apiInstance listExtractorsWith:apiecoKey
    mODELID:mODELID
    page:page
    perPage:perPage
    orderBy:orderBy
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ListExtractorsApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var page = 56; // {Integer} The page number to be retrieved.

var perPage = 56; // {Integer} The maximum number of items the page should have. The maximum allowed value is 50.

var orderBy = orderBy_example; // {String} Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listExtractors(apiecoKey, mODELID, page, perPage, orderBy, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listExtractorsExample
    {
        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 ListExtractorsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var page = 56;  // Integer | The page number to be retrieved.
            var perPage = 56;  // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
            var orderBy = orderBy_example;  // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

            try
            {
                // 
                inline_response_200_3 result = apiInstance.listExtractors(apiecoKey, mODELID, page, perPage, orderBy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListExtractorsApi.listExtractors: " + 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\ListExtractorsApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$page = 56; // Integer | The page number to be retrieved.
$perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
$orderBy = orderBy_example; // String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

try {
    $result = $api_instance->listExtractors($apiecoKey, $mODELID, $page, $perPage, $orderBy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListExtractorsApi->listExtractors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListExtractorsApi;

# 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::ListExtractorsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $page = 56; # Integer | The page number to be retrieved.
my $perPage = 56; # Integer | The maximum number of items the page should have. The maximum allowed value is 50.
my $orderBy = orderBy_example; # String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

eval { 
    my $result = $api_instance->listExtractors(apiecoKey => $apiecoKey, mODELID => $mODELID, page => $page, perPage => $perPage, orderBy => $orderBy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListExtractorsApi->listExtractors: $@\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.ListExtractorsApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
page = 56 # Integer | The page number to be retrieved.
perPage = 56 # Integer | The maximum number of items the page should have. The maximum allowed value is 50.
orderBy = orderBy_example # String | Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.

try: 
    # 
    api_response = api_instance.list_extractors(apiecoKey, mODELID, page, perPage, orderBy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListExtractorsApi->listExtractors: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
page*
Integer
The page number to be retrieved.
Required
per_page*
Integer
The maximum number of items the page should have. The maximum allowed value is 50.
Required
order_by*
String
Specifies the order of the list. It can be ordered using any of the field names, either in ascending or descending order (adding ‘-’ before the name). Also, more than one criteria can be specified, separated with commas. Added in v3.2.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


ListWorkflowData

listWorkflowData

Lists data in a workflow with its corresponding processed output.


/v3/workflows/{MODEL_ID}/data

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}/data?page=&per_page=&batch_id=&is_processed=&sent_to_process_date_from=&sent_to_process_date_to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListWorkflowDataApi;

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

public class ListWorkflowDataApiExample {

    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");

        ListWorkflowDataApi apiInstance = new ListWorkflowDataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Integer page = 56; // Integer | The page number to be retrieved.
        Integer perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
        String batchId = batchId_example; // String | The ID of the batch to retrieve. If unspecified, data from all batches is shown.
        Boolean isProcessed = true; // Boolean | Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
        String sentToProcessDateFrom = sentToProcessDateFrom_example; // String | An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
        String sentToProcessDateTo = sentToProcessDateTo_example; // String | An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.
        try {
            inline_response_200_11 result = apiInstance.listWorkflowData(apiecoKey, mODELID, page, perPage, batchId, isProcessed, sentToProcessDateFrom, sentToProcessDateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListWorkflowDataApi#listWorkflowData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListWorkflowDataApi;

public class ListWorkflowDataApiExample {

    public static void main(String[] args) {
        ListWorkflowDataApi apiInstance = new ListWorkflowDataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Integer page = 56; // Integer | The page number to be retrieved.
        Integer perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
        String batchId = batchId_example; // String | The ID of the batch to retrieve. If unspecified, data from all batches is shown.
        Boolean isProcessed = true; // Boolean | Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
        String sentToProcessDateFrom = sentToProcessDateFrom_example; // String | An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
        String sentToProcessDateTo = sentToProcessDateTo_example; // String | An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.
        try {
            inline_response_200_11 result = apiInstance.listWorkflowData(apiecoKey, mODELID, page, perPage, batchId, isProcessed, sentToProcessDateFrom, sentToProcessDateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListWorkflowDataApi#listWorkflowData");
            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 *mODELID = mODELID_example; // 
Integer *page = 56; // The page number to be retrieved.
Integer *perPage = 56; // The maximum number of items the page should have. The maximum allowed value is 50.
String *batchId = batchId_example; // The ID of the batch to retrieve. If unspecified, data from all batches is shown.
Boolean *isProcessed = true; // Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
String *sentToProcessDateFrom = sentToProcessDateFrom_example; // An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
String *sentToProcessDateTo = sentToProcessDateTo_example; // An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.

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

// 
[apiInstance listWorkflowDataWith:apiecoKey
    mODELID:mODELID
    page:page
    perPage:perPage
    batchId:batchId
    isProcessed:isProcessed
    sentToProcessDateFrom:sentToProcessDateFrom
    sentToProcessDateTo:sentToProcessDateTo
              completionHandler: ^(inline_response_200_11 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.ListWorkflowDataApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var page = 56; // {Integer} The page number to be retrieved.

var perPage = 56; // {Integer} The maximum number of items the page should have. The maximum allowed value is 50.

var batchId = batchId_example; // {String} The ID of the batch to retrieve. If unspecified, data from all batches is shown.

var isProcessed = true; // {Boolean} Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.

var sentToProcessDateFrom = sentToProcessDateFrom_example; // {String} An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.

var sentToProcessDateTo = sentToProcessDateTo_example; // {String} An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listWorkflowData(apiecoKey, mODELID, page, perPage, batchId, isProcessed, sentToProcessDateFrom, sentToProcessDateTo, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listWorkflowDataExample
    {
        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 ListWorkflowDataApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var page = 56;  // Integer | The page number to be retrieved.
            var perPage = 56;  // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
            var batchId = batchId_example;  // String | The ID of the batch to retrieve. If unspecified, data from all batches is shown.
            var isProcessed = true;  // Boolean | Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
            var sentToProcessDateFrom = sentToProcessDateFrom_example;  // String | An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
            var sentToProcessDateTo = sentToProcessDateTo_example;  // String | An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.

            try
            {
                // 
                inline_response_200_11 result = apiInstance.listWorkflowData(apiecoKey, mODELID, page, perPage, batchId, isProcessed, sentToProcessDateFrom, sentToProcessDateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListWorkflowDataApi.listWorkflowData: " + 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\ListWorkflowDataApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$page = 56; // Integer | The page number to be retrieved.
$perPage = 56; // Integer | The maximum number of items the page should have. The maximum allowed value is 50.
$batchId = batchId_example; // String | The ID of the batch to retrieve. If unspecified, data from all batches is shown.
$isProcessed = true; // Boolean | Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
$sentToProcessDateFrom = sentToProcessDateFrom_example; // String | An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
$sentToProcessDateTo = sentToProcessDateTo_example; // String | An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.

try {
    $result = $api_instance->listWorkflowData($apiecoKey, $mODELID, $page, $perPage, $batchId, $isProcessed, $sentToProcessDateFrom, $sentToProcessDateTo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListWorkflowDataApi->listWorkflowData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListWorkflowDataApi;

# 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::ListWorkflowDataApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $page = 56; # Integer | The page number to be retrieved.
my $perPage = 56; # Integer | The maximum number of items the page should have. The maximum allowed value is 50.
my $batchId = batchId_example; # String | The ID of the batch to retrieve. If unspecified, data from all batches is shown.
my $isProcessed = true; # Boolean | Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
my $sentToProcessDateFrom = sentToProcessDateFrom_example; # String | An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
my $sentToProcessDateTo = sentToProcessDateTo_example; # String | An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.

eval { 
    my $result = $api_instance->listWorkflowData(apiecoKey => $apiecoKey, mODELID => $mODELID, page => $page, perPage => $perPage, batchId => $batchId, isProcessed => $isProcessed, sentToProcessDateFrom => $sentToProcessDateFrom, sentToProcessDateTo => $sentToProcessDateTo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListWorkflowDataApi->listWorkflowData: $@\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.ListWorkflowDataApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
page = 56 # Integer | The page number to be retrieved.
perPage = 56 # Integer | The maximum number of items the page should have. The maximum allowed value is 50.
batchId = batchId_example # String | The ID of the batch to retrieve. If unspecified, data from all batches is shown.
isProcessed = true # Boolean | Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
sentToProcessDateFrom = sentToProcessDateFrom_example # String | An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
sentToProcessDateTo = sentToProcessDateTo_example # String | An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.

try: 
    # 
    api_response = api_instance.list_workflow_data(apiecoKey, mODELID, page, perPage, batchId, isProcessed, sentToProcessDateFrom, sentToProcessDateTo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListWorkflowDataApi->listWorkflowData: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
page*
Integer
The page number to be retrieved.
Required
per_page*
Integer
The maximum number of items the page should have. The maximum allowed value is 50.
Required
batch_id*
String
The ID of the batch to retrieve. If unspecified, data from all batches is shown.
Required
is_processed*
Boolean
Whether to return data that has been processed or data that has not been processed yet. If unspecified, both are shown indistinctly.
Required
sent_to_process_date_from*
String
An ISO formatted date which specifies the oldest sent_date of the data to be retrieved.
Required
sent_to_process_date_to*
String
An ISO formatted date which specifies the most recent sent_date of the data to be retrieved.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


StepDetail

stepDetail

Returns information about a step.


/v3/workflows/{MODEL_ID}/tags/{STEP_ID}

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}/tags/{STEP_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StepDetailApi;

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

public class StepDetailApiExample {

    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");

        StepDetailApi apiInstance = new StepDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String sTEPID = sTEPID_example; // String | 
        try {
            inline_response_200_10 result = apiInstance.stepDetail(apiecoKey, mODELID, sTEPID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepDetailApi#stepDetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StepDetailApi;

public class StepDetailApiExample {

    public static void main(String[] args) {
        StepDetailApi apiInstance = new StepDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String sTEPID = sTEPID_example; // String | 
        try {
            inline_response_200_10 result = apiInstance.stepDetail(apiecoKey, mODELID, sTEPID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepDetailApi#stepDetail");
            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 *mODELID = mODELID_example; // 
String *sTEPID = sTEPID_example; // 

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

// 
[apiInstance stepDetailWith:apiecoKey
    mODELID:mODELID
    sTEPID:sTEPID
              completionHandler: ^(inline_response_200_10 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.StepDetailApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var sTEPID = sTEPID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stepDetail(apiecoKey, mODELID, sTEPID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stepDetailExample
    {
        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 StepDetailApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var sTEPID = sTEPID_example;  // String | 

            try
            {
                // 
                inline_response_200_10 result = apiInstance.stepDetail(apiecoKey, mODELID, sTEPID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StepDetailApi.stepDetail: " + 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\StepDetailApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$sTEPID = sTEPID_example; // String | 

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

# 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::StepDetailApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $sTEPID = sTEPID_example; # String | 

eval { 
    my $result = $api_instance->stepDetail(apiecoKey => $apiecoKey, mODELID => $mODELID, sTEPID => $sTEPID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StepDetailApi->stepDetail: $@\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.StepDetailApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
sTEPID = sTEPID_example # String | 

try: 
    # 
    api_response = api_instance.step_detail(apiecoKey, mODELID, sTEPID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StepDetailApi->stepDetail: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
STEP_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


TagDetail

tagDetail

Returns information about a tag.


/v3/classifiers/{MODEL_ID}/tags/{TAG_ID}

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifiers/{MODEL_ID}/tags/{TAG_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagDetailApi;

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

public class TagDetailApiExample {

    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");

        TagDetailApi apiInstance = new TagDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String tAGID = tAGID_example; // String | 
        try {
            inline_response_200_5 result = apiInstance.tagDetail(apiecoKey, mODELID, tAGID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagDetailApi#tagDetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagDetailApi;

public class TagDetailApiExample {

    public static void main(String[] args) {
        TagDetailApi apiInstance = new TagDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        String tAGID = tAGID_example; // String | 
        try {
            inline_response_200_5 result = apiInstance.tagDetail(apiecoKey, mODELID, tAGID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagDetailApi#tagDetail");
            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 *mODELID = mODELID_example; // 
String *tAGID = tAGID_example; // 

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

// 
[apiInstance tagDetailWith:apiecoKey
    mODELID:mODELID
    tAGID:tAGID
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.TagDetailApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var tAGID = tAGID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagDetail(apiecoKey, mODELID, tAGID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class tagDetailExample
    {
        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 TagDetailApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var tAGID = tAGID_example;  // String | 

            try
            {
                // 
                inline_response_200_5 result = apiInstance.tagDetail(apiecoKey, mODELID, tAGID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagDetailApi.tagDetail: " + 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\TagDetailApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$tAGID = tAGID_example; // String | 

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

# 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::TagDetailApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $tAGID = tAGID_example; # String | 

eval { 
    my $result = $api_instance->tagDetail(apiecoKey => $apiecoKey, mODELID => $mODELID, tAGID => $tAGID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagDetailApi->tagDetail: $@\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.TagDetailApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
tAGID = tAGID_example # String | 

try: 
    # 
    api_response = api_instance.tag_detail(apiecoKey, mODELID, tAGID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagDetailApi->tagDetail: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
TAG_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


TrainExtractor

trainExtractor

Starts training the model. Please note that models train automatically and it is not required to manually train them.


/v3/extractors/[MODEL_ID]/train

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/extractors/[MODEL_ID]/train"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TrainExtractorApi;

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

public class TrainExtractorApiExample {

    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");

        TrainExtractorApi apiInstance = new TrainExtractorApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.trainExtractor(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling TrainExtractorApi#trainExtractor");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TrainExtractorApi;

public class TrainExtractorApiExample {

    public static void main(String[] args) {
        TrainExtractorApi apiInstance = new TrainExtractorApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            apiInstance.trainExtractor(apiecoKey, mODELID);
        } catch (ApiException e) {
            System.err.println("Exception when calling TrainExtractorApi#trainExtractor");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance trainExtractorWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.TrainExtractorApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.trainExtractor(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class trainExtractorExample
    {
        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 TrainExtractorApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                apiInstance.trainExtractor(apiecoKey, mODELID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TrainExtractorApi.trainExtractor: " + 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\TrainExtractorApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

try {
    $api_instance->trainExtractor($apiecoKey, $mODELID);
} catch (Exception $e) {
    echo 'Exception when calling TrainExtractorApi->trainExtractor: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TrainExtractorApi;

# 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::TrainExtractorApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    $api_instance->trainExtractor(apiecoKey => $apiecoKey, mODELID => $mODELID);
};
if ($@) {
    warn "Exception when calling TrainExtractorApi->trainExtractor: $@\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.TrainExtractorApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_instance.train_extractor(apiecoKey, mODELID)
except ApiException as e:
    print("Exception when calling TrainExtractorApi->trainExtractor: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


UploadClassifierData

uploadClassifierData

Uploads data to a classifier. This endpoint can be used to upload new data to a classifier, to update the tags of texts that have already been uploaded, or both.


/v3/classifires/{MODEL_ID}/data

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/classifires/{MODEL_ID}/data?input_duplicates_strategy=&existing_duplicates_strategy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadClassifierDataApi;

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

public class UploadClassifierDataApiExample {

    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");

        UploadClassifierDataApi apiInstance = new UploadClassifierDataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Data_1 data = ; // Data_1 | Accepts parameters in the request body as a JSON with the following attributes:
        String inputDuplicatesStrategy = inputDuplicatesStrategy_example; // String | Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
        String existingDuplicatesStrategy = existingDuplicatesStrategy_example; // String | Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.
        try {
            inline_response_200_6 result = apiInstance.uploadClassifierData(apiecoKey, mODELID, data, inputDuplicatesStrategy, existingDuplicatesStrategy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadClassifierDataApi#uploadClassifierData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadClassifierDataApi;

public class UploadClassifierDataApiExample {

    public static void main(String[] args) {
        UploadClassifierDataApi apiInstance = new UploadClassifierDataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        Data_1 data = ; // Data_1 | Accepts parameters in the request body as a JSON with the following attributes:
        String inputDuplicatesStrategy = inputDuplicatesStrategy_example; // String | Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
        String existingDuplicatesStrategy = existingDuplicatesStrategy_example; // String | Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.
        try {
            inline_response_200_6 result = apiInstance.uploadClassifierData(apiecoKey, mODELID, data, inputDuplicatesStrategy, existingDuplicatesStrategy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadClassifierDataApi#uploadClassifierData");
            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 *mODELID = mODELID_example; // 
Data_1 *data = ; // Accepts parameters in the request body as a JSON with the following attributes:
String *inputDuplicatesStrategy = inputDuplicatesStrategy_example; // Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
String *existingDuplicatesStrategy = existingDuplicatesStrategy_example; // Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.

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

// 
[apiInstance uploadClassifierDataWith:apiecoKey
    mODELID:mODELID
    data:data
    inputDuplicatesStrategy:inputDuplicatesStrategy
    existingDuplicatesStrategy:existingDuplicatesStrategy
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.UploadClassifierDataApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var data = ; // {Data_1} Accepts parameters in the request body as a JSON with the following attributes:

var inputDuplicatesStrategy = inputDuplicatesStrategy_example; // {String} Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.

var existingDuplicatesStrategy = existingDuplicatesStrategy_example; // {String} Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadClassifierData(apiecoKey, mODELID, data, inputDuplicatesStrategy, existingDuplicatesStrategy, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadClassifierDataExample
    {
        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 UploadClassifierDataApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var data = new Data_1(); // Data_1 | Accepts parameters in the request body as a JSON with the following attributes:
            var inputDuplicatesStrategy = inputDuplicatesStrategy_example;  // String | Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
            var existingDuplicatesStrategy = existingDuplicatesStrategy_example;  // String | Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.

            try
            {
                // 
                inline_response_200_6 result = apiInstance.uploadClassifierData(apiecoKey, mODELID, data, inputDuplicatesStrategy, existingDuplicatesStrategy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadClassifierDataApi.uploadClassifierData: " + 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\UploadClassifierDataApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$data = ; // Data_1 | Accepts parameters in the request body as a JSON with the following attributes:
$inputDuplicatesStrategy = inputDuplicatesStrategy_example; // String | Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
$existingDuplicatesStrategy = existingDuplicatesStrategy_example; // String | Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.

try {
    $result = $api_instance->uploadClassifierData($apiecoKey, $mODELID, $data, $inputDuplicatesStrategy, $existingDuplicatesStrategy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadClassifierDataApi->uploadClassifierData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadClassifierDataApi;

# 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::UploadClassifierDataApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $data = WWW::SwaggerClient::Object::Data_1->new(); # Data_1 | Accepts parameters in the request body as a JSON with the following attributes:
my $inputDuplicatesStrategy = inputDuplicatesStrategy_example; # String | Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
my $existingDuplicatesStrategy = existingDuplicatesStrategy_example; # String | Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.

eval { 
    my $result = $api_instance->uploadClassifierData(apiecoKey => $apiecoKey, mODELID => $mODELID, data => $data, inputDuplicatesStrategy => $inputDuplicatesStrategy, existingDuplicatesStrategy => $existingDuplicatesStrategy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadClassifierDataApi->uploadClassifierData: $@\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.UploadClassifierDataApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
data =  # Data_1 | Accepts parameters in the request body as a JSON with the following attributes:
inputDuplicatesStrategy = inputDuplicatesStrategy_example # String | Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
existingDuplicatesStrategy = existingDuplicatesStrategy_example # String | Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.

try: 
    # 
    api_response = api_instance.upload_classifier_data(apiecoKey, mODELID, data, inputDuplicatesStrategy, existingDuplicatesStrategy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadClassifierDataApi->uploadClassifierData: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
data *
Query parameters
Name Description
input_duplicates_strategy*
String
Indicates what to do with duplicate texts in this request. Must be one of “merge”, “keep_first” or “keep_last”.
Required
existing_duplicates_strategy*
String
Indicates what to do with texts of this request that already exist in the model. Must be one of “overwrite” or “ignore”.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


UploadWorkflowData

uploadWorkflowData

Uploads data to be processed to a workflow. This will create a new batch and will return its batch_id. MonkeyLearn will then asynchronously run all the steps of the workflow and record the output. This output can be accessed using the List Data endpoint.


/v3/workflows/{MODEL_ID}/data

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadWorkflowDataApi;

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

public class UploadWorkflowDataApiExample {

    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");

        UploadWorkflowDataApi apiInstance = new UploadWorkflowDataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        array[data_5] data = ; // array[data_5] | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            inline_response_200_12 result = apiInstance.uploadWorkflowData(apiecoKey, mODELID, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadWorkflowDataApi#uploadWorkflowData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadWorkflowDataApi;

public class UploadWorkflowDataApiExample {

    public static void main(String[] args) {
        UploadWorkflowDataApi apiInstance = new UploadWorkflowDataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        array[data_5] data = ; // array[data_5] | Accepts parameters in the request body as a JSON with the following attributes:
        try {
            inline_response_200_12 result = apiInstance.uploadWorkflowData(apiecoKey, mODELID, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadWorkflowDataApi#uploadWorkflowData");
            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 *mODELID = mODELID_example; // 
array[data_5] *data = ; // Accepts parameters in the request body as a JSON with the following attributes:

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

// 
[apiInstance uploadWorkflowDataWith:apiecoKey
    mODELID:mODELID
    data:data
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.UploadWorkflowDataApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 

var data = ; // {array[data_5]} Accepts parameters in the request body as a JSON with the following attributes:


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadWorkflowData(apiecoKey, mODELID, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadWorkflowDataExample
    {
        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 UploadWorkflowDataApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 
            var data = new array[data_5](); // array[data_5] | Accepts parameters in the request body as a JSON with the following attributes:

            try
            {
                // 
                inline_response_200_12 result = apiInstance.uploadWorkflowData(apiecoKey, mODELID, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadWorkflowDataApi.uploadWorkflowData: " + 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\UploadWorkflowDataApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 
$data = ; // array[data_5] | Accepts parameters in the request body as a JSON with the following attributes:

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

# 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::UploadWorkflowDataApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 
my $data = [WWW::SwaggerClient::Object::array[data_5]->new()]; # array[data_5] | Accepts parameters in the request body as a JSON with the following attributes:

eval { 
    my $result = $api_instance->uploadWorkflowData(apiecoKey => $apiecoKey, mODELID => $mODELID, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadWorkflowDataApi->uploadWorkflowData: $@\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.UploadWorkflowDataApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 
data =  # array[data_5] | Accepts parameters in the request body as a JSON with the following attributes:

try: 
    # 
    api_response = api_instance.upload_workflow_data(apiecoKey, mODELID, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadWorkflowDataApi->uploadWorkflowData: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Successful

Status: 405 - Invalid input


WorkflowDetail

workflowdetail

Returns information about a workflow including its steps and custom fields.


/v3/workflows/{MODEL_ID}

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/monkeylearn/v3/workflows/{MODEL_ID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowDetailApi;

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

public class WorkflowDetailApiExample {

    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");

        WorkflowDetailApi apiInstance = new WorkflowDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            inline_response_200_9 result = apiInstance.workflowdetail(apiecoKey, mODELID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowDetailApi#workflowdetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowDetailApi;

public class WorkflowDetailApiExample {

    public static void main(String[] args) {
        WorkflowDetailApi apiInstance = new WorkflowDetailApi();
        String apiecoKey = apiecoKey_example; // String | 
        String mODELID = mODELID_example; // String | 
        try {
            inline_response_200_9 result = apiInstance.workflowdetail(apiecoKey, mODELID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowDetailApi#workflowdetail");
            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 *mODELID = mODELID_example; // 

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

// 
[apiInstance workflowdetailWith:apiecoKey
    mODELID:mODELID
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MonkeyLearnApiDocumentation = require('monkey_learn_api_documentation');
var defaultClient = MonkeyLearnApiDocumentation.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 MonkeyLearnApiDocumentation.WorkflowDetailApi()

var apiecoKey = apiecoKey_example; // {String} 

var mODELID = mODELID_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.workflowdetail(apiecoKey, mODELID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class workflowdetailExample
    {
        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 WorkflowDetailApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var mODELID = mODELID_example;  // String | 

            try
            {
                // 
                inline_response_200_9 result = apiInstance.workflowdetail(apiecoKey, mODELID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowDetailApi.workflowdetail: " + 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\WorkflowDetailApi();
$apiecoKey = apiecoKey_example; // String | 
$mODELID = mODELID_example; // String | 

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

# 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::WorkflowDetailApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $mODELID = mODELID_example; # String | 

eval { 
    my $result = $api_instance->workflowdetail(apiecoKey => $apiecoKey, mODELID => $mODELID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowDetailApi->workflowdetail: $@\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.WorkflowDetailApi()
apiecoKey = apiecoKey_example # String | 
mODELID = mODELID_example # String | 

try: 
    # 
    api_response = api_instance.workflowdetail(apiecoKey, mODELID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowDetailApi->workflowdetail: %s\n" % e)

Parameters

Path parameters
Name Description
MODEL_ID*
String
Required
Header parameters
Name Description
apieco-key*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input