Custom Properties

​

What are Custom Properties?

Custom Properties allow you to add any additional information to your requests, such as:

• The session, conversation, or app id
• The prompt chain by adding a common value to group of requests
• Application or user metadata making the request

​

Use Custom Properties to

• Get the the total cost or latency for a group of requests in a prompt chain
• Get the “unit economics” of your application, such as the average cost of a conversation or session
• Slice and dice your requests and metrics by any custom property

curl https://oai.hconeai.com/v1/completions \
  -H 'Content-Type: application/json' \
  -H 'Helicone-Auth: Bearer HELICONE_API_KEY' \
  -H 'Helicone-Property-Session: "24"' \
  -H 'Helicone-Property-Conversation: "support_issue_2"' \
  -H 'Helicone-Property-App: "mobile"'
  -d ...

curl --request PUT \
  --url 'https://api.hconeai.com/v1/request/{request-id}/property' \
  --header 'Authorization: Bearer {your-helicone-api-key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "{property-key}",
    "value": "{new-property-value}"
}'