Log to an Agent

Create an Agent Log.

You can use query parameters version_id, or environment, to target an existing version of the Agent. Otherwise, the default deployed version will be chosen.

If you create the Agent Log with a log_status of incomplete, you should later update it to complete in order to trigger Evaluators.

Headers

X-API-KEYstringRequired

Query parameters

version_idstringOptional
A specific Version ID of the Agent to log to.
environmentstringOptional
Name of the Environment identifying a deployed version to log to.

Request

This endpoint expects an object.
run_idstringOptional
Unique identifier for the Run to associate the Log to.
pathstringOptional

Path of the Agent, including the name. This locates the Agent in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name or just name.

idstringOptional
ID for an existing Agent.
output_messageobjectOptional
The message returned by the provider.
prompt_tokensintegerOptional
Number of tokens in the prompt used to generate the output.
reasoning_tokensintegerOptional
Number of reasoning tokens used to generate the output.
output_tokensintegerOptional
Number of tokens in the output generated by the model.
prompt_costdoubleOptional
Cost in dollars associated to the tokens in the prompt.
output_costdoubleOptional
Cost in dollars associated to the tokens in the output.
finish_reasonstringOptional
Reason the generation finished.
messageslist of objectsOptional
The messages passed to the to provider chat endpoint.
tool_choice"none" or "auto" or "required" or objectOptional

Controls how the model uses tools. The following options are supported:

  • 'none' means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.
  • 'auto' means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.
  • 'required' means the model must call one or more of the provided tools.
  • {'type': 'function', 'function': {name': <TOOL_NAME>}} forces the model to use the named function.
agentobject or stringOptional

The Agent configuration to use. Two formats are supported:

  • An object representing the details of the Agent configuration
  • A string representing the raw contents of a .agent file

A new Agent version will be created if the provided details do not match any existing version.

start_timedatetimeOptional
When the logged event started.
end_timedatetimeOptional
When the logged event ended.
outputstringOptional

Generated output from your model for the provided inputs. Can be None if logging an error, or if creating a parent Log with the intention to populate it later.

created_atdatetimeOptional
User defined timestamp for when the log was created.
errorstringOptional
Error message if the log is an error.
provider_latencydoubleOptional
Duration of the logged event in seconds.
stdoutstringOptional
Captured log and debug statements.
provider_requestmap from strings to anyOptional
Raw request sent to provider.
provider_responsemap from strings to anyOptional
Raw response received the provider.
inputsmap from strings to anyOptional
The inputs passed to the prompt template.
sourcestringOptional
Identifies where the model was called from.
metadatamap from strings to anyOptional
Any additional metadata to record.
source_datapoint_idstringOptional

Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.

trace_parent_idstringOptional
The ID of the parent Log to nest this Log under in a Trace.
userstringOptional

End-user ID related to the Log.

environmentstringOptional
The name of the Environment the Log is associated to.
savebooleanOptionalDefaults to true

Whether the request/response payloads will be stored on Humanloop.

log_idstringOptional
This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.

Response

Successful Response
idstring
Unique identifier for the Log.
agent_idstring
Unique identifier for the Agent.
version_idstring
Unique identifier for the Agent Version.
log_statusenumOptional

Status of the Agent Log. When a Agent Log is marked as complete, no more Logs can be added to it.

Allowed values:

Errors