Read the organisation AI pause switch (ai.manage)
import requests
url = "https://platform.ankra.app/api/v1/org/ai-settings/pause"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/ai-settings/pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/ai-settings/pause \
--header 'Authorization: Bearer <token>'{
"paused": true,
"paused_by": "<string>",
"paused_at": "<string>",
"reason": "<string>",
"paused_through": {
"credential": "<string>",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_outside_projects": true
},
"cancelled_sessions": 123,
"cancelled_task_runs": 123,
"expired_pending_actions": 123
}AI Management
Read the organisation AI pause switch (ai.manage)
Returns the organisation’s AI kill switch: whether all AI is paused, who paused it, when and why. Requires ai.manage.
GET
/
api
/
v1
/
org
/
ai-settings
/
pause
Read the organisation AI pause switch (ai.manage)
import requests
url = "https://platform.ankra.app/api/v1/org/ai-settings/pause"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/ai-settings/pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/ai-settings/pause \
--header 'Authorization: Bearer <token>'{
"paused": true,
"paused_by": "<string>",
"paused_at": "<string>",
"reason": "<string>",
"paused_through": {
"credential": "<string>",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_outside_projects": true
},
"cancelled_sessions": 123,
"cancelled_task_runs": 123,
"expired_pending_actions": 123
}Authorizations
Response
Success
The credential the pause was engaged through: credential is how the principal authenticated (human, token, service_account, ai_lane, platform_staff, support_session or unknown) and project_id the project it was held to, null when it reached the whole organisation. A reader held to one project does not read another project's id: project_id is then null and project_outside_projects true, which never means organisation-wide. Null when the organisation is not paused, and when the pause was engaged before Ankra recorded the credential (not recorded, never organisation-wide).
Show child attributes
Show child attributes