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 | Multiple Objects? | Schema | Section |
|---|---|---|---|---|
| xProxy-Limit-IDs | Used to declare the limits which should be charged for the request. | Yes | Comma-separated string list of limit IDs (e.g., "limit1,limit2,limit3"). | Limits (Continued) |
| xProxy-Request-Tags | Free form, custom strings used for later reference and data correlation. | Yes | Comma-separated string list of tags without spaces (e.g., "tag1,tag2,tag3"). | Request Tags |
| xProxy-User-ID | A free form, custom string used to identify the user the request is associated with. | No | Single string value that uniquely identifies a user. | UserIDs |
| 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. | No | Boolean string value: "True" or "False" (case-sensitive). | payi_instrument |
| xProxy-Provider-BaseURI | When using Pay-i as a proxy for a Provider, it will default to that Provider's SaaS endpoint. Use this header to change the Provider URI so Pay-i can proxy to a custom/hosted endpoint. Note that Azure, Bedrock, and Google Vertex require the use of this header as they do not have generic API endpoints. | No | Valid URI string including protocol (e.g., "https://custom-endpoint.example.com"). | Pay-i Proxy Configuration |
| xProxy-RouteAs-Resource | For Azure OpenAI only. Azure OpenAI obfuscates the model that is deployed in your Azure resource. This header is used to tell Pay-i which resource is deployed so that the costs can be tabulated correctly. | No | String value representing a resource name (e.g., "gpt-4"). | Azure OpenAI Provider Configuration |
| xProxy-Forward-* | Used to forward custom headers to the Provider. | - | Any valid header format. The xProxy-Forward- prefix is removed before forwarding. | Header Forwarding |
| xProxy-UseCase-ID | A unique identifier associated with a Use Case Instance. | No | String value representing a Use Case Instance ID (e.g., "12345678-90ab-cdef-1234-567890abcdef"). | Use Cases (Continued) |
| xProxy-UseCase-Name | The name of a Use Case, used when creating new Instances. | No | String value representing a Use Case name (e.g., "summarization"). | Use Cases (Continued) |
| xProxy-UseCase-Version | Version of a Use Case associated with each Instance. | No | Integer or string representation of an integer (e.g., "3"). | Use Case Versioning |
Updated 10 days ago