Palantir Platform Documentation

https://www.palantir.com/docs/
Admin
Comprehensive documentation for the Palantir platform, covering various modules like Foundry for...
Tokens:2,973,114
Snippets:36,775
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Start Development Server

Source: https://www.palantir.com/docs/foundry/developer-console/how-to-bootstrapping-typescript

Navigate to your project directory, install the necessary dependencies, and start the local development server to begin developing your frontend application.

```bash
cd <project-directory>
npm install
npm run dev
```

--------------------------------

### Install Dependencies and Start Dev Server

Source: https://www.palantir.com/docs/foundry/custom-widgets/development

Install project dependencies and start the development server. This command is essential for enabling live code updates during widget development.

```bash
npm install
npm run dev
```

--------------------------------

### Run Docker Getting Started container

Source: https://www.palantir.com/docs/apollo/core/set-up-local-kubernetes-cluster

This command starts a Docker container for the 'getting-started' image, exposing port 80.

```bash
docker run -d -p 80:80 docker/getting-started
```

--------------------------------

### Python Media Set Transformation Example

Source: https://www.palantir.com/docs/foundry/media-sets-advanced-formats/transforming-media

This Python code demonstrates how to get started with media sets in Code Repositories, defining input and output media sets for a transformation function.

```python
from transforms.api import transform
from transforms.mediasets import MediaSetInput, MediaSetOutput
@transform(
    images=MediaSetInput('/examples/images'),
    output_images=MediaSetOutput('/examples/output_images')
)
def translate_images(images, output_images):
    ...
```

--------------------------------

### Get Build Response Example

Source: https://www.palantir.com/docs/foundry/api/orchestration-v2-resources/builds/get-build

This is an example of a successful response when retrieving build information. It includes details like status, timestamps, and associated job RIDs.

```json
{
"abortOnFailure": false,
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"retryBackoffDuration": {
"unit": "SECONDS",
"value": 30
},
"retryCount": 1,
"fallbackBranches": [],
"scheduleRid": "ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871",
"branchName": "master",
"createdTime": "2003-05-06T12:34:56.789Z",
"jobRids": [
"ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
],
"finishedTime": "2003-05-06T12:34:56.789Z",
"rid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58",
"status": "RUNNING"
}
```

--------------------------------

### Java Request Example

Source: https://www.palantir.com/docs/foundry/api/v2/notepad-v2-resources/generation-jobs/get-generation-job

Example of how to call the Get Generation Job API using Java. This snippet shows the necessary client setup and method call.

```java
var client = new Client(
    host=os.environ.get("HOSTNAME"),
    token=os.environ.get("TOKEN"),
);


client.api().v2().notepad().templates().generationJobs().getGenerationJob(
    templateRid="ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52",
    generationJobRid="ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c",
    preview=true,
);
```

--------------------------------

### Get Outgoing Link Type (Python)

Source: https://www.palantir.com/docs/foundry/api/v1/ontology-resources/object-types/get-outgoing-link-type

Python example for fetching an outgoing link type. This snippet requires the 'requests' library and proper authentication setup.

```python
import requests

response = requests.get(
    "https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objectTypes/Employee/outgoingLinkTypes/directReport",
    headers={
        "Authorization": "Bearer $TOKEN"
    }
)

print(response.json())
```

--------------------------------

### Python Entry Point Error Example

Source: https://www.palantir.com/docs/foundry/transforms-python/environment-troubleshooting

This error indicates missing essential files like meta.yaml or setup.py required for builds. Ensure these files are correctly configured.

```text
transforms._errors.EntryPointError: "Key {name} was not found, please check your repo's meta.yaml and setup.py files"
```

--------------------------------

### Example Manifest File Publication

Source: https://www.palantir.com/docs/apollo/managing-products/publishing-helm-charts

An example invocation for publishing a product using a local manifest file.

```bash
./apollo-cli publish --apollo-url="$APOLLO_URL" --apollo-token="$APOLLO_TOKEN" manifest --manifest-file=manifest.yml
```

--------------------------------

### Get Dataset using JavaScript

Source: https://www.palantir.com/docs/foundry/api/datasets-v2-resources/datasets/get-dataset

This JavaScript example illustrates fetching dataset information using the Palantir Foundry SDK for JavaScript. Make sure the SDK is properly installed and configured.

```javascript
import { FoundryClient } from "@palantir/foundry-client";

const client = new FoundryClient({
  // Configuration options for the client
});

const datasetRid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da";

client.datasets.getDataset(datasetRid).then(dataset => {
  console.log(dataset);
}).catch(error => {
  console.error(error);
});
```

--------------------------------

### Python Request to Get Configuration

Source: https://www.palantir.com/docs/foundry/api/v2/connectivity-v2-resources/connections/get-configuration

Example Python code to fetch a connection's configuration using the requests library. Ensure you have the 'requests' library installed and replace placeholders with your actual token and hostname.

```python
import requests

token = "$TOKEN"
hostname = "$HOSTNAME"
connection_rid = "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"

headers = {
    "Authorization": f"Bearer {token}"
}

response = requests.get(f"https://{hostname}/api/v2/connectivity/connections/{connection_rid}/getConfiguration", headers=headers)

print(response.json())
```

--------------------------------

### Install Dependencies, Lint, and Build Project

Source: https://www.palantir.com/docs/foundry/custom-widgets/publish

Install project dependencies, lint for errors, and create a production build of your widget set. These commands are essential before publishing.

```bash
npm install
npm run lint
npm run build
```

--------------------------------

### Python Request Example

Source: https://www.palantir.com/docs/foundry/api/v2/notepad-v2-resources/generation-jobs/get-generation-job

Example of how to call the Get Generation Job API using Python. This snippet demonstrates making an authenticated GET request.

```python
import os

from dotenv import load_dotenv
from palantir_api.api.client import Client

load_dotenv()


client = Client(
    host=os.environ.get("HOSTNAME"),
    token=os.environ.get("TOKEN"),
)


client.api.v2.notepad.templates.generation_jobs.get_generation_job(
    template_rid="ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52",
    generation_job_rid="ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c",
    preview=True,
)
```

--------------------------------

### Workflow Example: Get and Apply Configuration

Source: https://www.palantir.com/docs/apollo/apollo-cli/apollo-cli_environment_config_get

Demonstrates a common workflow for modifying environment configurations. First, get the current configuration into a local directory, then modify the files within that directory, and finally apply the changes by opening a change request.

```bash
1. apollo-cli environment config get  --output-dir configs
2. Modify the configuration in the configs directory
3. apollo-cli environment config apply  --config-dir configs opens a CR with the changes.
```

--------------------------------

### Get Markings Batch Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/admin-v2-resources/markings/get-markings-batch

An example of a successful response from the Get Markings Batch endpoint, showing the structure of the returned marking data.

```json
{
 "data": {
  "18212f9a-0e63-4b79-96a0-aae04df23336": {
   "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
   "organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
   "name": "PII",
   "description": "Contains personally identifiable information about our customers",
   "createdTime": "2003-05-06T12:34:56.789Z",
   "id": "18212f9a-0e63-4b79-96a0-aae04df23336",
   "categoryId": "0950264e-01c8-4e83-81a9-1a6b7f77621a"
  }
 }
}
```

--------------------------------

### Get Groups Batch Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/admin-v2-resources/groups/get-groups-batch

Example of a successful response from the Get Groups Batch endpoint, showing the structure of the returned group data.

```json
{
 "data": {
 "0d1fe74e-2b70-4a93-9b1a-80070637788b": {
 "name": "Data Source Admins",
 "organizations": [
 "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
 ],
 "description": "Create and modify data sources in the platform",
 "realm": "palantir-internal-realm",
 "attributes": {
 "multipass:realm": [
 "eab0a251-ca1a-4a84-a482-200edfb8026f"
 ],
 "multipass:organization-rid": [
 "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
 ]
 },
 "id": "0d1fe74e-2b70-4a93-9b1a-80070637788b"
 }
 }
}
```

--------------------------------

### Example Template File (stages.yaml)

Source: https://www.palantir.com/docs/apollo/apollo-cli/apollo-cli_product_promotion_append

This YAML file defines the promotion pipeline stages to be appended. It includes source and target release channels, stage type, and conditions.

```yaml
stages:
  - sourceReleaseChannel: BETA
    targetReleaseChannel: RELEASE
    stage:
      type: zeroCanary
      zeroCanary:
        soakTime: "PT1440M"
        productLabelConditions:
          - labelId: "security.palantir.build/approved"
            onlyPossibleLabelValues: ["true"]
```

--------------------------------

### Example Manifest with Product Dependencies

Source: https://www.palantir.com/docs/apollo/managing-products/publishing-helm-charts

A complete example of a manifest.yml file for a Helm chart product, including product group, name, version, and detailed product dependencies.

```yaml
manifest-version: '1.0'
product-group: com.palantir.example
product-name: wordpress
product-version: 13.1.4
product-type: helm-chart.v1
extensions:
  helm-chart:
    - helm-chart-name: wordpress
      helm-chart-version: 13.1.4
  product-dependencies:
    - product-group: com.palantir.foo
      product-name: foo
      minimum-version: 1.3.5
      maximum-version: 1.x.x
      optional: false
    - product-group: com.palantir.bar
      product-name: bar
      minimum-version: 2.7.0
      maximum-version: 2.x.x
      optional: true

```

--------------------------------

### Get Records Batch API Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/checkpoints-v2-resources/records/get-records-batch

This is an example of a successful response from the Get Records Batch API, showing the structure of returned checkpoint data.

```json
{
 "data": {
  "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
   "projectRid": "ri.compass.main.folder.d4e5f6a7-b8c9-0123-defa-234567890123",
   "delegateUserId": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
   "configRid": "ri.checkpoints.main.config.b2c3d4e5-f6a7-8901-bcde-f12345678901",
   "organizationRid": "ri.multipass..organization.e5f6a7b8-c9d0-1234-efab-345678901234",
   "checkpointedItems": [
    {
     "type": "checkpointedResource",
     "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
     "resourceType": "DATASET",
     "compassPath": {
      "value": "/My Project/My Dataset"
     },
     "orgMarkings": []
    }
   ],
   "rid": "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   "type": "CONTOUR_EXPORT",
   "actingUser": {
    "userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
    "username": {
     "value": "admin"
    }
   },
   "createdAt": "2023-11-14T09:30:00.000Z",
   "approvalsMetadata": {
    "approvalsTaskId": "e3f4a5b6-c7d8-9012-efab-123456789012",
    "approvalsSubtaskIds": [
     "f4a5b6c7-d8e9-0123-fabc-234567890123"
    ]
   },
   "scope": "USER_SCOPED",
   "interactionRid": "ri.checkpoints.main.checkpointable-interaction.c3d4e5f6-a7b8-9012-cdef-123456789012",
   "namespaceRid": "ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345",
   "justification": {
    "type": "acknowledgementJustification",
    "prompt": "I acknowledge this action",
    "title": "Export Confirmation"
   }
  }
 }
```

--------------------------------

### Example of migrating between frameworks

Source: https://www.palantir.com/docs/foundry/migrate-models/overview

This example demonstrates how to migrate between the old foundry_ml framework and the new palantir_models framework. Review this to understand the process.

```python
from foundry_ml.model import Model
from palantir_models.model_adapter import ModelAdapter

# Load an existing foundry_ml model
old_model = Model.load("path/to/foundry_ml/model")

# Wrap the old model in a ModelAdapter
new_model = ModelAdapter(old_model)

# You can now use new_model with palantir_models
# For example, to save it:
new_model.save("path/to/palantir_models/model")
```

--------------------------------

### Get Users Batch Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/admin-v2-resources/users/get-users-batch

An example of a successful response from the Get Users Batch endpoint, showing user data mapped by User ID.

```json
{
 "data": {
 "0d1fe74e-2b70-4a93-9b1a-80070637788b": {
 "givenName": "John",
 "familyName": "Smith",
 "organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
 "realm": "palantir-internal-realm",
 "attributes": {
 "multipass:givenName": [
 "John"
 ],
 "multipass:familyName": [
 "Smith"
 ],
 "multipass:email:primary": [
 "jsmith@example.com"
 ],
 "multipass:realm": [
 "eab0a251-ca1a-4a84-a482-200edfb8026f"
 ],
 "multipass:organization-rid": [
 "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
 ],
 "department": [
 "Finance"
 ],
 "jobTitle": [
 "Accountant"
 ]
 },
 "id": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
 "email": "jsmith@example.com",
 "username": "jsmith",
 "status": "ACTIVE"
 }
 }
}
```

--------------------------------

### Get Content Response Example

Source: https://www.palantir.com/docs/foundry/api/aip-agents-v2-resources/contents/get-content

Example JSON response body for the Get Content API, showing conversation exchanges, agent responses, user input, and context.

```json
{
 "exchanges": [
 {
 "result": {
 "totalTokensUsed": 6448,
 "agentMarkdownResponse": "The status of your order is **In Transit**.",
 "sessionTraceId": "12345678-1234-5678-1234-123456789abc",
 "interruptedOutput": false
 },
 "userInput": {
 "text": "What is the status of my order?"
 },
 "contexts": {
 "objectContexts": [
 {
 "objectRids": [
 "ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"
 ],
 "propertyTypeRids": [
 "ri.ontology.main.property.7899aeb4-a389-4f2e-a0fd-e7193a4f6cb1"
 ]
 }
 ]
 }
 }
 ]
}
```

--------------------------------

### Input Data Example

Source: https://www.palantir.com/docs/foundry/optimizing-pipelines/spark-optimization

Illustrates a simple input dataset before bucketing is applied.

```text
A
C
A
A
B
C
```

--------------------------------

### Full Example: repoSettings.json Configuration

Source: https://www.palantir.com/docs/foundry/code-repositories/advanced-settings

An example demonstrating the configuration of tag validation, PR description template, output path prefix, and PR validation rules within a single repoSettings.json file.

```json
{
    "tagNameValidation": {
        "regex": "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-rc\d+)?$",
        "errorMessage": "Tag name must have the format x.x.x or x.x.x-rcx"
    },
    "prDescriptionTemplate": "First line of the description template\nAnd another line with instructions",
    "outputPathPrefix": "/My/Custom/Prefix",
    "prValidation": [
        {
            "regex": "TEST-\d{3}",
            "fields": ["title", "branchName"],
            "errorMessage": "This field must contain a valid TEST-XXX ticket, such as 'TEST-123'."
        },
        {
            "regex": "This is the description",
            "fields": ["description"],
            "errorMessage": "Please enter 'This is the description' somewhere in the description."
        }
    ]
}
```

--------------------------------

### Example Bootstrapper Configuration

Source: https://www.palantir.com/docs/foundry/data-connection/agents-troubleshooting

This snippet shows an example of the Bootstrapper configuration with the port parameter set. Ensure the port is not already in use.

```yaml
server:
  adminConnectors:
    ...
    port: 7002 #This is the port value
```

--------------------------------

### Get Jobs Batch Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/orchestration-v2-resources/jobs/get-jobs-batch

An example of a successful response from the Get Jobs Batch endpoint, showing the 'data' map containing job details keyed by their RIDs.

```json
{
 "data": {
  "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448": {
   "startedTime": "2003-05-06T12:34:56.789Z",
   "jobStatus": "WAITING",
   "buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58",
   "finishedTime": "2003-05-06T12:34:56.789Z",
   "rid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448",
   "latestAttemptStartTime": "2003-05-06T12:34:56.789Z"
  }
 }
}
```

--------------------------------

### Java UDF Example Implementation

Source: https://www.palantir.com/docs/foundry/transforms-java/user-defined-functions

Demonstrates how to implement the `examples()` method for a row map UDF. This includes setting an ID, description, visibility, category, configuration, input rows, and expected output rows.

```java
1@Override
2public List<UdfExample<SettableMultiplicand, Product, MultiplyConfiguration>> examples() {
3    return List.of(UdfExample.<SettableMultiplicand, Product, MultiplyConfiguration>builder()
4            // A unique ID for this example
5            .id(ExampleId.of("baseCase"))
6            // Optional: A description of what this example represents
7            .description("Multiply values by 2.")
8            // Whether this example should have PROMINENT or DEFAULT visibility in Pipeline Builder
9            .visibility(ExampleVisibility.DEFAULT)
10            // The case that this example illustrates (base case, null case, edge case)
11            .category(ExampleCategory.BASE)
12            // The arguments to pass to the UDF that this example illustrates
13            .configuration(MultiplyConfiguration.builder().multiplier(2.0d).build())
14            // The example input rows to the UDF
15            .input(
16                    SettableMultiplicand.create(ctx().getRowBuilderFactory())
17                            .key("key")
18                            .value(1.5d),
19                    SettableMultiplicand.create(ctx().getRowBuilderFactory())
20                            .key("key")
21                            .value(3.0d))
22            // The example output rows (what the input rows should look like after the UDF has been called on them)
23            .output(
24                    Product.create(ctx().getRowBuilderFactory()).key("key").value(3.0d),
25                    Product.create(ctx().getRowBuilderFactory()).key("key").value(6.0d))
26            .build());
27}
```

--------------------------------

### Query Live Deployment using JavaScript (Node.js) (Multi I/O)

Source: https://www.palantir.com/docs/foundry/manage-models/live-deployment-reference

This JavaScript example demonstrates how to query a live deployment using the Fetch API in Node.js. It constructs the request body and headers, then logs the result or any errors.

```javascript
  // Construct request
  const inferenceRequest = {
    "inference_data": [{
      "text": "Hello, how are you?"
    }]
  };

  // Send the request
  const response = await fetch(
    "<ENVIRONMENT_URL>/foundry-ml-live/api/inference/transform/ri.foundry-ml-live.<RID>/v2",
    {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        Authorization:
          "Bearer <BEARER_TOKEN>",
      },
      body: JSON.stringify(inferenceRequest),
    }
  );

  if (!response.ok) {
    throw Error(`${response.status}: ${response.statusText}`);
  }

  const result = await response.json();

  console.log(result);
```

--------------------------------

### Get Cbac Banner Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/admin-v2-resources/cbac-banners/get-cbac-banner

Example JSON response for the Get Cbac Banner API, showing the returned markings, background colors, classification string, and text color.

```json
{
 "markings": [
 "MTS",
 "MNF"
 ],
 "backgroundColors": [
 "#FFFFFF"
 ],
 "classificationString": "MTS//MNF",
 "textColor": "#FFFFFF"
}
```

--------------------------------

### Complete Dockerfile Example

Source: https://www.palantir.com/docs/foundry/compute-modules/containers

A complete example of a Dockerfile for a Python application.

```Dockerfile
FROM python:3.12
WORKDIR /app
COPY ./requirements.txt /app
RUN pip install --no-cache-dir -r requirements.txt
RUN adduser --uid 5001 user
USER 5001
COPY ./src/application.py /app
ENTRYPOINT ["python", "application.py"]

```

--------------------------------

### JavaScript Request Example

Source: https://www.palantir.com/docs/foundry/api/v2/media-sets-v2-resources/media-sets/get-media-item-rid-by-path

Example of how to call the Get Media Item RID by Path API using JavaScript. This snippet illustrates making a GET request with the necessary authorization header and the `preview=true` query parameter.

```javascript
const fetchMediaItemRidByPath = async (mediaSetRid, path, token, hostname) => {
  const response = await fetch(
    `https://${hostname}/api/v2/mediasets/${mediaSetRid}/items/getRidByPath?mediaItemPath=${encodeURIComponent(path)}&preview=true`,
    {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${token}`
      }
    }
  );
  return await response.json();
};
```

--------------------------------

### Get Cbac Marking Restrictions Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/admin-v2-resources/cbac-marking-restrictions-objects/get-cbac-marking-restrictions

This is an example JSON response for the Get Cbac Marking Restrictions API call, showing disallowed, required, and implied markings, along with user satisfaction and validity status.

```json
{
 "disallowedMarkings": [
 "18212f9a-0e63-4b79-96a0-aae04df23336"
 ],
 "requiredMarkings": [
 [
 "18212f9a-0e63-4b79-96a0-aae04df23336"
 ]
 ],
 "userSatisfiesMarkings": true,
 "isValid": true,
 "impliedMarkings": [
 "18212f9a-0e63-4b79-96a0-aae04df23336"
 ]
}
```

--------------------------------

### Example Lineage for Connecting Build

Source: https://www.palantir.com/docs/foundry/building-pipelines/create-schedule

Illustrates dataset lineage with different branches, showing how a connecting build selects datasets based on job spec paths.

```text
D1 (master) --> D2 (master) --> D4 (master) --> D6 (master)
                 |
                 | D2 (develop)
                 |
                  --> D3 (master) --> D5 (master)


```

--------------------------------

### Get Object

Source: https://www.palantir.com/docs/gotham/api/general/overview/getting-started

Retrieve information about a specific object using its ID. This example demonstrates a GET request to the objects endpoint.

```APIDOC
## GET /api/gotham/v1/objects/{objectId}

### Description
Retrieves detailed information about a specific object identified by its unique ID.

### Method
GET

### Endpoint
/api/gotham/v1/objects/{objectId}

### Parameters
#### Path Parameters
- **objectId** (string) - Required - The unique identifier of the object to retrieve.

### Request Example
```bash
curl -H "Authorization: Bearer <your token>" \
 "https://<hostname>/api/gotham/v1/objects/ri.gotham.111111-0.object-internal.111111"
```

### Response
#### Success Response (200)
- **objectDetails** (object) - Contains the details of the requested object.

#### Response Example
{
  "example": "{\"id\": \"ri.gotham.111111-0.object-internal.111111\", \"title\": \"Example Object\", \"type\": \"com.palantir.object.example\"}"
}
```

--------------------------------

### Get Project Response

Source: https://www.palantir.com/docs/foundry/api/filesystem-v2-resources/projects/get-project

Example JSON response for a successful Get Project request, detailing the project's attributes.

```json
{
 "path": "/Empyrean Airlines/My Important Project",
 "updatedTime": "2024-09-25T17:29:35.974Z",
 "updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
 "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
 "displayName": "My Important Project",
 "documentation": "project documentation",
 "resourceLevelRoleGrantsAllowed": true,
 "description": "project description",
 "createdTime": "2024-09-25T17:29:35.974Z",
 "rid": "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8",
 "spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
 "trashStatus": "NOT_TRASHED"
}
```

--------------------------------

### Publish Product from Manifest File

Source: https://www.palantir.com/docs/apollo/managing-products/publishing-helm-charts

Use this command to publish a product based on a local manifest file.

```bash
publish --apollo-url=[url] --apollo-token=[token] manifest --manifest-file=[manifestPath]
```

--------------------------------

### Example: Accessing Entire File System

Source: https://www.palantir.com/docs/foundry/available-connectors/onelake-and-azure-blob-filesystem

Example of configuring the root directory to access all contents of a file system in Azure Data Lake Storage Gen2.

```text
abfss://file_system@account_name.dfs.core.windows.net/
```

--------------------------------

### Get Folders Batch Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/filesystem-v2-resources/folders/get-folders-batch

This is an example of a successful response from the Get Folders Batch endpoint. It returns a JSON object where keys are folder RIDs and values are folder objects containing details like projectRid, displayName, and path.

```json
{
  "data": {
    "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791": {
      "projectRid": "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
      "updatedTime": "2024-09-25T17:29:35.974Z",
      "updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "displayName": "My Folder",
      "description": "This dataset contains important data about Empyrean Airlines",
      "rid": "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8",
      "type": "FOLDER",
      "spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
      "trashStatus": "NOT_TRASHED",
      "parentFolderRid": "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
      "path": "/Empyrean Airlines/My Important Project/My Folder",
      "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "createdTime": "2024-09-25T17:29:35.974Z"
    }
  }
}
```

--------------------------------

### PowerShell Request Example

Source: https://www.palantir.com/docs/foundry/api/v2/media-sets-v2-resources/media-sets/get-media-item-info

Demonstrates how to make a GET request to the media item info endpoint using PowerShell. This example shows how to set the Authorization header and include the preview parameter.

```powershell
Invoke-RestMethod -Method Get -Uri "https://$($env:HOSTNAME)/api/v2/mediasets/$mediaSetRid/items/$mediaItemRid?preview=true" -Headers @{"Authorization" = "Bearer $TOKEN"}
```

--------------------------------

### Java Request Example

Source: https://www.palantir.com/docs/foundry/api/v2/media-sets-v2-resources/media-sets/get-media-item-reference

Illustrates how to call the Get Media Item Reference API using Java. This example uses Apache HttpClient and includes the necessary 'preview=true' query parameter.

```java
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import java.io.IOException;

// ... other imports

public class MediaReferenceClient {

    public static void main(String[] args) {
        String token = "YOUR_TOKEN";
        String hostname = "your_hostname.com";
        String mediaSetRid = "your_media_set_rid";
        String mediaItemRid = "your_media_item_rid";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            String url = String.format("https://%s/api/v2/mediasets/%s/items/%s/reference?preview=true", hostname, mediaSetRid, mediaItemRid);
            HttpGet request = new HttpGet(url);
            request.addHeader("Authorization", "Bearer " + token);

            String responseBody = httpClient.execute(request, httpResponse -> {
                int statusCode = httpResponse.getStatusLine().getStatusCode();
                if (statusCode >= 200 && statusCode < 300) {
                    return EntityUtils.toString(httpResponse.getEntity());
                } else {
                    throw new IOException("Request failed with status code: " + statusCode);
                }
            });

            System.out.println(responseBody);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

```

--------------------------------

### Get End Offsets Response Example

Source: https://www.palantir.com/docs/foundry/api/v2/streams-v2-resources/streams/get-end-offsets-for-stream

Example JSON response showing the end offsets for partitions '0' and '1' of a stream.

```json
{
 "0": 100,
 "1": 200
}
```
Tokens:
Raw