Comprehensive guide to all Helicone headers. Learn how to access and implement various Helicone features through custom request headers.
"Helicone-Auth": "Bearer <HELICONE_API_KEY>"
. Remember to replace it with your actual Helicone API key.Helicone-Auth
make sure the key you add has write
permissions. As of June 2024 all keys have write access.https://api.openai.com/
.https://[YOUR_AZURE_DOMAIN].openai.azure.com
.123e4567-e89b-12d3-a456-426614174000
gpt-4-1106-preview
.prompt_story
and this is the first prompt
are valid.Helicone-Property-Session: 121
, Helicone-Property-App: mobile
, or Helicone-Property-MyUser: John Doe
. There are no restrictions on the value.alicebob@gmail.com
or db513bc9-ff1b-4747-a47b-7750d0c701d3
are both valid.[quota];w=[time_window];u=[unit];s=[segment]
. For example, 10;w=1000;u=cents;s=user
is a policy that allows 10 cents of requests per 1000 seconds per user.Helicone-Session-Id
header to your request to start tracking your (sessions and traces.)[features/sessions].parent
and a child trace child
, you can represent this as parent/child
.Course Plan
.true
or false
.true
or false
.true
or false
. You can customize the behavior of the cache feature by setting additional headers in your request.Additional headers
Parameter | Description |
---|---|
Cache-control | Specify the cache limit as a string in seconds, i.e. max-age=3600 is 1 hour. |
Helicone-Cache-Bucket-Max-Size | The size of cache bucket represented as a number . |
Helicone-Cache-Seed | Define a separate cache state as a string to generate predictable results, i.e. user-123 . |
"Helicone-Cache-Bucket-Max-Size": "10"
. true
or false
.
You can customize the behavior of the retries feature by setting additional headers in your request.Additional headers
Parameter | Descriptionretru |
---|---|
helicone-retry-num | Number of retries as a number . |
helicone-retry-factor | Exponential backoff factor as a number . |
helicone-retry-min-timeout | Minimum timeout (in milliseconds) between retries as a number . |
helicone-retry-max-timeout | Maximum timeout (in milliseconds) between retries as a number . |
"helicone-retry-num": "3"
. true
or false
.true
or false
.true
or false
.Headers | Description |
---|---|
Helicone-Id | Indicates the ID of the request. |
Helicone-Cache | Indicates whether the response was cached. Returns HIT or MISS . |
Helicone-Cache-Bucket-Idx | Indicates the cache bucket index used as a number . |
Helicone-Fallback-Index | Indicates fallback idex used as a number . |
Helicone-RateLimit-Limit | Indicates the quota for the number of requests allowed in the time window. |
Helicone-RateLimit-Remaining | Indicates the remaining quota in the current window as a number . |
Helicone-RateLimit-Policy | Indicates the active rate limit policy. |