Header Cheat Sheet
A helpful reference for all of the custom headers that Pay-i supports.
Headers which accept multiple objects require a comma separated list.
| Header | Description | Multiple Objects? | Section |
|---|---|---|---|
| xProxy-Limit-IDs | Used to declare the limits which should be charged for the request. | Yes | Limits (Continued) |
| xProxy-Request-Tags | Free form, custom strings used for later reference and data correlation. | Yes | Request Tags |
| xProxy-User-ID | A free form, custom string used to identify the user the request is associated with. | No | 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 | |
| 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 | |
| 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 | |
| xProxy-Forward-* | Used to forward custom headers to the Provider. | - | Header Forwarding |
| xProxy-UseCase-ID | A unique identifier associated with a Use Case Instance. | No | Use Cases (Continued) |
| xProxy-UseCase-Name | The name of a Use Case, used when creating new Instances, identified through the returned experience_id. | No | Use Cases (Continued) |
| xProxy-UseCase-Version | Version of a Use Case associated with each Instance. | No | Use Case Versioning |
| xProxy-Experience-ID | DEPRECATED: A unique identifier associated with an instance of an Experience Type. | No | Experiences (Continued) |
| xProxy-Experience-Name | DEPRECATED: The name of an Experience Type, used when making the initial request of a new Experience to automatically create it and return a new experience_id. | No | Experiences (Continued) |
| xProxy-Experience-Version | DEPRECATED: Version of an Experience Type associated with each Experience Instance. | No | Experience Versioning |
Updated 15 days ago