For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Introduction
    • SDKs
    • Errors
  • Humanloop API
      • STREAMChat
      • STREAMChat Deployed
      • STREAMChat Model Config
      • STREAMCreate Experiment Stream
LogoLogo
Sign inBook a demo
Humanloop APIChats

Create Experiment Stream

POST
https://api.humanloop.com/v4/chat-experiment
POST
/v4/chat-experiment
$curl -X POST https://api.humanloop.com/v4/chat-experiment
Streamed response
Was this page helpful?
Previous

Create

Next
Built with

Response

datalist of objects
Array containing the chat responses.
provider_responseslist of any
The raw responses returned by the model provider.
project_idstring
Unique identifier of the parent project. Will not be provided if the request was made without providing a project name or id
num_samplesintegerDefaults to 1
The number of chat responses.
logprobsinteger

Include the log probabilities of the top n tokens in the provider_response

suffixstring
The suffix that comes after a completion of inserted text. Useful for completions that act like inserts.
userstring

End-user ID passed through to provider call.

usageobject
Counts of the number of tokens used and related stats.
metadatamap from strings to any
Any additional metadata to record.
provider_requestmap from strings to any
The raw request sent to the model provider.
session_idstring
ID of the session if it belongs to one.
tool_choice"none" or "auto" or "required" or object

Controls how the model uses tools. The following options are supported: ‘none’ forces the model to not call a tool; the default when no tools are provided as part of the model config. ‘auto’ the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {‘type’: ‘function’, ‘function’: {name’: <TOOL_NAME>}} forces the model to use the named function.