Header Cheat Sheet
A helpful reference for all of the custom headers that Pay-i supports.
Headers marked as accepting multiple values expect a single header with one comma-separated string value (not multiple headers with the same name each containing a single value).
| Header | Description | Schema |
|---|---|---|
| xProxy-Limit-IDs | Used to declare the limits which should be charged for the request. | Comma-separated string list of limit IDs (e.g., "limit1,limit2,limit3"). |
| xProxy-User-ID | A free form, custom string used to identify the user the request is associated with. | Single string value that uniquely identifies a user. |
| xProxy-Logging-Disable | When set to True Pay-i will not log the request or response details, but will still account for costs, errors, latency, and other metadata. Use this when a request contains sensitive information that your developers will not need to see in order to debug issues. | Boolean string value: "True" or "False" (case-sensitive). |
| xProxy-PriceAs-Resource | This header is used to tell Pay-i which resource should be used when calculating costs. This is used when the resource name is not immediately determinable (such as when leveraging Azure OpenAI deployments), or when using custom resources for custom pricing, so that the costs can be tabulated correctly. | String value representing a resource name (e.g., gpt-4). |
| xProxy-PriceAs-Category | Optionally used in conjunction with xProxy-PriceAs-Resource, this header is also used to tell Pay-i whichCategory + Resource combination should be used when calculating costs. If xProxy-PriceAs-Resource is specified and xProxy-PriceAs-Category is not, then the Pay-i SDK will automatically infer the category based on the provider SDK that is being instrumented. | String value representing a category name (e.g., system.openai). |
| xProxy-Forward-* | Used to forward custom headers to the Provider. | Any valid header format. The xProxy-Forward- prefix is removed before forwarding. |
| xProxy-UseCase-ID | A unique identifier associated with a Use Case Instance. | String value representing a Use Case Instance ID (e.g., "12345678-90ab-cdef-1234-567890abcdef"). |
| xProxy-UseCase-Name | The name of a Use Case, used when creating new Instances. | String value representing a Use Case name (e.g., "summarization"). |
| xProxy-UseCase-Version | Version of a Use Case associated with each Instance. | Integer or string representation of an integer (e.g., "3"). |
| xProxy-UseCase-Step | Workflow step identifier that auto-promotes to system.use_case_step dimension in structured instrumentation. | String value representing workflow step (e.g., "extraction", "analysis", "summary"). |
| xProxy-Account-Name | Account identifier that auto-promotes to system.account_name dimension in structured instrumentation. | String value representing account name. |
Updated about 19 hours ago