{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Find Your API Endpoints (Metadata)","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"find-your-api-endpoints-metadata","__idx":0},"children":["Find Your API Endpoints (Metadata)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once your client application is created, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Metadata"]}," button on the application page to find your specific endpoints."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":""},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/client_metadata.d34e7086743eadde3ced3d9062ab0f84636a73bafa398e300e50e619a833eba3.afe294b5.png","alt":"Metadata"},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This provides:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorization URL"]},": The endpoint to redirect users to for authorization. This is the URL that will redirect User/Customer to a page to login to your eGain instance to obtain an Authorization Code to be used with Auth Code/PKCE flow. Will be required for all auth flow except for client credentials, on-behalf-of, and token-exchange."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access Token URL"]},": The endpoint to exchange an authorization code for an access token or to use the client credentials flow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Domain URL"]},": The base URL for your eGain instance. This is the URL that you'll be making your API calls to."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Metadata URL"]},": The URL for your eGain instance where this metadata can be accessed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Actors"]}," are the personas of who call the APIs."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["User"]}," is a logged in agent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer"]}," is a logged in non-agent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client"]}," is a server."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example API Endpoints Metadata:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":""},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/client_metadata_details.a92f1b30682307cbace821a4d60311a6cd42df8d0c266363e4af8b9153e80924.afe294b5.png","alt":"Metadata Details"},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Domain Usage Note:"]}," ","The domain used to request access tokens is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://ai.egain.cloud/"]},", but the domain for calling the actual APIs is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.ai.egain.cloud/"]},". Update your base URL once you have the token."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next Steps:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/flow_overview"},"children":["Choose a specific flow based on your persona"]},":",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/auth-code-flow"},"children":["Auth Code"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/pkce-flow"},"children":["PKCE"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/client-credentials-flow"},"children":["Client Credentials"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/on-behalf-of-flow"},"children":["On-Behalf-Of"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/token-exchange-flow"},"children":["Token Exchange"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/authentication/making-requests"},"children":["Make Authenticated Requests"]}]}]}]},"headings":[{"value":"Find Your API Endpoints (Metadata)","id":"find-your-api-endpoints-metadata","depth":1}],"frontmatter":{"seo":{"title":"Find Your API Endpoints (Metadata)"}},"lastModified":"2026-05-02T01:57:53.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/guides/authentication/metadata","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}