Method
getApiEndpoint GET
Copy GET

Returns the API endpoint specific to an organization. This function can be utilized using either an API Key or a deployment ID and token for authentication.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
No deploymentToken str Token used for authenticating access to deployed models.
No deploymentId str Unique identifier assigned to a deployment created under the specified project.
No streamingToken str Token used for authenticating access to streaming data.
No featureGroupId str Unique identifier assigned to a feature group.
No modelId str Unique identifier assigned to a model.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result ApiEndpoint
KEY TYPE Description
apiEndpoint str The URI that can be used to make API calls
predictEndpoint str The URI that can be used to make predict calls against Deployments
proxyEndpoint str The URI that can be used to make proxy server calls
llmEndpoint str The URI that can be used to make llm api calls
externalChatEndpoint str The URI that can be used to access the external chat
dashboardEndpoint str The URI that the external chat will use to go back to the dashboard
hostingDomain str The domain for hosted app deployments

Exceptions:

TYPE WHEN
DataNotFoundError `deploymentId` is not found.
DataNotFoundError `featureGroupId` is not found.
DataNotFoundError `modelId` is not found.
Language:

© Copyright