Events API

The Events API allows you to send LLM usage data to our platform for tracking and analysis. This data is used to generate detailed analytics on token consumption, costs, and user statistics.

Endpoint

POST /v1/events

Authorization

All requests must include a Bearer token in the Authorization header:

Authorization: Bearer <your-application-token>

Request Payload

The payload must conform to the following schema:

Payload Schema

{
  "appId": "string", // Required. Application ID registered on the platform.
  "eventType": "text_gen", // Required. Currently only 'text_gen' is supported.
  "consumerId": "string", // Optional. Identifier of the consumer (e.g., user ID or email).
  "inputTokens": "number", // Required. Positive integer indicating the number of input tokens.
  "inputTokensCached": "number", // Optional. Positive integer indicating cached input tokens.
  "outputTokens": "number" // Required. Positive integer indicating the number of output tokens.
}

Field Descriptions

  • appId (string, required):
    • The unique identifier for your application. This field is mandatory.
    • Validation: Must be a non-empty string.

  • eventType (enum, required):

    • Specifies the type of event. Currently, only text_gen is supported.
    • Enumeration values:
      • text_gen: Represents events related to text generation operations.

  • consumerId (string, optional):

    • A unique identifier for the consumer of the LLM event. This could be an internal user ID or an email address.
    • Used to provide statistics, such as top consumers.

  • inputTokens (number, required):

    • The number of input tokens used in the event.
    • Validation: Must be a positive integer.

  • inputTokensCached (number, optional):

    • The number of cached input tokens.
    • Validation: Must be a positive integer.

  • outputTokens (number, required):

    • The number of output tokens generated.
    • Validation: Must be a positive integer.

Example Request

POST /v1/events HTTP/1.1
Host: api.affordai.io
Authorization: Bearer <your-application-token>
Content-Type: application/json

{
  "appId": "your-application-id",
  "eventType": "text_gen",
  "consumerId": "user@example.com",
  "inputTokens": 500,
  "inputTokensCached": 100,
  "outputTokens": 300
}

Response

Successful Response

  • Status: 202 Accepted
  • Body: {} (empty body)

Error Response

  • Status: Varies (e.g., 400 Bad Request)
  • Body:
{
  "error": "<code>",
  "message": "<error-message>"
}

Example:

{
  "error": "validation_error",
  "message": "appId: Required; inputTokens: inputTokens must be a positive integer."
}