Every request goes to your tenant’s own host, https://<tenant id>.atlanticagenticlabs.com, and is scoped to that tenant by row-level security. The examples read AAL_TENANT, AAL_KEY and your Access service token from the environment: see Authentication.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
agent_id
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
201
Created: the new resource, as JSON.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
cid
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
cid
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
cid
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
cid
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
connector
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
connector
path
string
yes
Status
Meaning
201
Created: the new resource, as JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
connector
path
string
yes
Status
Meaning
201
Created: the new resource, as JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
connector
path
string
yes
Status
Meaning
201
Created: the new resource, as JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
user_code
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
index
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
kind
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
201
Created: the new resource, as JSON.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
rid
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
run_id_hash
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
run_id_hash
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
run_id_hash
path
string
yes
Status
Meaning
200
OK: the JSON document this route reads.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Parameter
In
Type
Required
step
path
string
yes
Status
Meaning
200
OK: the request was carried out. The answer is JSON.
400
Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.
Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).
Status
Meaning
200
OK: the JSON document this route reads.
4XX
Refused: {error, message} with a fixed error code, listed under Errors.