Request for API Endpoint URL - AIP Logic Function Integrati

Ask the Community
, , ,
1

Hello everyone!

I’m seeking help tp retriev the API Endpoint URL for a published AIP Logic function within my Foundry environment.

Context:

I have developed an AIP Logic function designed to generate personalized learning paths using the OpenAI API. This function, named generateLearningPathWithLLM (API name: generateLearningPath), has been successfully published and is intended for integration with a backend application.

Function Details:

  • Function Name: generateLearningPathWithLLM
  • API Name: generateLearningPath
  • Function RID: ri.function-registry.main.function.7ca15da6-2b0a-45d3-85f8-aef886ce397e

Issue:

I’m encountering difficulties locating the API Endpoint URL required to call this function from my backend. I’ve thoroughly reviewed the function’s details within the AIP Logic application, including the overview and metadata sections, as well as the Ontology Manager, but the URL is not visible.

Request:

Could anyone please provide guidance on how to retrieve the API Endpoint URL for this published function? Specifically, I’m interested in:

  • The typical location of the API Endpoint URL within the Foundry interface for published AIP Logic functions.
  • Any specific permissions or configurations that might be required to access this information.
  • Any potential troubleshooting steps to resolve this issue.

Additionally, if there are any known issues or limitations related to API Endpoint URL visibility in specific Foundry versions or configurations, please let me know. I appreciate your assistance in resolving this issue and facilitating the integration of my AIP Logic function.

2

hi @woustachemax ,

Is your function published as a Query? If so, you will be able to execute it by hitting the public API.

If you function is not a query, because e.g. it actually generates and persist some ontology changes you can create an action type with Function Logic Rule and call it through Apply Action endpoint.

3

Thank you, @alieskovsky.

Apologies for the delayed response,

To clarify, my AIP Logic function, generateLearningPathWithLLM, is designed to generate a JSON object representing a learning path, based on a given goal. I am trying to call this function from an external backend application. Therefore I need the rest api endpoint that is generated when a function is published within AIP logic.

It does not directly modify the ontology and is not intended to be used as a “Query” in the ontological sense, nor does it require an “Action Type.”

Could you please provide further guidance on how to retrieve the API Endpoint URL for a published AIP Logic function in this context? I’m specifically looking for the endpoint that allows me to call the function as a standard API call from my backend.

Thank you for your continued assistance

4

Queries do not/cannot modify ontology at all, they allow you to read it (optional).

Queries are the read-only subsets of Functions that may be optionally exposed through the API gateway. They cannot have any side effects, such as modifying the Ontology or altering external systems.

Does this fit your criteria? I’d still recommend you to explore publishing this as a query. The query can then be called through OSDK that your external backend system could depend on.

Queries can be called via the public API by specifying their ontology and api name.

5

Hi @alieskovsky,

Thank you for your suggestion regarding Queries and Action Types. I appreciate you trying to help clarify the best approach.

As it turns out, Palantir Support has provided a potential API endpoint format for directly calling the published AIP Logic function using its Resource Identifier (RID). This seems to be the most direct way to integrate with my external backend application for this specific use case, as the function primarily generates a JSON output and doesn’t directly modify the ontology.

Thank you again for your input

6

There is an application called Developer Console where you can expose you function.

You can use the generated OSDK for Python/Typescript/Java projects or just call the API as a rest call. (Switch to Curl on the top right corner on the documentation page.)

https://www.palantir.com/docs/foundry/ontology-sdk/create-a-new-osdk

7

I did that, THANKS SO MUCH!!