All pages

API reference

List audit events

GET /v1/audit-events

View as Markdown

Everything people and API keys did in the organization, oldest first: the console's audit log. Keep the last page's next_cursor and ask again later for what was done since. Events from the last minute wait for the next page. Kept 365 days. Needs audit:read and a key that reaches every project; a test key reads none.

Parameters

Name In Type Required Description
action query array of string or null No An action, like agent.published. Repeatable.
created_after query string (date-time) or null No Only events from this time on.
limit query integer No How many to return, 1 to 100.
cursor query string or null No next_cursor from the previous page, with the same filters.

Answer

200 with AuditEventList.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Read the audit log
#!/bin/sh
# Read the audit log. With a live key that reaches every project. Keep the last page's `next_cursor`.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/audit-events?action=agent.published" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.