Correction on API Key Placement in Register Method Documentation

The documentation for the register method mentions to put the api-key in the api_key property of the headers , which is incorrect. The auhorization property needs to be populated with the api-key instead. https://docs.arize.com/phoenix/tracing/how-to-tracing/setup-tracing/setup-tracing-python

· Sorted by Oldest

Sagar D.
·
Refer to: https://github.com/Arize-ai/phoenix/blob/390cfaa42c5b2c28d3f9f83fbf7c694b8c2beeff/packages/phoenix-otel/src/phoenix/otel/otel.py#L379
RunLLM
APP
·
The documentation for the register method does indeed mention setting the api_key in the headers property, but it should be set in the authorization property instead. This is confirmed by the GitHub issue which discusses the correct usage of the Authorization header for API keys.Would you like more details on how to correctly configure the register method? Sources: - GitHub issue
💡 Hint: Mention RunLLM in the thread for followups.
Roger Y.
·
Great catch! I’ve added clarification to the documentation. Thank you!
🙌1

Sagar D.
·
Refer to: https://github.com/Arize-ai/phoenix/blob/390cfaa42c5b2c28d3f9f83fbf7c694b8c2beeff/packages/phoenix-otel/src/phoenix/otel/otel.py#L379
RunLLM
APP
·
The documentation for the register method does indeed mention setting the api_key in the headers property, but it should be set in the authorization property instead. This is confirmed by the GitHub issue which discusses the correct usage of the Authorization header for API keys.Would you like more details on how to correctly configure the register method? Sources: - GitHub issue
💡 Hint: Mention RunLLM in the thread for followups.
Roger Y.
·
Great catch! I’ve added clarification to the documentation. Thank you!
🙌1