Skip to main content
SONZAI
Api

Events

Trigger a game event

POST
/agents/{agentId}/events
AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

Agent UUID or URL-encoded agent name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

curl -X POST "https://loading/api/v1/agents/string/events" \  -H "Content-Type: application/json" \  -d '{    "event_type": "string",    "user_id": "string"  }'
{
  "$schema": "/api/v1/schemas/TriggerEventOutputBody.json",
  "accepted": true,
  "event_id": "string"
}
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}