List audit events
curl --request GET \
--url https://guidinghand.ai/v1/audit_events \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://guidinghand.ai/v1/audit_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/audit_events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"object": "audit_event",
"id": "<string>",
"action": "agent.published",
"object_type": "agent",
"object_id": "billing",
"target": "<string>",
"data": {},
"actor": {
"type": "user",
"user_id": "<string>",
"email": "jane@acme.com",
"name": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}Audit log
List audit events
Who did what in the org, newest first: people, API keys, agents (their file writes during a task), the person at the computer and GuidingHand itself. Needs the admin role or an API key. For one object’s history, send object_type and object_id: an agent’s includes its files’, and a session’s its tasks’.
GET
/
v1
/
audit_events
List audit events
curl --request GET \
--url https://guidinghand.ai/v1/audit_events \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://guidinghand.ai/v1/audit_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/audit_events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"object": "audit_event",
"id": "<string>",
"action": "agent.published",
"object_type": "agent",
"object_id": "billing",
"target": "<string>",
"data": {},
"actor": {
"type": "user",
"user_id": "<string>",
"email": "jane@acme.com",
"name": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}Authorizations
An org API key (gh_live_…) from Settings → API keys in the console.
Query Parameters
Only events about this kind of object.
Available options:
agent, file, session, task, key, member, invite, webhook, org, billing With object_type: only this object’s events, such as an agent’s agent_id or a session’s code.
Only events by this kind of actor.
Available options:
user, api_key, agent, customer, session, system How many to return, 1 to 100.
Required range:
1 <= x <= 100next_cursor from the previous page.