Skip to main content
POST
/
v1
/
logging
Push logs
curl --request POST \
  --url https://api.getmaxim.ai/v1/logging \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '"<any>"'
{
  "success": true,
  "entity": "<string>",
  "action": "<string>",
  "entityId": "<string>"
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
  • Trace: Start
  • Trace: End
  • Trace: Add Generation
  • Trace: Add Input
  • Trace: Add Span
  • Trace: Add Metadata
  • Trace: Add Event
  • Trace: Add Feedback
  • Trace: Add Retrieval
  • Trace: Add Tag
  • Trace: Add Tool Call
  • Trace: Add Output
  • Trace: Evaluate
  • Trace: Add Metric
  • Trace: Add to Session
  • Session: Create
  • Session: End
  • Session: Add Trace
  • Session: Add Feedback
  • Session: Add Tag
  • Session: Evaluate
  • Session: Add Metric
  • Generation: Add Trace Generation
  • Generation: Add Span Generation
  • Generation: Add Message
  • Generation: End
  • Generation: Error
  • Generation: Evaluate
  • Generation: Add Metadata
  • Generation: Add Result
  • Generation: Set Model
  • Generation: Set Model Parameters
  • Generation: Add Tag
  • Generation: Add Metric
  • Span: Add Trace Span
  • Span: End
  • Span: Evaluate
  • Span: Add Event
  • Span: Add Generation
  • Span: Add Metadata
  • Span: Add Retrieval
  • Span: Add Span
  • Span: Add Tool Call
  • Span: Add Tag
  • Span: Add Error
  • Retrieval: Add Tag
  • Retrieval: Add Metadata
  • Retrieval: Add Input
  • Retrieval: Add Output
  • Retrieval: End
  • Retrieval: Evaluate
  • Retrieval: Add Metric
  • ToolCall: Add Error
  • ToolCall: Add Metadata
  • ToolCall: Add Result
  • ToolCall: Add Tag
repoId
string
required

Unique identifier for the repository

entity
enum<string>
required
Available options:
trace
action
enum<string>
required
Available options:
start
entityId
string
required

Unique identifier for the trace.

data
object
required

Response

Successfully logged message

success
boolean

Success status

entity
string

Entity type

action
string

Action performed

entityId
string

Unique identifier for the entity