Use platform APIs with the Foundry platform SDK

Foundry APIs expose a variety of functionality that you can leverage with the Foundry platform SDK library through functions. You can use the platform SDK to build functions for administrative or governance workflows, interact with schedules and builds, access media sets, and more.

Install the SDK

To install the Foundry platform SDK, navigate to the Libraries side panel in your code repository and search for the SDK name: foundry-platform-sdk for Python, or @osdk/foundry for TypeScript.

Initialize your client

Your function requires authentication to interact with Foundry APIs. This process involves instantiating an authenticated “client” through which you can make requests to the Foundry APIs through the SDK. To help with this, install the appropriate library:foundry-sdk-runtime in Python, or @osdk/client in TypeScript. The @osdk/client library should come pre-installed in any TypeScript v2 repository.

Use platform APIs

Once your function is authenticated, you can start using Foundry APIs. The examples below show how to call a language model or query media sets in both Python and TypeScript:

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import { Client } from "@osdk/client";
import { Functions } from "@osdk/foundry";

export default async function useLlm(
    client: Client, // This parameter gets populated at runtime with a client that has permissions equal to the user calling the function
    prompt: string
): Promise<string> {

    const promptMessage = [
        {
            role: "USER",
            content: prompt
        }
    ];
    const result = await Functions.Queries.execute(
        client,
        "com.foundry.languagemodelservice.models.gpt41.CreateChatCompletion",
        {
            parameters: {
                messages: promptMessage
            }
        },
        {
            preview: true, // TODO: Remove; only needed for testing in Live Preview
        }
    );
    return result.value["completion"] as string;
}

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from foundry_sdk import FoundryClient, UserTokenAuth
# The below credentials initialize an authenticated client with basic permissions.
from foundry_sdk_runtime.context_vars import FOUNDRY_TOKEN, FOUNDRY_HOSTNAME

def get_foundry_client():
    auth = UserTokenAuth(token=FOUNDRY_TOKEN.get())
    hostname = FOUNDRY_HOSTNAME.get()
    return FoundryClient(auth=auth, hostname=hostname)

@function
def media_item_to_base64(media_item_rid: str, media_set_rid: str) -> str:
    foundry_client = get_foundry_client()

    result = foundry_client.media_sets.MediaSet.read(
        media_set_rid=media_set_rid,
        media_item_rid=media_item_rid,
        preview=True  # TODO: Remove after testing in Live Preview
    )

    # Convert the binary stream to a base64 encoded string
    base64_encoded = base64.b64encode(result).decode('utf-8')

    return base64_encoded