Humanloop Documentation and API Reference

Log to a Prompt.

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

Instead of targeting an existing version explicitly, you can instead pass in Prompt details in the request body. In this case, we will check if the details correspond to an existing version of the Prompt. If they do not, we will create a new version. This is helpful in the case where you are storing or deriving your Prompt details in code.

Query parameters

version_idstringOptional

A specific Version ID of the Prompt 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 Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name or just name.

idstringOptional

ID for an existing Prompt.

output_messageobjectOptional

The message returned by the provider.

prompt_tokensintegerOptional

Number of tokens in the prompt 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 can decide to call one or more of the provided tools.
{'type': 'function', 'function': {name': <TOOL_NAME>}} forces the model to use the named function.

promptobjectOptional

Details of your Prompt. A new Prompt version will be created if the provided details are new.

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.

savebooleanOptional

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

Response

Successful Response

idstring

String ID of log.

prompt_idstring

ID of the Prompt the log belongs to.

version_idstring

ID of the specific version of the Prompt.

session_idstringOptional

String ID of session the log belongs to.

1	curl -X POST https://api.humanloop.com/v5/prompts/log \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"path": "persona",
6	"output_message": {
7	"role": "assistant",
8	"content": "Well, you know, there is so much secrecy involved in government, folks, it\'s unbelievable. They don\'t want to tell you everything. They dont tell me everything! But about Roswell, it\'s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I\'d love to go down and open up all the classified documents, believe me, I would. But they don\'t let that happen. The Deep State, folks, the Deep State. They\'re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it\'s something big, very very big. Tremendous, in fact."
9	},
10	"prompt_tokens": 100,
11	"output_tokens": 220,
12	"prompt_cost": 0.00001,
13	"output_cost": 0.0002,
14	"finish_reason": "stop",
15	"messages": [
16	{
17	"role": "user",
18	"content": "What really happened at Roswell?"
19	}
20	],
21	"prompt": {
22	"model": "gpt-4",
23	"template": [
24	{
25	"role": "system",
26	"content": "You are {{person}}. Answer questions as this person. Do not break character."
27	}
28	]
29	},
30	"created_at": "2024-07-19T00:29:35.178992",
31	"provider_latency": 6.5931549072265625,
32	"inputs": {
33	"person": "Trump"
34	}
35	}'

1	{
2	"id": "data_fIfEb1SoKZooqeFbi9IFs",
3	"prompt_id": "pr_3usCu3dAkgrXTlufrvPs7",
4	"version_id": "prv_Wu6zx1lAWJRqOyL8nWuZk"
5	}

Query parameters

Request

Response

Errors