@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Automata Market Intelligence API
@base https://api.byautomata.io/
@version 1.0.1
@auth ApiKey x-api-key in header
@endpoints 4
@toc similar(1), search(1), contentpro-similar-text(1), contentpro-search(1)

@group similar
@endpoint GET /similar
@desc Send a company website to receive a list of companies related to them.
@required {link: map # We'll provide information about related companies based on the site you provide. If a LinkedIn page is sent, we will try to identify the company related to the page. Ex. https://api.byautomata.io/similar?link=ibm.com}
@optional {page: map # Page number of search results. Ex. https://api.byautomata.io/similar?link=ibm.com&page=1}
@returns(200) A successful operation
@errors {400: Your request was not valid. Please refer to the API documentation https://api-specs.byautomata.io., 403: Invalid API Key. Please refer to the API documentation https://api-specs.byautomata.io., 501: There was a server error. Please try again later or contact support@byautomata.io}

@endgroup

@group search
@endpoint GET /search
@desc Send search terms to receive the most relevant companies along with text snippets.
@required {terms: map # We provide information about related companies based on the search terms you provide. Separate search terms with commas. Ex. https://api.byautomata.io/search?link=cloud+computing,enterprise,security}
@optional {page: map # Page number of search results. Ex. https://api.byautomata.io/search?page=0&link=cloud+computing,enterprise,security}
@returns(200) A successful operation
@errors {400: Your request was not valid. Please refer to the API documentation https://api-specs.byautomata.io., 403: Invalid API Key. Please refer to the API documentation https://api-specs.byautomata.io., 501: There was a server error. Please try again later or contact support@byautomata.io}

@endgroup

@group contentpro-similar-text
@endpoint POST /contentpro-similar-text
@desc The /contentpro-similar-text endpoint accepts and arbitrary piece of text and returns similar articles and blogs written by companies.
@required {text: str # Any piece of text}
@returns(200) A successful operation
@errors {400: Your request was not valid. Please refer to the API documentation https://api-specs.byautomata.io., 403: Invalid API Key. Please refer to the API documentation https://api-specs.byautomata.io., 501: There was a server error. Please try again later or contact support@byautomata.io}

@endgroup

@group contentpro-search
@endpoint GET /contentpro-search
@desc Send search terms to receive the most relevant articles and companies.
@required {terms: map # We provide information about related companies and articles based on the search terms you provide. Separate search terms with commas. Ex. https://api.byautomata.io/contentpro-search?terms=cloud+computing,enterprise,security}
@returns(200) A successful operation
@errors {400: Your request was not valid. Please refer to the API documentation https://api-specs.byautomata.io., 403: Invalid API Key. Please refer to the API documentation https://api-specs.byautomata.io., 501: There was a server error. Please try again later or contact support@byautomata.io}

@endgroup

@end