agents

Call Agent

Call an Agent. The Agent will run on the Humanloop runtime and return a completed Agent Log.

If the Agent requires a tool call that cannot be ran by Humanloop, execution will halt. To continue, pass the ID of the incomplete Log and the required tool call to the /agents/continue endpoint.

The agent will run for the maximum number of iterations, or until it encounters a stop condition, according to its configuration.

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.

Instead of targeting an existing version explicitly, you can instead pass in Agent details in the request body. A new version is created if it does not match any existing ones. This is helpful in the case where you are storing or deriving your Agent details in code.

post/agents/call

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/agents/call
  • Auth: API key in header X-API-KEY

Query parameters

version_idstring

A specific Version ID of the Agent to log to.

environmentstring

Name of the Environment identifying a deployed version to log to.

Request body

pathstring

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.

idstring

ID for an existing Agent.

inputsobject

The inputs passed to the prompt template.

sourcestring

Identifies where the model was called from.

metadataobject

Any additional metadata to record.

start_timestring date-time

When the logged event started.

end_timestring date-time

When the logged event ended.

source_datapoint_idstring

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_idstring

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

userstring

End-user ID related to the Log.

environmentstring

The name of the Environment the Log is associated to.

saveboolean

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

log_idstring

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

streamtrue required

If true, Agent events and tokens will be sent as data-only server-sent events.

return_inputsboolean

Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.

include_trace_childrenboolean

If true, populate trace_children for the returned Agent Log. Only applies when not streaming. Defaults to false.

Changes

No recorded changes to this operation across all 1 revision of this API.