Legal Karma

Automations

getAutomations

Get list of automations

Retrieve a list of automations

Get

/automations

Usage and SDK Samples

Copied to clipboard!


curl -X GET\
-H "X-API-key: [[apiKey]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/ilikeswagger/lktest/1.0/automations"

Copied to clipboard!


import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationsApi;

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

public class AutomationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: APIKey
        ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
        APIKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //APIKey.setApiKeyPrefix("Token");

        AutomationsApi apiInstance = new AutomationsApi();
        try {
            AutomationList result = apiInstance.getAutomations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationsApi#getAutomations");
            e.printStackTrace();
        }
    }
}

Copied to clipboard!


import io.swagger.client.api.AutomationsApi;

public class AutomationsApiExample {

    public static void main(String[] args) {
        AutomationsApi apiInstance = new AutomationsApi();
        try {
            AutomationList result = apiInstance.getAutomations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationsApi#getAutomations");
            e.printStackTrace();
        }
    }
}

Copied to clipboard!


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

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

// Get list of automations
[apiInstance getAutomationsWithCompletionHandler: 
              ^(AutomationList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Copied to clipboard!


var LegalKarmaDocumentAutomationApi = require('legal_karma_document_automation_api');
var defaultClient = LegalKarmaDocumentAutomationApi.ApiClient.instance;

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

var api = new LegalKarmaDocumentAutomationApi.AutomationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAutomations(callback);

Copied to clipboard!


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

namespace Example
{
    public class getAutomationsExample
    {
        public void main()
        {

            // Configure API key authorization: APIKey
            Configuration.Default.ApiKey.Add("X-API-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-key", "Bearer");

            var apiInstance = new AutomationsApi();

            try
            {
                // Get list of automations
                AutomationList result = apiInstance.getAutomations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationsApi.getAutomations: " + e.Message );
            }
        }
    }
}

Copied to clipboard!


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

$api_instance = new Swagger\Client\ApiAutomationsApi();

try {
    $result = $api_instance->getAutomations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationsApi->getAutomations: ', $e->getMessage(), PHP_EOL;
}
?>

Copied to clipboard!


use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationsApi;

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

my $api_instance = WWW::SwaggerClient::AutomationsApi->new();

eval { 
    my $result = $api_instance->getAutomations();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationsApi->getAutomations: $@\n";
}

Copied to clipboard!


from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AutomationsApi()

try: 
    # Get list of automations
    api_response = api_instance.get_automations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationsApi->getAutomations: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Schema

AutomationList[
A list of available document automations
{

id:

string
The unique ID for the automation. Use this ID when working with a single automation, e.g. for generating a document.

name:

string
The name of the document automation provided by the user.

created:

string (date-time)
The date and time the automation was created. All timestamps are in UTC.

}
]

getAutomationsAutomationId

Get one automation by id

Retrieve details for a single automation by its id

Get

/automations/{automation-id}

Usage and SDK Samples

Copied to clipboard!


curl -X GET\
-H "X-API-key: [[apiKey]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/ilikeswagger/lktest/1.0/automations/{automation-id}"

Copied to clipboard!


import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationsApi;

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

public class AutomationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: APIKey
        ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
        APIKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //APIKey.setApiKeyPrefix("Token");

        AutomationsApi apiInstance = new AutomationsApi();
        String automationId = automationId_example; // String | id of an existing automation
        try {
            Automation result = apiInstance.getAutomationsAutomationId(automationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationsApi#getAutomationsAutomationId");
            e.printStackTrace();
        }
    }
}

Copied to clipboard!


import io.swagger.client.api.AutomationsApi;

public class AutomationsApiExample {

    public static void main(String[] args) {
        AutomationsApi apiInstance = new AutomationsApi();
        String automationId = automationId_example; // String | id of an existing automation
        try {
            Automation result = apiInstance.getAutomationsAutomationId(automationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationsApi#getAutomationsAutomationId");
            e.printStackTrace();
        }
    }
}

Copied to clipboard!


Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: APIKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-key"];
String *automationId = automationId_example; // id of an existing automation

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

// Get one automation by id
[apiInstance getAutomationsAutomationIdWith:automationId
              completionHandler: ^(Automation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Copied to clipboard!


var LegalKarmaDocumentAutomationApi = require('legal_karma_document_automation_api');
var defaultClient = LegalKarmaDocumentAutomationApi.ApiClient.instance;

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

var api = new LegalKarmaDocumentAutomationApi.AutomationsApi()
var automationId = automationId_example; // {{String}} id of an existing automation

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

Copied to clipboard!


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

namespace Example
{
    public class getAutomationsAutomationIdExample
    {
        public void main()
        {

            // Configure API key authorization: APIKey
            Configuration.Default.ApiKey.Add("X-API-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-key", "Bearer");

            var apiInstance = new AutomationsApi();
            var automationId = automationId_example;  // String | id of an existing automation

            try
            {
                // Get one automation by id
                Automation result = apiInstance.getAutomationsAutomationId(automationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationsApi.getAutomationsAutomationId: " + e.Message );
            }
        }
    }
}

Copied to clipboard!


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

$api_instance = new Swagger\Client\ApiAutomationsApi();
$automationId = automationId_example; // String | id of an existing automation

try {
    $result = $api_instance->getAutomationsAutomationId($automationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationsApi->getAutomationsAutomationId: ', $e->getMessage(), PHP_EOL;
}
?>

Copied to clipboard!


use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationsApi;

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

my $api_instance = WWW::SwaggerClient::AutomationsApi->new();
my $automationId = automationId_example; # String | id of an existing automation

eval { 
    my $result = $api_instance->getAutomationsAutomationId(automationId => $automationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationsApi->getAutomationsAutomationId: $@\n";
}

Copied to clipboard!


from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AutomationsApi()
automationId = automationId_example # String | id of an existing automation

try: 
    # Get one automation by id
    api_response = api_instance.get_automations_automation_id(automationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationsApi->getAutomationsAutomationId: %s\n" % e)

Parameters

Path parameters

Name

automation-id*

Description

String
id of an existing automation
‍Required

Responses

Status: 200 - OK

Schema

{

id:

string
The unique ID for the automation. Use this ID when working with a single automation, e.g. for generating a document.

name:

string (date-time)
The name of the document automation provided by the user.

created:

string
The date and time the automation was created. All timestamps are in UTC.

questions:

[
The list of questions associated with this automation.

{

answerId:

string
Questions may have an optional answer ID. For API clients, answerId values may be specified by the automation author to make it easier to identify the proper data source from which to supply the answer.
Unlike questionNumber, which changes when the user reorders questions in the automation editor, answerIds are only changed by the automation author.
Example: A developer may choose to write questions for a document automation where each questionTag identifies the database table and column from which the answer should be retrieved (e.g. person.first_name).‍

questionNumber:

string
The question number as it appears in the Legal Karma automation editor, such as Q1, Q7, etc. When referencing questions by their question number, the "Q" is not case sensitive.

questionOptions:

{

choices:

[
For questionType = "multiple", this is a list of the valid answers. The choices are case-sensitive.
string
]

minRequired:

number
If specified, indicates the minimum number of answers required for this question. Questions which are optional will have a value 0 for minRequired.If minRequired is not present, it defaults to 1.‍

maxAllowed:

number
For questionType "multiple", this indicates the maximum number of choices allowed in the answer. If not present, the default value is 1 (i.e. single select, not multi-select).When an answer contains multiple choices, they should be provided as a single string with comma-separated values.‍

digitsOnly:

boolean
For questionType "short", if digitsnly is true, only digits are allowed in the answer. If absent, defaults to false.‍

}

questionPrompt:

string
The prompt shown to the user when requesting an answer. API users may use the questionPrompt in their own user-facing UI to request answers, or may disregard the questionPrompt if all answers will be supplied programmatically.

questionType:

string
questionType is either "short", "multiple", or "date". See the questionOptions to understand what options apply to each questionType.
Enum: short , multiple , date

repeating:

boolean
When true, the automation supports a list of answers for this question (e.g. children's names).
When omitted or false, only a single answer is expected and any additional answers will have no effect on the generated document.
Note that answers are always required to be a list of strings in the JSON object. When repeating is false, this should be a list with one element.

}
]
}

Status: 404 - Not Found

postAutomationsAutomationIdGenerate

Generate a document from an automation

Generate a Word document from an automation using the provided answers.

Post

/automations/{automation-id}/generate

Usage and SDK Samples

Copied to clipboard!


curl -X POST\
-H "X-API-key: [[apiKey]]"\
-H "Accept: application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/ilikeswagger/lktest/1.0/automations/{automation-id}/generate"

Copied to clipboard!


import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationsApi;

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

public class AutomationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: APIKey
        ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
        APIKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //APIKey.setApiKeyPrefix("Token");

        AutomationsApi apiInstance = new AutomationsApi();
        String automationId = automationId_example; // String | The ID of the document automation to use
        Automationid_generate_body body = ; // Automationid_generate_body | 
        try {
            Object result = apiInstance.postAutomationsAutomationIdGenerate(automationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationsApi#postAutomationsAutomationIdGenerate");
            e.printStackTrace();
        }
    }
}

Copied to clipboard!


import io.swagger.client.api.AutomationsApi;

public class AutomationsApiExample {

    public static void main(String[] args) {
        AutomationsApi apiInstance = new AutomationsApi();
        String automationId = automationId_example; // String | The ID of the document automation to use
        Automationid_generate_body body = ; // Automationid_generate_body | 
        try {
            Object result = apiInstance.postAutomationsAutomationIdGenerate(automationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationsApi#postAutomationsAutomationIdGenerate");
            e.printStackTrace();
        }
    }
}

Copied to clipboard!


Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: APIKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-key"];
String *automationId = automationId_example; // The ID of the document automation to use
Automationid_generate_body *body = ; //  (optional)

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

// Generate a document from an automation
[apiInstance postAutomationsAutomationIdGenerateWith:automationId
    body:body
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Copied to clipboard!


var LegalKarmaDocumentAutomationApi = require('legal_karma_document_automation_api');
var defaultClient = LegalKarmaDocumentAutomationApi.ApiClient.instance;

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

var api = new LegalKarmaDocumentAutomationApi.AutomationsApi()
var automationId = automationId_example; // {{String}} The ID of the document automation to use
var opts = { 
  'body':  // {{Automationid_generate_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAutomationsAutomationIdGenerate(automationId, opts, callback);

Copied to clipboard!


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

namespace Example
{
    public class postAutomationsAutomationIdGenerateExample
    {
        public void main()
        {

            // Configure API key authorization: APIKey
            Configuration.Default.ApiKey.Add("X-API-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-key", "Bearer");

            var apiInstance = new AutomationsApi();
            var automationId = automationId_example;  // String | The ID of the document automation to use
            var body = new Automationid_generate_body(); // Automationid_generate_body |  (optional) 

            try
            {
                // Generate a document from an automation
                Object result = apiInstance.postAutomationsAutomationIdGenerate(automationId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationsApi.postAutomationsAutomationIdGenerate: " + e.Message );
            }
        }
    }
}

Copied to clipboard!


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

$api_instance = new Swagger\Client\ApiAutomationsApi();
$automationId = automationId_example; // String | The ID of the document automation to use
$body = ; // Automationid_generate_body | 

try {
    $result = $api_instance->postAutomationsAutomationIdGenerate($automationId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationsApi->postAutomationsAutomationIdGenerate: ', $e->getMessage(), PHP_EOL;
}
?>

Copied to clipboard!


use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationsApi;

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

my $api_instance = WWW::SwaggerClient::AutomationsApi->new();
my $automationId = automationId_example; # String | The ID of the document automation to use
my $body = WWW::SwaggerClient::Object::Automationid_generate_body->new(); # Automationid_generate_body | 

eval { 
    my $result = $api_instance->postAutomationsAutomationIdGenerate(automationId => $automationId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationsApi->postAutomationsAutomationIdGenerate: $@\n";

Copied to clipboard!


from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AutomationsApi()
automationId = automationId_example # String | The ID of the document automation to use
body =  # Automationid_generate_body |  (optional)

try: 
    # Generate a document from an automation
    api_response = api_instance.post_automations_automation_id_generate(automationId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationsApi->postAutomationsAutomationIdGenerate: %s\n" % e)

Parameters

Path parameters

Name

automation-id*

Description

String
id of an existing automation
‍Required

Body parameters

Name

body

Description

{

questionAnswers:

[
The list of answers to be used to generate the Word document from the automation.
The list of questions with their questionNumber and answerId values can be retrieved by getting a single automation by ID.
This array is optional if no answers are required by the automation, e.g. when the only dynamic content is an auto-populated date.
{

questionNumber:

string
One of the questionNumber or answerId must be supplied, but not both.
The questionNumber, e.g. "Q15". This field is not case sensitive.

answerId:

string
One of the questionNumber or answerId must be supplied, but not both.
The answerId associated with the question for this answer. answerId values are case sensitive.

answers:

[
The answer(s) for the specified question.
This must always be an array, even if it contains one element. Multiple array elements are applied in repeated elements within a document automation.
Answers are not required for every question. For example, if parts of a document are not applicable and will nto be included in the generated Word document due to conditions specified in the automation. Answers that are used in such omitted sections do not need to be supplied.
string
]

}
]

removeHighlights:

[
If present, highlights in the specified colors are removed from the Word document before it is generated.
string
Enum: yellow , green , cyan , magenta, blue , red , darkBlue , darkCyan , darkGreen , darkMagenta , darkRed , darkYellow , darkGrey , lightGrey , black
]

removeComments:

boolean
If present and true, comments are removed from the Word document before it is generated.

download:

boolean
If true, the response will be the generated document as a file attachment.
If omitted or false, the response will be a GeneratedDocumentInfo in JSON format.

}

Responses

Status: 200 - OK

Schema

GeneratedDocumentInfo {

filename:

string
The filename of the generated document, e.g. "Non-disclosure Agreement.docx"

generatedFileId:

string
The unique ID of the generated document. For future use.

url:

string (date-time)
The URL where the document may be downloaded.
Please note this URL is publicly-acccessible; anyone with the URL can retrieve the document. Please take appropriate security measures.
The URL is valid for a limited time. After generating a document, it should be downloaded immediately. This URL is not appropriate for long term storage.

}

Status: 400 - Bad Request

Schema

message:

string
Reason for document generation failure

}

Status: 401 - Unauthorized

Status: 404 - Automation Not Found

For Developers

Legal Karma Document Automation API

This API allows you to use Legal Karma's powerful
document automation from your own code.

Automations

getAutomations

getAutomationsAutomationId

postAutomationsAutomationIdGenerate

See for yourself

For Developers

Legal Karma Document Automation API

This API allows you to use Legal Karma's powerfuldocument automation from your own code.

Automations

getAutomations

getAutomationsAutomationId

postAutomationsAutomationIdGenerate

See for yourself

This API allows you to use Legal Karma's powerful
document automation from your own code.