How to Retrieve Internal Session ID Using Phoenix API

·Jun 23, 2025 02:53 PM

I'm trying to construct a session url like /projects/UHJvamVjdDozOA==/sessions/UHJvamVjdFNlc3Npb246MjUyNw%3D%3D, I have a session id in uuid, which phoenix api should I use to get its internal id like 2527, please?

11 comments

· Sorted by Oldest

RunLLM
APP
·
Phoenix does not provide a direct REST or Python client API to convert a session UUID to its internal numeric ID (like 2527) in the official documentation. However, you can filter sessions by their `session_id` (the UUID you have) using the GraphQL API, which will return the internal Phoenix session object, including its internal ID. This is supported in the backend and UI as of recent releases, but there is no explicit REST endpoint for this conversion—only GraphQL queries are documented for session filtering by `session_id` (<https://github.com/Arize-ai/phoenix/pull/8038|see here>, <https://arize.com/docs/phoenix/tracing/how-to-tracing/setup-sessions|docs>). Would you like a sample GraphQL query or Python code to perform this lookup? Sources: - <https://github.com/Arize-ai/phoenix/pull/8038|feat: allow filtering of sessions by session_id> - <https://arize.com/docs/phoenix/tracing/how-to-tracing/setup-sessions|docs>
💡 Hint: Mention RunLLM in the thread for followups.
Zhuyi X.
·
is the graphql api preferred over the rest one at https://arize-phoenix.readthedocs.io/projects/client/en/latest/api/client.html#projects?
Ben M.
·
Generally, the graphql api gets built out more than the REST api because it powers the phoenix UI. This has been changing, but you’ll likely have more superpowers in the graphql api 👍
Zhuyi X.
·
Thank you! where can I find the doc for the graphql API, is it https://arize.com/docs/ax/reference/api-reference/graphql-api/models-api? But looks like mainly for phoenix platform? I'm self-hosting arize phoenix.
Ben M.
·
In your phoenix instance, click on APIs and then there’s an interactive REST or GraphQL docs site 🙂
Zhuyi X.
·
Ah, thank you! Awesome
Mikyo
·
Hey Zhuyi X. - we've been meaning to build out the redirect routes to support the user provided IDs like sessionIDs. https://github.com/Arize-ai/phoenix/issues/6934 I'll work with Donny L. to figure out a solution in the near future. IN the meantime as Ben pointed out, GraphQL drives all of the UI so it's a good way of unblocking this.
👍1
Donny L.
·
Zhuyi X. Thanks for asking for this feature, we will let you know once the feature is completed & merged
1
Donny L.
·
Zhuyi X. thanks for your patience! we have added support for redirect given span/trace/session id https://github.com/Arize-ai/phoenix/pull/8320 let me know if you need further help on it
2
Zhuyi X.
·
Thank you Donny L., the session redirect is very helpful! btw, I wonder if it's possible to construct a url with a filter like metadata['doc_id'] == "9ab98cd6-d848-471e-961f-d1e3ee7d590g" for filtering traces in a project?
Zhuyi X.
·
my hunch is that it has to be through graphql, first find the corresponding trace id, and then use the new url redirects feature, but would like to confirm if I missed anything.

RunLLM
APP
·
Phoenix does not provide a direct REST or Python client API to convert a session UUID to its internal numeric ID (like 2527) in the official documentation. However, you can filter sessions by their `session_id` (the UUID you have) using the GraphQL API, which will return the internal Phoenix session object, including its internal ID. This is supported in the backend and UI as of recent releases, but there is no explicit REST endpoint for this conversion—only GraphQL queries are documented for session filtering by `session_id` (<https://github.com/Arize-ai/phoenix/pull/8038|see here>, <https://arize.com/docs/phoenix/tracing/how-to-tracing/setup-sessions|docs>). Would you like a sample GraphQL query or Python code to perform this lookup? Sources: - <https://github.com/Arize-ai/phoenix/pull/8038|feat: allow filtering of sessions by session_id> - <https://arize.com/docs/phoenix/tracing/how-to-tracing/setup-sessions|docs>
💡 Hint: Mention RunLLM in the thread for followups.
Zhuyi X.
·
is the graphql api preferred over the rest one at https://arize-phoenix.readthedocs.io/projects/client/en/latest/api/client.html#projects?
Ben M.
·
Generally, the graphql api gets built out more than the REST api because it powers the phoenix UI. This has been changing, but you’ll likely have more superpowers in the graphql api 👍
Zhuyi X.
·
Thank you! where can I find the doc for the graphql API, is it https://arize.com/docs/ax/reference/api-reference/graphql-api/models-api? But looks like mainly for phoenix platform? I'm self-hosting arize phoenix.
Ben M.
·
In your phoenix instance, click on APIs and then there’s an interactive REST or GraphQL docs site 🙂
Zhuyi X.
·
Ah, thank you! Awesome
Mikyo
·
Hey Zhuyi X. - we've been meaning to build out the redirect routes to support the user provided IDs like sessionIDs. https://github.com/Arize-ai/phoenix/issues/6934 I'll work with Donny L. to figure out a solution in the near future. IN the meantime as Ben pointed out, GraphQL drives all of the UI so it's a good way of unblocking this.
👍1
Donny L.
·
Zhuyi X. Thanks for asking for this feature, we will let you know once the feature is completed & merged
1
Donny L.
·
Zhuyi X. thanks for your patience! we have added support for redirect given span/trace/session id https://github.com/Arize-ai/phoenix/pull/8320 let me know if you need further help on it
2
Zhuyi X.
·
Thank you Donny L., the session redirect is very helpful! btw, I wonder if it's possible to construct a url with a filter like metadata['doc_id'] == "9ab98cd6-d848-471e-961f-d1e3ee7d590g" for filtering traces in a project?
Zhuyi X.
·
my hunch is that it has to be through graphql, first find the corresponding trace id, and then use the new url redirects feature, but would like to confirm if I missed anything.