Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
Represents a single audit log entry tracking a change or action performed on a resource within the system.

Properties

id string required

Unique identifier for the audit log entry. Format: log_ followed by alphanumeric characters.


timestamp string required

ISO 8601 timestamp when the action occurred.


resourceType string required

Type of resource that was modified. Values: assistant, thread, vector_store, rule, mcp_configuration, user, organization.


resourceId string required

Unique identifier of the resource that was modified.


resourceName string optional

Human-readable name of the resource at the time of the action.


action string required

Action that was performed. Values: created, updated, deleted, accessed, shared, archived, restored.


userId string required

Unique identifier of the user who performed the action.


userName string optional

Full name of the user who performed the action.


userEmail string optional

Email address of the user who performed the action.


changes array optional

Array of field-level changes. Empty for created and deleted actions.

Show properties

Each change object contains:

    field string required

    Name of the field that changed. Uses dot notation for nested fields (e.g., tools.webSearch).

    oldValue any optional

    Previous value of the field. Can be string, number, boolean, object, or array.

    newValue any optional

    New value of the field. Can be string, number, boolean, object, or array.


metadata object optional

Additional context about the action.

Show properties

    ipAddress string optional

    IP address from which the action was performed.

    userAgent string optional

    User agent string of the client that performed the action.

    source string optional

    Source of the action. Values: web_ui, api, system, automation.

    apiKeyId string optional

    API key ID if the action was performed via API.

    sessionId string optional

    Session ID if the action was performed via web UI.

Usage

This object is returned by:

{
  "id": "log_abc123",
  "timestamp": "2025-01-20T10:30:00Z",
  "resourceType": "assistant",
  "resourceId": "asst_abc123",
  "resourceName": "Customer Support Bot",
  "action": "updated",
  "userId": "uid_user123",
  "userName": "John Doe",
  "userEmail": "john@example.com",
  "changes": [
    {
      "field": "temperature",
      "oldValue": 0.7,
      "newValue": 0.9
    },
    {
      "field": "tools.webSearch",
      "oldValue": false,
      "newValue": true
    },
    {
      "field": "instructions",
      "oldValue": "You are a helpful assistant.",
      "newValue": "You are a helpful customer support assistant specialized in billing inquiries."
    },
    {
      "field": "vectorStoreIds",
      "oldValue": [],
      "newValue": ["vs_abc123", "vs_def456"]
    }
  ],
  "metadata": {
    "ipAddress": "192.168.1.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
    "source": "web_ui",
    "sessionId": "sess_xyz789"
  }
}