Generated by API Evangelist
Written by API Evangelist tooling for Automation Anywhere's API. It is a proposal applied on top of the contract, not a document Automation Anywhere publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Automation Anywhere Control Room Authentication API
version: 1.0.0
extends: openapi/automation-anywhere-authentication-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v2/authentication'].post
update:
x-apievangelist-phrasing:
intent: Log in and get a JWT for the Control Room API
effect: write
questions:
- How do I get an access token to call the Automation Anywhere Control Room API?
- Can I sign in to the Control Room API with an API key instead of a password?
- How long does the JWT from logging in stay valid?
instructions:
- text: Authenticate as {username} with API key {apiKey} and return a JWT.
slots:
username: requestBody.username
apiKey: requestBody.apiKey
- text: Log in to the Control Room as {username} using password {password}.
slots:
username: requestBody.username
password: requestBody.password
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/authentication/token'].get
update:
x-apievangelist-phrasing:
intent: Check whether a JWT is still valid
effect: read
questions:
- Is my current Control Room JWT still valid or has it expired?
- Can I verify a session token before making further API calls?
instructions:
- text: Check whether my current Control Room token is still valid.
- text: Validate the JWT {token}.
slots:
token: query.token
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/authentication/logout'].post
update:
x-apievangelist-phrasing:
intent: Log out and invalidate the current JWT
effect: destructive
questions:
- Can I immediately invalidate my API token when my script finishes?
- What happens to my JWT after I end the Control Room API session?
instructions:
- text: Log me out of the Control Room API and invalidate my token.
- text: End the current API session so the JWT can no longer be used.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.