Palantir Foundry data contract | PatchOps Knowledge

What you can ask

“What does Palantir Foundry have for the area or asset I'm working on?”
“Pull the most recent Palantir Foundry records and put them in a table.”
“What does Palantir Foundry cover, and how fresh is the data?”

About this source

Palantir Foundry v2 enterprise data platform. The complete 412-operation union of the current official Python and TypeScript SDKs is pinned locally. Discovery uses collision-safe domain_resource_method names; execution uses exact verbs, paths, parameter locations, headers, and request-body aliases. Stack may be supplied per call or stored with the connection.

Connector ID palantir-foundry

Provenance

PublisherPalantir Foundry Platform Python and TypeScript SDKs v2

Sourcehttps://github.com/palantir/foundry-platform-python

Docshttps://www.palantir.com/docs/foundry/api/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (Bearer token)

Caveats

⚠ Available operations and records depend on the authenticated Foundry enrollment and permissions.
⚠ Binary request and response bodies are bounded; mutating operations require the PatchOps action lane.

› Methods (412)

Technical detail for developers: parameters, pagination, units, and freshness per method.

admin_authentication_provider_get
read
Get the AuthenticationProvider with the specified rid.
Required paramsauthentication_provider_ridenrollment_rid
Paginationnone
admin_authentication_provider_list
read
Lists all AuthenticationProviders.
Required paramsenrollment_rid
Paginationnone
admin_authentication_provider_preregister_group
write
Register a Group with a given name before any users with this group log in through this…
Required paramsauthentication_provider_ridenrollment_ridnameorganizations
Paginationnone
admin_authentication_provider_preregister_user
write
Register a User with a given username before they log in to the platform for the first time…
Required paramsauthentication_provider_ridenrollment_ridorganizationusername
Paginationnone
admin_cbac_banner_get
read
Returns a classification banner string and colors for the given set of marking IDs.
Paginationnone
admin_cbac_marking_restrictions_get
read
Returns disallowed, implied, and required markings for the given set of marking IDs.
Paginationnone
admin_enrollment_get
read
Get the Enrollment with the specified rid.
Required paramsenrollment_rid
Paginationnone
admin_enrollment_get_current
read
Returns the Enrollment associated with the current User's primary organization.
Paginationnone
admin_enrollment_role_assignment_add
write
Assign roles to principals for the given Enrollment.
Required paramsenrollment_ridrole_assignments
Paginationnone
admin_enrollment_role_assignment_list
read
List all principals who are assigned a role for the given Enrollment.
Required paramsenrollment_rid
Paginationnone
admin_enrollment_role_assignment_remove
write
Remove roles from principals for the given Enrollment.
Required paramsenrollment_ridrole_assignments
Paginationnone
admin_group_create
write
Creates a new Group.
Required paramsattributesnameorganizations
Paginationnone
admin_group_delete
write
Delete the Group with the specified id.
Required paramsgroup_id
Paginationnone
admin_group_get
read
Get the Group with the specified id.
Required paramsgroup_id
Paginationnone
admin_group_get_batch
read
Execute multiple get requests on Group.
Required paramsbody
Paginationnone
admin_group_list
read
Lists all Groups.
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_group_list_current
read
Returns all Groups which contain the current user as a direct or transitive member.
Paginationnone
admin_group_member_add
write
Official Palantir Foundry SDK operation.
Required paramsgroup_idprincipal_ids
Paginationnone
admin_group_member_list
read
Lists all members (which can be a User or a Group) of a given Group.
Required paramsgroup_id
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_group_member_remove
write
Official Palantir Foundry SDK operation.
Required paramsgroup_idprincipal_ids
Paginationnone
admin_group_membership_expiration_policy_get
read
Get the GroupMembershipExpirationPolicy.
Required paramsgroup_id
Paginationnone
admin_group_membership_expiration_policy_replace
write
Replace the GroupMembershipExpirationPolicy.
Required paramsgroup_id
Paginationnone
admin_group_membership_list
read
Lists all Groups a given User is a member of.
Required paramsuser_id
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_group_provider_info_get
read
Get the GroupProviderInfo.
Required paramsgroup_id
Paginationnone
admin_group_provider_info_replace
write
Replace the GroupProviderInfo.
Required paramsgroup_idprovider_id
Paginationnone
admin_group_replace
write
When replacing groups, you must send all attributes that begin with `multipass:` exactly as they…
Required paramsattributesgroup_idnameorganizations
Paginationnone
admin_group_search
read
Perform a case-insensitive prefix search for groups based on group name.
Required paramswhere
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_host_list
read
Lists all Hosts.
Required paramsenrollment_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_marking_category_create
write
Creates a new MarkingCategory.
Required paramsdescriptioninitial_permissionsname
Paginationnone
admin_marking_category_get
read
Get the MarkingCategory with the specified id.
Required paramsmarking_category_id
Paginationnone
admin_marking_category_list
read
Maximum page size 100.
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_marking_category_replace
write
Replace the MarkingCategory with the specified id.
Required paramsdescriptionmarking_category_idname
Paginationnone
admin_marking_create
write
Creates a new Marking.
Required paramscategory_idinitial_membersinitial_role_assignmentsname
Paginationnone
admin_marking_get
read
Get the Marking with the specified id.
Required paramsmarking_id
Paginationnone
admin_marking_get_batch
read
Execute multiple get requests on Marking.
Required paramsbody
Paginationnone
admin_marking_list
read
Maximum page size 100.
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_marking_member_add
write
Official Palantir Foundry SDK operation.
Required paramsmarking_idprincipal_ids
Paginationnone
admin_marking_member_list
read
Lists all principals who can view resources protected by the given Marking.
Required paramsmarking_id
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_marking_member_remove
write
Official Palantir Foundry SDK operation.
Required paramsmarking_idprincipal_ids
Paginationnone
admin_marking_parse_classifications
read
Parses classification marking strings (e.g.
Required paramsclassification_strings
Paginationnone
admin_marking_replace
write
Replace the Marking with the specified id.
Required paramsmarking_idname
Paginationnone
admin_marking_role_assignment_add
write
Adds role assignments for the given Marking.
Required paramsmarking_idrole_assignments
Paginationnone
admin_marking_role_assignment_list
read
List all principals who are assigned a role for the given Marking. Ignores the `pageSize` parameter.
Required paramsmarking_id
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_marking_role_assignment_remove
write
Removes role assignments for the given Marking.
Required paramsmarking_idrole_assignments
Paginationnone
admin_organization_create
write
Creates a new Organization.
Required paramsadministratorsenrollment_ridname
Paginationnone
admin_organization_get
read
Get the Organization with the specified rid.
Required paramsorganization_rid
Paginationnone
admin_organization_guest_member_add
write
Adds principals as guest members of an Organization.
Required paramsorganization_ridprincipal_ids
Paginationnone
admin_organization_guest_member_list
read
Lists all guest members of an Organization.
Required paramsorganization_rid
Paginationnone
admin_organization_guest_member_remove
write
Removes principals from being guest members of an Organization.
Required paramsorganization_ridprincipal_ids
Paginationnone
admin_organization_list_available_roles
read
List all roles that can be assigned to a principal for the given Organization.
Required paramsorganization_rid
Paginationnone
admin_organization_replace
write
Replace the Organization with the specified rid.
Required paramsnameorganization_rid
Paginationnone
admin_organization_role_assignment_add
write
Assign roles to principals for the given Organization.
Required paramsorganization_ridrole_assignments
Paginationnone
admin_organization_role_assignment_list
read
List all principals who are assigned a role for the given Organization.
Required paramsorganization_rid
Paginationnone
admin_organization_role_assignment_remove
write
Remove roles from principals for the given Organization.
Required paramsorganization_ridrole_assignments
Paginationnone
admin_role_get
read
Get the Role with the specified id.
Required paramsrole_id
Paginationnone
admin_role_get_batch
read
Execute multiple get requests on Role.
Required paramsbody
Paginationnone
admin_user_delete
write
Delete the User with the specified id.
Required paramsuser_id
Paginationnone
admin_user_get
read
Get the User with the specified id.
Required paramsuser_id
Paginationnone
admin_user_get_batch
read
Execute multiple get requests on User.
Required paramsbody
Paginationnone
admin_user_get_current
read
Official Palantir Foundry SDK operation.
Paginationnone
admin_user_get_markings
read
Retrieve Markings that the user is currently a member of.
Required paramsuser_id
Paginationnone
admin_user_list
read
Lists all Users.
Paginationtoken (tokenField: page_token, limitField: page_size)
admin_user_profile_picture
read
Official Palantir Foundry SDK operation.
Required paramsuser_id
Paginationnone
admin_user_provider_info_get
read
Get the UserProviderInfo.
Required paramsuser_id
Paginationnone
admin_user_provider_info_replace
write
Replace the UserProviderInfo.
Required paramsprovider_iduser_id
Paginationnone
admin_user_revoke_all_tokens
write
Revoke all active authentication tokens for the user including active browser sessions and…
Required paramsuser_id
Paginationnone
admin_user_search
read
Perform a case-insensitive prefix search for active users based on username, given name and family…
Required paramswhere
Paginationtoken (tokenField: page_token, limitField: page_size)
aip_agents_agent_all_sessions
read
List all conversation sessions between the calling user and all accessible Agents that were…
Paginationtoken (tokenField: page_token, limitField: page_size)
aip_agents_agent_get
read
Get details for an Agent.
Required paramsagent_rid
Paginationnone
aip_agents_agent_version_get
read
Get version details for an Agent.
Required paramsagent_ridagent_version_string
Paginationnone
aip_agents_agent_version_list
read
List all versions for an Agent.
Required paramsagent_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
aip_agents_content_get
read
Get the conversation content for a session between the calling user and an Agent.
Required paramsagent_ridsession_rid
Paginationnone
aip_agents_session_blocking_continue
write
Continue a conversation session with an Agent, or add the first exchange to a session after…
Required paramsagent_ridparameter_inputssession_riduser_input
Paginationnone
aip_agents_session_cancel
write
Cancel an in-progress streamed exchange with an Agent which was initiated with `streamingContinue`.
Required paramsagent_ridmessage_idsession_rid
Paginationnone
aip_agents_session_create
write
Create a new conversation session between the calling user and an Agent.
Required paramsagent_rid
Paginationnone
aip_agents_session_delete
write
Delete a conversation session between the calling user and an Agent.
Required paramsagent_ridsession_rid
Paginationnone
aip_agents_session_get
read
Get the details of a conversation session between the calling user and an Agent.
Required paramsagent_ridsession_rid
Paginationnone
aip_agents_session_list
read
List all conversation sessions between the calling user and an Agent that was created by this…
Required paramsagent_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
aip_agents_session_rag_context
write
Retrieve relevant [context](https://palantir.com/docs/foundry/chatbot-studio/core-concepts/#retriev…
Required paramsagent_ridparameter_inputssession_riduser_input
Paginationnone
aip_agents_session_streaming_continue
write
Continue a conversation session with an Agent, or add the first exchange to a session after…
Required paramsagent_ridparameter_inputssession_riduser_input
Paginationnone
aip_agents_session_trace_get
read
Get the trace of an Agent response.
Required paramsagent_ridsession_ridsession_trace_id
Paginationnone
aip_agents_session_update_title
write
Update the title for a session.
Required paramsagent_ridsession_ridtitle
Paginationnone
audit_log_file_content
read
Official Palantir Foundry SDK operation.
Required paramslog_file_idorganization_rid
Paginationnone
audit_log_file_list
read
Lists all LogFiles.
Required paramsorganization_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
checkpoints_record_get
read
Retrieve a single checkpoint record by id.
Required paramsrecord_rid
Paginationnone
checkpoints_record_get_batch
read
Fetch multiple checkpoint records in a single request.
Required paramsbody
Paginationnone
checkpoints_record_search
read
Search for checkpoint records.
Required paramswhere
Paginationtoken (tokenField: page_token, limitField: page_size)
connectivity_connection_create
write
Creates a new Connection with a [direct connection](https://palantir.com/docs/foundry/data-connecti…
Required paramsconfigurationdisplay_nameparent_folder_ridworker
Paginationnone
connectivity_connection_get
read
Get the Connection with the specified rid.
Required paramsconnection_rid
Paginationnone
connectivity_connection_get_configuration
read
Retrieves the ConnectionConfiguration of the [Connection](https://palantir.com/docs/foundry/data-co…
Required paramsconnection_rid
Paginationnone
connectivity_connection_get_configuration_batch
read
Returns a map of Connection RIDs to their corresponding configurations.
Required paramsbody
Paginationnone
connectivity_connection_update_export_settings
write
Updates the [export settings on the Connection.](https://palantir.com/docs/foundry/data-connection/…
Required paramsconnection_ridexport_settings
Paginationnone
connectivity_connection_update_secrets
write
Updates the secrets on the connection to the specified secret values.
Required paramsconnection_ridsecrets
Paginationnone
connectivity_connection_upload_custom_jdbc_drivers
write
Upload custom jdbc drivers to an existing JDBC connection.
Required paramsbodyconnection_ridfile_name
Paginationnone
connectivity_file_import_create
write
Creates a new FileImport.
Required paramsconnection_riddataset_riddisplay_namefile_import_filtersimport_mode
Paginationnone
connectivity_file_import_delete
write
Delete the FileImport with the specified RID.
Required paramsconnection_ridfile_import_rid
Paginationnone
connectivity_file_import_execute
write
Executes the FileImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/f…
Required paramsconnection_ridfile_import_rid
Paginationnone
connectivity_file_import_get
read
Get the FileImport with the specified rid.
Required paramsconnection_ridfile_import_rid
Paginationnone
connectivity_file_import_list
read
Lists all file imports defined for this connection.
Required paramsconnection_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
connectivity_file_import_replace
write
Replace the FileImport with the specified rid.
Required paramsconnection_riddisplay_namefile_import_filtersfile_import_ridimport_mode
Paginationnone
connectivity_table_import_create
write
Creates a new TableImport.
Required paramsconfigconnection_riddataset_riddisplay_nameimport_mode
Paginationnone
connectivity_table_import_delete
write
Delete the TableImport with the specified RID.
Required paramsconnection_ridtable_import_rid
Paginationnone
connectivity_table_import_execute
write
Executes the TableImport, which runs asynchronously as a [Foundry…
Required paramsconnection_ridtable_import_rid
Paginationnone
connectivity_table_import_get
read
Get the TableImport with the specified rid.
Required paramsconnection_ridtable_import_rid
Paginationnone
connectivity_table_import_list
read
Lists all table imports defined for this connection.
Required paramsconnection_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
connectivity_table_import_replace
write
Replace the TableImport with the specified rid.
Required paramsconfigconnection_riddisplay_nameimport_modetable_import_rid
Paginationnone
connectivity_virtual_table_create
write
Creates a new [Virtual Table](https://palantir.com/docs/foundry/data-integration/virtual-tables/)…
Required paramsconfigconnection_ridnameparent_rid
Paginationnone
data_health_check_create
write
Creates a new Check.
Required paramsconfig
Paginationnone
data_health_check_delete
write
Delete the Check with the specified rid.
Required paramscheck_rid
Paginationnone
data_health_check_get
read
Get the Check with the specified rid.
Required paramscheck_rid
Paginationnone
data_health_check_replace
write
Replace the Check with the specified rid.
Required paramscheck_ridconfig
Paginationnone
data_health_check_report_get
read
Get the CheckReport with the specified rid.
Required paramscheck_report_ridcheck_rid
Paginationnone
data_health_check_report_get_latest
read
Get the most recent check reports for this Check.
Required paramscheck_rid
Paginationnone
datasets_branch_create
write
Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.
Required paramsdataset_ridname
Paginationnone
datasets_branch_delete
write
Deletes the Branch with the given BranchName.
Required paramsbranch_namedataset_rid
Paginationnone
datasets_branch_get
read
Get a Branch of a Dataset.
Required paramsbranch_namedataset_rid
Paginationnone
datasets_branch_list
read
Lists the Branches of a Dataset.
Required paramsdataset_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
datasets_branch_transactions
read
Get the Transaction history for the given Dataset.
Required paramsbranch_namedataset_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
datasets_dataset_create
write
Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the…
Required paramsnameparent_folder_rid
Paginationnone
datasets_dataset_get
read
Get the Dataset with the specified rid.
Required paramsdataset_rid
Paginationnone
datasets_dataset_get_health_check_reports
read
Get the most recent Data Health Check report for each check configured on the given Dataset.
Required paramsdataset_rid
Paginationnone
datasets_dataset_get_health_checks
read
Get the RIDs of the Data Health Checks that are configured for the given Dataset.
Required paramsdataset_rid
Paginationnone
datasets_dataset_get_schedules
read
Get the RIDs of the Schedules that target the given Dataset.
Required paramsdataset_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
datasets_dataset_get_schema
read
Gets a dataset's schema.
Required paramsdataset_rid
Paginationnone
datasets_dataset_get_schema_batch
read
Fetch schemas for multiple datasets in a single request.
Required paramsbody
Paginationnone
datasets_dataset_jobs
read
Get the RIDs of the Jobs for the given dataset.
Required paramsdataset_ridorder_by
Paginationtoken (tokenField: page_token, limitField: page_size)
datasets_dataset_put_schema
write
Adds a schema on an existing dataset using a PUT request.
Required paramsdataset_ridschema
Paginationnone
datasets_dataset_read_table
read
Gets the content of a dataset as a table in the specified format.
Required paramsdataset_ridformat
Paginationnone
datasets_dataset_transactions
read
Get the Transaction history for the given Dataset.
Required paramsdataset_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
datasets_file_content
read
Gets the content of a File contained in a Dataset.
Required paramsdataset_ridfile_path
Paginationnone
datasets_file_delete
write
Deletes a File from a Dataset.
Required paramsdataset_ridfile_path
Paginationnone
datasets_file_get
read
Gets metadata about a File contained in a Dataset.
Required paramsdataset_ridfile_path
Paginationnone
datasets_file_list
read
Lists Files contained in a Dataset.
Required paramsdataset_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
datasets_file_upload
write
Uploads a File to an existing Dataset.
Required paramsbodydataset_ridfile_path
Paginationnone
datasets_transaction_abort
write
Aborts an open Transaction.
Required paramsdataset_ridtransaction_rid
Paginationnone
datasets_transaction_build
read
Get the [Build](https://palantir.com/docs/foundry/data-integration/builds#builds) that computed…
Required paramsdataset_ridtransaction_rid
Paginationnone
datasets_transaction_commit
write
Commits an open Transaction.
Required paramsdataset_ridtransaction_rid
Paginationnone
datasets_transaction_create
write
Creates a Transaction on a Branch of a Dataset.
Required paramsdataset_ridtransaction_type
Paginationnone
datasets_transaction_get
read
Gets a Transaction of a Dataset.
Required paramsdataset_ridtransaction_rid
Paginationnone
datasets_transaction_job
read
Get the [Job](https://palantir.com/docs/foundry/data-integration/builds#jobs-and-jobspecs) that…
Required paramsdataset_ridtransaction_rid
Paginationnone
datasets_view_add_backing_datasets
write
Adds one or more backing datasets to a View.
Required paramsbacking_datasetsview_dataset_rid
Paginationnone
datasets_view_add_primary_key
write
Adds a primary key to a View that does not already have one.
Required paramsprimary_keyview_dataset_rid
Paginationnone
datasets_view_create
write
Create a new View.
Required paramsbacking_datasetsparent_folder_ridview_name
Paginationnone
datasets_view_get
read
Get metadata for a View.
Required paramsview_dataset_rid
Paginationnone
datasets_view_remove_backing_datasets
write
Removes specified backing datasets from a View.
Required paramsbacking_datasetsview_dataset_rid
Paginationnone
datasets_view_replace_backing_datasets
write
Replaces the backing datasets for a View.
Required paramsbacking_datasetsview_dataset_rid
Paginationnone
filesystem_folder_children
read
List all child resources of the Folder.
Required paramsfolder_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
filesystem_folder_create
write
Creates a new Folder.
Required paramsdisplay_nameparent_folder_rid
Paginationnone
filesystem_folder_get
read
Get the Folder with the specified rid.
Required paramsfolder_rid
Paginationnone
filesystem_folder_get_batch
read
Fetches multiple folders in a single request.
Required paramsbody
Paginationnone
filesystem_folder_replace
write
Replace the Folder with the specified rid.
Required paramsdisplay_namefolder_ridparent_folder_rid
Paginationnone
filesystem_project_add_organizations
write
Adds a list of Organizations to a Project.
Required paramsorganization_ridsproject_rid
Paginationnone
filesystem_project_create
write
Creates a new Project.
Required paramsdefault_rolesdisplay_nameorganization_ridsrole_grantsspace_rid
Paginationnone
filesystem_project_create_from_template
write
Creates a project from a project template.
Required paramstemplate_ridvariable_values
Paginationnone
filesystem_project_get
read
Get the Project with the specified rid.
Required paramsproject_rid
Paginationnone
filesystem_project_organizations
read
List of Organizations directly applied to a Project.
Required paramsproject_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
filesystem_project_remove_organizations
write
Removes Organizations from a Project.
Required paramsorganization_ridsproject_rid
Paginationnone
filesystem_project_replace
write
Replace the Project with the specified rid.
Required paramsdisplay_nameproject_rid
Paginationnone
filesystem_project_resource_reference_add
write
Add references to the given project
Required paramsproject_ridresources
Paginationnone
filesystem_project_resource_reference_list
read
List all references in the given project
Required paramsproject_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
filesystem_project_resource_reference_remove
write
Remove references from the given project
Required paramsproject_ridresources
Paginationnone
filesystem_resource_add_markings
write
Adds a list of Markings to a resource.
Required paramsmarking_idsresource_rid
Paginationnone
filesystem_resource_delete
write
Move the given resource to the trash.
Required paramsresource_rid
Paginationnone
filesystem_resource_get
read
Get the Resource with the specified rid.
Required paramsresource_rid
Paginationnone
filesystem_resource_get_access_requirements
read
Returns a list of access requirements a user needs in order to view a resource.
Required paramsresource_rid
Paginationnone
filesystem_resource_get_batch
read
Fetches multiple resources in a single request.
Required paramsbody
Paginationnone
filesystem_resource_get_by_path
read
Get a resource by its absolute path.
Required paramspath
Paginationnone
filesystem_resource_get_by_path_batch
read
Gets multiple resources by their absolute paths.
Required paramsbody
Paginationnone
filesystem_resource_get_recently_viewed
read
Get the resources most recently viewed by the calling user.
Paginationnone
filesystem_resource_markings
read
List of Markings directly applied to a resource.
Required paramsresource_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
filesystem_resource_permanently_delete
write
Permanently delete the given resource from the trash.
Required paramsresource_rid
Paginationnone
filesystem_resource_remove_markings
write
Removes Markings from a resource.
Required paramsmarking_idsresource_rid
Paginationnone
filesystem_resource_restore
write
Restore the given resource and any directly trashed ancestors from the trash.
Required paramsresource_rid
Paginationnone
filesystem_resource_role_add
write
Official Palantir Foundry SDK operation.
Required paramsresource_ridroles
Paginationnone
filesystem_resource_role_list
read
List the roles on a resource.
Required paramsresource_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
filesystem_resource_role_remove
write
Official Palantir Foundry SDK operation.
Required paramsresource_ridroles
Paginationnone
filesystem_resource_tag_add
write
Apply tags to a resource.
Required paramsresource_ridtag_rids
Paginationnone
filesystem_resource_tag_list
read
List the tags applied to a resource.
Required paramsresource_rid
Paginationnone
filesystem_resource_tag_remove
write
Remove tags from a resource.
Required paramsresource_ridtag_rids
Paginationnone
filesystem_space_create
write
Creates a new Space.
Required paramsdeletion_policy_organizationsdisplay_nameenrollment_ridorganizations
Paginationnone
filesystem_space_delete
write
Delete the space. This will only work if the Space is empty, meaning any Projects or resources…
Required paramsspace_rid
Paginationnone
filesystem_space_get
read
Get the Space with the specified rid.
Required paramsspace_rid
Paginationnone
filesystem_space_list
read
Lists all Spaces.
Paginationtoken (tokenField: page_token, limitField: page_size)
filesystem_space_replace
write
Replace the Space with the specified rid.
Required paramsdisplay_namespace_rid
Paginationnone
functions_execution_cancel
write
Cancel a running async query execution. This endpoint is idempotent.
Required paramsexecution_id
Paginationnone
functions_execution_get_result
read
Poll for the result of an async query execution.
Required paramsexecution_id
Paginationnone
functions_query_execute
read
Executes a Query and returns the result as a single JSON object.
Required paramsparametersquery_api_name
Paginationnone
functions_query_execute_async
write
Submits a Query for asynchronous execution.
Required paramsparametersquery_api_name
Paginationnone
functions_query_get
read
Gets a specific query type with the given API name.
Required paramsquery_api_name
Paginationnone
functions_query_get_by_rid
read
Gets a specific query type with the given RID.
Required paramsrid
Paginationnone
functions_query_get_by_rid_batch
read
Gets a list of query types by RID in bulk. By default, this gets the latest version of each query.
Required paramsbody
Paginationnone
functions_query_streaming_execute
read
Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
Required paramsparametersquery_api_name
Paginationnone
functions_query_streaming_execute_events
read
Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
Required paramsparametersquery_api_name
Paginationnone
functions_value_type_get
read
Gets a specific value type with the given RID. The latest version is returned.
Required paramsvalue_type_rid
Paginationnone
functions_version_id_get
read
Gets a specific version of a value type with the given RID and version ID.
Required paramsvalue_type_ridversion_id_version_id
Paginationnone
language_models_anthropic_model_messages
read
Official Palantir Foundry SDK operation.
Required paramsanthropic_model_model_idmax_tokensmessages
Paginationnone
language_models_open_ai_model_embeddings
read
Official Palantir Foundry SDK operation.
Required paramsinputopen_ai_model_model_id
Paginationnone
media_sets_media_set_abort
write
Aborts an open transaction. Items uploaded to the media set during this transaction will be deleted.
Required paramsmedia_set_ridtransaction_id
Paginationnone
media_sets_media_set_calculate
read
Starts calculation of a thumbnail for a given image.
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_clear
write
Clears (soft-deletes) the media item at the specified path within a media set, making it and all…
Required paramsmedia_item_pathmedia_set_rid
Paginationnone
media_sets_media_set_commit
write
Commits an open transaction.
Required paramsmedia_set_ridtransaction_id
Paginationnone
media_sets_media_set_create
write
Creates a new transaction.
Required paramsmedia_set_rid
Paginationnone
media_sets_media_set_get
read
Gets information about the media set.
Required paramsmedia_set_rid
Paginationnone
media_sets_media_set_get_result
read
Gets the result of a completed transformation job.
Required paramsmedia_item_ridmedia_set_ridtransformation_job_id
Paginationnone
media_sets_media_set_get_rid_by_path
read
Returns the media item RID for the media item with the specified path.
Required paramsmedia_item_pathmedia_set_rid
Paginationnone
media_sets_media_set_get_status
read
Gets the status of a transformation job.
Required paramsmedia_item_ridmedia_set_ridtransformation_job_id
Paginationnone
media_sets_media_set_info
read
Gets information about the media item.
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_metadata
read
Gets detailed metadata about the media item, including type-specific information such as…
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_read
read
Gets the content of a media item.
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_read_original
read
Gets the content of an original file uploaded to the media item, even if it was transformed on…
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_reference
read
Gets the [media reference](https://palantir.com/docs/foundry/data-integration/media-sets/#media-ref…
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_register
write
Registers a media item that currently resides in a federated media store.
Required paramsmedia_set_ridphysical_item_name
Paginationnone
media_sets_media_set_retrieve
read
Retrieves a successfully calculated thumbnail for a given image.
Required paramsmedia_item_ridmedia_set_rid
Paginationnone
media_sets_media_set_transform
write
Initiates a transformation on a media item.
Required paramsmedia_item_ridmedia_set_ridtransformation
Paginationnone
media_sets_media_set_upload
write
Uploads a media item to an existing media set.
Required paramsbodymedia_set_rid
Paginationnone
media_sets_media_set_upload_media
write
Uploads a temporary media item.
Required paramsbodyfilename
Paginationnone
models_experiment_artifact_table_json
read
Read table data from an experiment artifact as a streamed binary response containing JSON.
Required paramsexperiment_artifact_table_nameexperiment_ridmodel_rid
Paginationoffset (offsetField: offset, limitField: page_size)
models_experiment_artifact_table_parquet
read
Read raw table data from experiment artifacts in Parquet format.
Required paramsexperiment_artifact_table_nameexperiment_ridmodel_rid
Paginationnone
models_experiment_get
read
Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics.
Required paramsexperiment_ridmodel_rid
Paginationnone
models_experiment_search
read
Search experiments using complex nested queries on experiment metadata, parameters, series, and…
Required paramsmodel_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
models_experiment_series_json
read
Retrieve raw time-series data for a single series in JSON format.
Required paramsexperiment_ridexperiment_series_namemodel_rid
Paginationoffset (offsetField: offset, limitField: page_size)
models_experiment_series_parquet
read
Retrieve raw time-series data for a single series as a streamed binary response in Apache Parquet…
Required paramsexperiment_ridexperiment_series_namemodel_rid
Paginationnone
models_live_deployment_create
write
Creates a new live deployment for a model version with the specified runtime configuration.
Required paramsdeployment_typeruntime_configuration
Paginationnone
models_live_deployment_get
read
Retrieves a live deployment by its Resource Identifier (RID), including its deployed model version…
Required paramslive_deployment_rid
Paginationnone
models_live_deployment_list
read
Lists direct live deployments for the specified Model, optionally filtered by branch.
Required paramsmodel_rid
Paginationnone
models_live_deployment_replace
write
Updates the runtime configuration of the live deployment.
Required paramslive_deployment_ridruntime_configuration
Paginationnone
models_live_deployment_transform_json
read
Performs inference on the live deployment.
Required paramsinputlive_deployment_rid
Paginationnone
models_model_create
write
Creates a new Model with no versions.
Required paramsnameparent_folder_rid
Paginationnone
models_model_function_create
write
Creates a function for the model.
Required paramsapi_namedisplay_nameis_row_wisemodel_rid
Paginationnone
models_model_function_get
read
Gets the function for the model.
Required paramsmodel_rid
Paginationnone
models_model_function_replace
write
Replaces the function for the model.
Required paramsapi_nameis_row_wisemodel_rid
Paginationnone
models_model_get
read
Retrieves a Model by its Resource Identifier (RID).
Required paramsmodel_rid
Paginationnone
models_model_promote_version
write
Promotes an existing Model Version to the target Model.
Required paramsmodel_ridsource_model_version_rid
Paginationnone
models_model_studio_config_version_create
write
Creates a new Model Studio configuration version.
Required paramsmodel_studio_ridnameresourcestrainer_idworker_config
Paginationnone
models_model_studio_config_version_get
read
Gets a specific Model Studio configuration version.
Required paramsmodel_studio_config_version_versionmodel_studio_rid
Paginationnone
models_model_studio_config_version_latest
read
Gets the latest configuration version for a Model Studio.
Required paramsmodel_studio_rid
Paginationnone
models_model_studio_config_version_list
read
Lists all configuration versions for a Model Studio.
Required paramsmodel_studio_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
models_model_studio_create
write
Creates a new Model Studio.
Required paramsnameparent_folder_rid
Paginationnone
models_model_studio_get
read
Gets details about a Model Studio by its RID.
Required paramsmodel_studio_rid
Paginationnone
models_model_studio_launch
write
Launches a new training run for the Model Studio using the latest configuration version.
Required paramsmodel_studio_rid
Paginationnone
models_model_studio_run_list
read
Lists all runs for a Model Studio.
Required paramsmodel_studio_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
models_model_studio_trainer_get
read
Gets details about a specific trainer by its ID and optional version.
Required paramsmodel_studio_trainer_trainer_id
Paginationnone
models_model_studio_trainer_list
read
Lists all available trainers for Model Studios.
Paginationnone
models_model_version_create
write
Creates a new Model Version on an existing model.
Required paramsbacking_repositoriesconda_requirementsmodel_apimodel_filesmodel_rid
Paginationnone
models_model_version_get
read
Retrieves a Model Version by its Resource Identifier (RID).
Required paramsmodel_ridmodel_version_rid
Paginationnone
models_model_version_list
read
Lists all Model Versions for a given Model.
Required paramsmodel_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
notepad_export_job_create
write
Creates a new ExportJob either from an existing Document or using the content generated by a…
Required paramsbody
Paginationnone
notepad_export_job_get
read
Loads an ExportJob. This endpoint is used to monitor job progress.
Required paramsexport_job_rid
Paginationnone
notepad_file_content
read
Download file content.
Required paramsfile_rid
Paginationnone
notepad_generation_job_get
read
Load an existing GenerationJob. This is used to monitor job progress.
Required paramsgeneration_job_ridtemplate_rid
Paginationnone
notepad_generation_job_save_document
write
Save generated content as a new notepad document.
Required paramsbodygeneration_job_ridtemplate_rid
Paginationnone
notepad_template_generate
write
Creates a new GenerationJob.
Required paramsbodytemplate_rid
Paginationnone
ontologies_action_apply
write
Applies an action using the given parameters.
Required paramsactionontologyparameters
Paginationnone
ontologies_action_apply_async
write
Applies an action using the given parameters.
Required paramsactionbodyontology
Paginationnone
ontologies_action_apply_batch
write
Applies multiple actions (of the same Action Type) using the given parameters.
Required paramsactionontologyrequests
Paginationnone
ontologies_action_apply_batch_with_overrides
write
Applies multiple actions (of the same Action Type) with per-item overrides for UniqueIdentifier…
Required paramsactionontologyrequests
Paginationnone
ontologies_action_apply_with_overrides
write
Same as regular apply action operation, but allows specifying overrides for UniqueIdentifier and…
Required paramsactionontologyoverridesrequest
Paginationnone
ontologies_action_type_full_metadata_get
read
Gets the full metadata associated with an action type.
Required paramsaction_typeontology
Paginationnone
ontologies_action_type_full_metadata_get_full_metadata_batch
read
Gets a list of action types with full metadata (parameters and logic rules) by their API names in…
Required paramsontologyrequests
Paginationnone
ontologies_action_type_full_metadata_list
read
Lists the action types (with full metadata) for the given Ontology.
Required paramsontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_action_type_get
read
Gets a specific action type with the given API name.
Required paramsaction_typeontology
Paginationnone
ontologies_action_type_get_by_rid
read
Gets a specific action type with the given RID.
Required paramsaction_type_ridontology
Paginationnone
ontologies_action_type_get_by_rid_batch
read
Gets a list of action types by RID in bulk.
Required paramsontologyrequests
Paginationnone
ontologies_action_type_list
read
Lists the action types for the given Ontology.
Required paramsontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_action_type_search
read
Search for action types in the given Ontology that match the provided filters.
Required paramsontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_attachment_get
read
Get the metadata of an attachment.
Required paramsattachment_rid
Paginationnone
ontologies_attachment_property_get_attachment
read
Get the metadata of attachments parented to the given object.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_attachment_property_get_attachment_by_rid
read
Get the metadata of a particular attachment in an attachment list.
Required paramsattachment_ridobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_attachment_property_read_attachment
read
Get the content of an attachment.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_attachment_property_read_attachment_by_rid
read
Get the content of an attachment by its RID.
Required paramsattachment_ridobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_attachment_read
read
Get the content of an attachment.
Required paramsattachment_rid
Paginationnone
ontologies_attachment_upload
write
Upload an attachment to use in an action.
Required paramsbodycontent_typefilename
Paginationnone
ontologies_attachment_upload_with_rid
write
This endpoint is identical to `/v2/ontologies/attachments/upload` but additionally accepts a…
Required paramsattachment_ridbodycontent_typefilename
Paginationnone
ontologies_cipher_text_property_decrypt
read
Decrypt the value of a ciphertext property.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_cipher_text_property_encrypt
read
Encrypt a plaintext value into a CipherText value for the given object's CipherText property.
Required paramsobject_typeontologyplaintextprimary_keyproperty
Paginationnone
ontologies_cipher_text_property_encrypt_with_default_channel
read
Encrypt a plaintext value into a CipherText value for the given object type property.
Required paramsobject_typeontologyplaintextproperty
Paginationnone
ontologies_geotemporal_series_property_load_geotemporal_series_entries
read
Load the geotemporal series entries for a given object's geotemporal series reference property…
Required paramsadditional_propertiesobject_typeontologyprimary_keypropertyrange
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_linked_object_get_linked_object
read
Get a specific linked object that originates from another object.
Required paramslink_typelinked_object_primary_keyobject_typeontologyprimary_key
Paginationnone
ontologies_linked_object_list_linked_objects
read
Lists the linked objects for a specific object and the given link type.
Required paramslink_typeobject_typeontologyprimary_key
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_media_reference_property_get_media_content
read
Gets the content of a media item referenced by this property.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_media_reference_property_get_media_metadata
read
Gets metadata about the media item referenced by this property.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_media_reference_property_upload
write
Official Palantir Foundry SDK operation.
Required paramsbodyobject_typeontologyproperty
Paginationnone
ontologies_object_type_get
read
Gets a specific object type with the given API name.
Required paramsobject_typeontology
Paginationnone
ontologies_object_type_get_by_rid_batch
read
Gets a list of object types by RID in bulk.
Required paramsontologyrequests
Paginationnone
ontologies_object_type_get_edits_history
read
Returns the history of edits (additions, modifications, deletions) for objects of a specific…
Required paramsobject_typeontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_object_type_get_full_metadata
read
Gets the full metadata for a specific object type with the given API name.
Required paramsobject_typeontology
Paginationnone
ontologies_object_type_get_full_metadata_batch
read
Gets the full metadata for a batch of object types, identified by their API names.
Required paramsontologyrequests
Paginationnone
ontologies_object_type_get_outgoing_link_type
read
Get an outgoing link for an object type.
Required paramslink_typeobject_typeontology
Paginationnone
ontologies_object_type_get_outgoing_link_types_by_object_type_rid_batch
read
Gets outgoing link types for a batch of object types, identified by their RIDs.
Required paramsfilter_link_type_ridsontologyrequests
Paginationnone
ontologies_object_type_list
read
Lists the object types for the given Ontology.
Required paramsontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_object_type_list_outgoing_link_types
read
List the outgoing links for an object type.
Required paramsobject_typeontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_get
read
Gets a specific ontology for a given Ontology API name or RID.
Required paramsontology
Paginationnone
ontologies_ontology_get_full_metadata
read
Get the full Ontology metadata.
Required paramsontology
Paginationnone
ontologies_ontology_interface_aggregate
read
Official Palantir Foundry SDK operation.
Required paramsaggregationgroup_byinterface_typeontology
Paginationnone
ontologies_ontology_interface_get
read
Gets a specific interface type with the given API name.
Required paramsinterface_typeontology
Paginationnone
ontologies_ontology_interface_get_outgoing_interface_link_type
read
Get an outgoing interface link type for an interface type.
Required paramsinterface_link_typeinterface_typeontology
Paginationnone
ontologies_ontology_interface_list
read
Lists the interface types for the given Ontology.
Required paramsontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_interface_list_interface_linked_objects
read
Lists the linked objects for a specific object and the given interface link type.
Required paramsinterface_link_typeinterface_typeobject_typeontologyprimary_key
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_interface_list_objects_for_interface
read
Lists the objects for the given Ontology and interface type.
Required paramsinterface_typeontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_interface_list_outgoing_interface_link_types
read
List the outgoing interface link types for an interface type.
Required paramsinterface_typeontology
Paginationnone
ontologies_ontology_interface_search
read
Official Palantir Foundry SDK operation.
Required paramsaugmented_interface_property_typesaugmented_propertiesaugmented_shared_property_typesinterface_typeontologyother_interface_typesselected_interface_property_typesselected_object_typesselected_shared_property_types
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_list
read
Lists the Ontologies visible to the current user.
Paginationnone
ontologies_ontology_load_metadata
read
Load Ontology metadata for the requested object, link, action, query, and interface types.
Required paramsaction_typesinterface_typeslink_typesobject_typesontologyquery_types
Paginationnone
ontologies_ontology_object_aggregate
read
Perform functions on object fields in the specified ontology and object type.
Required paramsaggregationgroup_byobject_typeontology
Paginationnone
ontologies_ontology_object_count
read
Returns a count of the objects of the given object type.
Required paramsobject_typeontology
Paginationnone
ontologies_ontology_object_get
read
Gets a specific object with the given primary key.
Required paramsobject_typeontologyprimary_key
Paginationnone
ontologies_ontology_object_list
read
Lists the objects for the given Ontology and object type.
Required paramsobject_typeontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_object_search
read
Search for objects in the specified ontology and object type.
Required paramsobject_typeontologyselect
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_object_set_aggregate
read
Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.
Required paramsaggregationgroup_byobject_setontology
Paginationnone
ontologies_ontology_object_set_create_temporary
write
Creates a temporary `ObjectSet` from the given definition. This `ObjectSet` expires after one hour.
Required paramsobject_setontology
Paginationnone
ontologies_ontology_object_set_get
read
Gets the definition of the `ObjectSet` with the given RID.
Required paramsobject_set_ridontology
Paginationnone
ontologies_ontology_object_set_load
read
Load the ontology objects present in the `ObjectSet` from the provided object set definition.
Required paramsobject_setontologyselect
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_object_set_load_links
read
Loads the specified links from the defined object set.
Required paramslinksobject_setontology
Paginationtoken (tokenField: page_token)
ontologies_ontology_object_set_load_multiple_object_types
read
Load the ontology objects present in the `ObjectSet` from the provided object set definition.
Required paramsobject_setontologyselect
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_object_set_load_objects_or_interfaces
read
Load the ontology objects present in the `ObjectSet` from the provided object set definition.
Required paramsobject_setontologyselect
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_scenario_create_scenario
write
Creates an ontology scenario.
Required paramsontology
Paginationnone
ontologies_ontology_scenario_list_scenario_conflicting_objects
read
Returns the list of objects with edits that conflict with edits to the scenario's base for a…
Required paramsobject_typeontologyscenario_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_scenario_list_scenario_edited_entity_types
read
Returns the object types and link types that have been modified within a given scenario.
Required paramsontologyscenario_rid
Paginationnone
ontologies_ontology_scenario_list_scenario_edited_link_types
read
Returns the list of outgoing links that have been modified within a given scenario for an object…
Required paramsobject_typeontologyscenario_rid
Paginationnone
ontologies_ontology_scenario_list_scenario_edited_links
read
Returns the list of edited links within a given scenario for a specific object type and link type…
Required paramslink_typeobject_typeontologyscenario_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_scenario_list_scenario_edited_object_types
read
Returns the list of object type API names that have been modified within a given scenario.
Required paramsontologyscenario_rid
Paginationnone
ontologies_ontology_scenario_list_scenario_edited_objects
read
Returns the list of objects that have been edited within a given scenario for a specific object…
Required paramsobject_typeontologyscenario_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_ontology_transaction_post_edits
write
Applies a set of edits to a transaction in order.
Required paramseditsontologytransaction_id
Paginationnone
ontologies_ontology_value_type_get
read
Gets a specific value type with the given API name.
Required paramsontologyvalue_type
Paginationnone
ontologies_ontology_value_type_list
read
Lists the latest versions of the value types for the given Ontology.
Required paramsontology
Paginationnone
ontologies_query_execute
read
Executes a Query using the given parameters.
Required paramsontologyparametersquery_api_name
Paginationnone
ontologies_query_type_get
read
Gets a specific query type with the given API name.
Required paramsontologyquery_api_name
Paginationnone
ontologies_query_type_get_by_rid_batch
read
Gets a list of query types by RID in bulk.
Required paramsontologyrequests
Paginationnone
ontologies_query_type_list
read
Lists the query types for the given Ontology.
Required paramsontology
Paginationtoken (tokenField: page_token, limitField: page_size)
ontologies_time_series_property_v2_get_first_point
read
Get the first point of a time series property.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_time_series_property_v2_get_last_point
read
Get the last point of a time series property.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_time_series_property_v2_stream_points
read
Stream all of the points of a time series property.
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
ontologies_time_series_value_bank_property_get_latest_value
read
Get the latest value of a property backed by a timeseries.
Required paramsobject_typeontologyprimary_keyproperty_name
Paginationnone
ontologies_time_series_value_bank_property_stream_values
read
Stream all of the points of a time series property (this includes geotime series references).
Required paramsobject_typeontologyprimary_keyproperty
Paginationnone
operations_async_operation_get
read
Get an asynchronous operation by its ID.
Required paramsoperation_id
Paginationnone
orchestration_build_cancel
write
Request a cancellation for all unfinished jobs in a build.
Required paramsbuild_rid
Paginationnone
orchestration_build_create
write
Official Palantir Foundry SDK operation.
Required paramsfallback_branchestarget
Paginationnone
orchestration_build_get
read
Get the Build with the specified rid.
Required paramsbuild_rid
Paginationnone
orchestration_build_get_batch
read
Execute multiple get requests on Build.
Required paramsbody
Paginationnone
orchestration_build_jobs
read
Get the Jobs in the Build.
Required paramsbuild_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
orchestration_build_search
read
Search for Builds.
Required paramswhere
Paginationtoken (tokenField: page_token, limitField: page_size)
orchestration_job_get
read
Get the Job with the specified rid.
Required paramsjob_rid
Paginationnone
orchestration_job_get_batch
read
Execute multiple get requests on Job.
Required paramsbody
Paginationnone
orchestration_schedule_create
write
Creates a new Schedule.
Required paramsaction
Paginationnone
orchestration_schedule_delete
write
Delete the Schedule with the specified rid.
Required paramsschedule_rid
Paginationnone
orchestration_schedule_get
read
Get the Schedule with the specified rid.
Required paramsschedule_rid
Paginationnone
orchestration_schedule_get_affected_resources
read
Official Palantir Foundry SDK operation.
Required paramsschedule_rid
Paginationnone
orchestration_schedule_get_batch
read
Fetch multiple schedules in a single request.
Required paramsbody
Paginationnone
orchestration_schedule_pause
write
Official Palantir Foundry SDK operation.
Required paramsschedule_rid
Paginationnone
orchestration_schedule_replace
write
Replaces the Schedule with the specified rid.
Required paramsactionschedule_rid
Paginationnone
orchestration_schedule_run
write
Official Palantir Foundry SDK operation.
Required paramsschedule_rid
Paginationnone
orchestration_schedule_runs
read
Get the most recent runs of a Schedule.
Required paramsschedule_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
orchestration_schedule_unpause
write
Official Palantir Foundry SDK operation.
Required paramsschedule_rid
Paginationnone
orchestration_schedule_version_get
read
Get the ScheduleVersion with the specified rid.
Required paramsschedule_version_rid
Paginationnone
orchestration_schedule_version_schedule
read
Official Palantir Foundry SDK operation.
Required paramsschedule_version_rid
Paginationnone
pack_document_create
write
Deprecated: use `createV2` instead, which takes the document parent (namespace or folder) directly…
Required paramsbody
Paginationnone
pack_document_create_child
write
Creates a PACK Document as a hidden child of the given folder or document, inheriting its security…
Required paramsbody
Paginationnone
pack_document_create_matching_security
write
Creates a PACK Document that copies the directly-applied security markings of a source Document.
Required paramsbody
Paginationnone
pack_document_create_v2
write
Creates a PACK Document and returns it.
Required paramsbody
Paginationnone
pack_document_delete_document
write
Delete the Document with the specified id.
Required paramsdocument_id
Paginationnone
pack_document_get
read
Get the Document with the specified id.
Required paramsdocument_id
Paginationnone
pack_document_resolve_application
read
Resolves a PACK Document to the application that owns its Document Type.
Required paramsdocument_id
Paginationnone
pack_document_search
read
Loads all PACK Documents visible to the user of the provided Document Type Name.
Required paramsbody
Paginationtoken (tokenField: body.requestBody.pageToken, limitField: body.requestBody.pageSize)
pack_document_type_create
write
Creates a PACK Document Type with the provided schema and metadata.
Required paramsbody
Paginationnone
pack_document_type_create_first_party
write
Creates a first-party Document Type with the given schema in the specified ontology.
Required paramsbody
Paginationnone
pack_document_type_get
read
Get the DocumentType with the specified rid.
Required paramsdocument_type_rid
Paginationnone
pack_document_type_get_operational_version
read
Returns the computed operational version for a document type.
Required paramsbody
Paginationnone
pack_document_type_load_by_name
read
Loads the PACK Document Type's metadata by the provided Document Type Name.
Required paramsbody
Paginationnone
pack_document_type_update_schema
write
Updates the schema of a PACK Document Type.
Required paramsbody
Paginationnone
pack_document_update
write
Updates the metadata (name, description, and/or security) of a PACK Document.
Required paramsbodydocument_id
Paginationnone
public_apis_api_definition_get
read
Gets the public API specification for this API.
Required paramsapi_definition_version
Paginationnone
public_apis_open_api_definition_get
read
Gets the public OpenAPI specification for this API.
Required paramsopen_api_definition_api_version
Paginationnone
public_apis_open_api_definition_yaml
read
Gets the public OpenAPI specification for this API as a YAML document.
Required paramsopen_api_definition_api_version
Paginationnone
sql_queries_sql_query_cancel
write
Cancels a query. If the query is no longer running this is effectively a no-op.
Required paramssql_query_id
Paginationnone
sql_queries_sql_query_execute
write
Executes a new query. Only the user that invoked the query can operate on the query. The size of…
Required paramsquery
Paginationnone
sql_queries_sql_query_execute_ontology
read
Executes a SQL query against the Ontology.
Required paramsquery
Paginationnone
sql_queries_sql_query_get_results
read
Gets the results of a query.
Required paramssql_query_id
Paginationnone
sql_queries_sql_query_get_status
read
Gets the status of a query.
Required paramssql_query_id
Paginationnone
streams_dataset_create
write
Creates a streaming dataset with a stream on the specified branch, or if no branch is specified…
Required paramsnameparent_folder_ridschema
Paginationnone
streams_stream_create
write
Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.
Required paramsbranch_namedataset_ridschema
Paginationnone
streams_stream_get
read
Get a stream by its branch name.
Required paramsdataset_ridstream_branch_name
Paginationnone
streams_stream_get_end_offsets
read
Get the end offsets for all partitions of a stream.
Required paramsdataset_ridstream_branch_name
Paginationnone
streams_stream_get_records
read
Get a batch of records from a stream for a given partition.
Required paramsdataset_ridlimitpartition_idstream_branch_name
Paginationoffset (offsetField: start_offset, limitField: limit)
streams_stream_publish_binary_record
write
Publish a single binary record to the stream. The stream's schema must be a single binary field.
Required paramsbodydataset_ridstream_branch_name
Paginationnone
streams_stream_publish_record
write
Publish a single record to the stream.
Required paramsdataset_ridrecordstream_branch_name
Paginationnone
streams_stream_publish_records
write
Publish a batch of records to the stream.
Required paramsdataset_ridrecordsstream_branch_name
Paginationnone
streams_stream_reset
write
Reset the stream on the given dataset branch, clearing the existing records and allowing new…
Required paramsdataset_ridstream_branch_name
Paginationnone
streams_subscriber_commit_offsets
write
Explicitly commit offsets for a subscriber. Required when `autoCommit` is false.
Required paramsdataset_ridoffsetsstream_branch_namesubscriber_subscriber_id
Paginationnone
streams_subscriber_create
write
Register a new subscriber for a stream.
Required paramsdataset_ridstream_branch_namesubscriber_id
Paginationnone
streams_subscriber_delete
write
Delete a subscriber and all its committed offset state.
Required paramsdataset_ridstream_branch_namesubscriber_subscriber_id
Paginationnone
streams_subscriber_get_read_position
read
Get the current read position for a subscriber.
Required paramsdataset_ridstream_branch_namesubscriber_subscriber_id
Paginationnone
streams_subscriber_read_records
write
Fetch records for a subscriber starting from their committed offset.
Required paramsdataset_ridstream_branch_namesubscriber_subscriber_id
Paginationnone
streams_subscriber_reset_offsets
write
Reset subscriber offsets to a specific position.
Required paramsdataset_ridpositionstream_branch_namesubscriber_subscriber_id
Paginationnone
third_party_applications_third_party_application_get
read
Get the ThirdPartyApplication with the specified rid.
Required paramsthird_party_application_rid
Paginationnone
third_party_applications_version_delete
write
Delete the Version with the specified version.
Required paramsthird_party_application_ridversion_version
Paginationnone
third_party_applications_version_get
read
Get the Version with the specified version.
Required paramsthird_party_application_ridversion_version
Paginationnone
third_party_applications_version_list
read
Lists all Versions.
Required paramsthird_party_application_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
third_party_applications_version_upload
write
Upload a new version of the Website.
Required paramsbodythird_party_application_ridversion
Paginationnone
third_party_applications_version_upload_snapshot
write
Upload a snapshot version of the Website.
Required paramsbodythird_party_application_ridversion
Paginationnone
third_party_applications_website_deploy
write
Deploy a version of the Website.
Required paramsthird_party_application_ridversion
Paginationnone
third_party_applications_website_get
read
Get the Website.
Required paramsthird_party_application_rid
Paginationnone
third_party_applications_website_undeploy
write
Remove the currently deployed version of the Website.
Required paramsthird_party_application_rid
Paginationnone
widgets_dev_mode_settings_enable
write
Enable dev mode for the user associated with the provided token.
Paginationnone
widgets_dev_mode_settings_set_widget_set_by_id
write
Set the dev mode settings for the given widget set for the user associated with the provided token.
Required paramssettingswidget_set_rid
Paginationnone
widgets_dev_mode_settings_v2_enable
write
Enable dev mode for the user associated with the provided token.
Paginationnone
widgets_dev_mode_settings_v2_set_widget_set_manifest
write
Set the dev mode settings for the given widget set using the manifest format.
Required paramsmanifestwidget_set_rid
Paginationnone
widgets_release_delete
write
Delete the Release with the specified version.
Required paramsrelease_versionwidget_set_rid
Paginationnone
widgets_release_get
read
Get the Release with the specified version.
Required paramsrelease_versionwidget_set_rid
Paginationnone
widgets_release_list
read
Lists all Releases.
Required paramswidget_set_rid
Paginationtoken (tokenField: page_token, limitField: page_size)
widgets_repository_get
read
Get the Repository with the specified rid.
Required paramsrepository_rid
Paginationnone
widgets_repository_publish
write
Publish a new release of a widget set.
Required paramsbodyrepository_ridrepository_version
Paginationnone
widgets_widget_set_get
read
Get the WidgetSet with the specified rid.
Required paramswidget_set_rid
Paginationnone

Palantir Foundry

What you can ask

About this source

Provenance

Freshness & coverage

Caveats

› Methods (412)

admin_authentication_provider_get

admin_authentication_provider_list

admin_authentication_provider_preregister_group

admin_authentication_provider_preregister_user

admin_cbac_banner_get

admin_cbac_marking_restrictions_get

admin_enrollment_get

admin_enrollment_get_current

admin_enrollment_role_assignment_add

admin_enrollment_role_assignment_list

admin_enrollment_role_assignment_remove

admin_group_create

admin_group_delete

admin_group_get

admin_group_get_batch

admin_group_list

admin_group_list_current

admin_group_member_add

admin_group_member_list

admin_group_member_remove

admin_group_membership_expiration_policy_get

admin_group_membership_expiration_policy_replace

admin_group_membership_list

admin_group_provider_info_get

admin_group_provider_info_replace

admin_group_replace

admin_group_search

admin_host_list

admin_marking_category_create

admin_marking_category_get

admin_marking_category_list

admin_marking_category_replace

admin_marking_create

admin_marking_get

admin_marking_get_batch

admin_marking_list

admin_marking_member_add

admin_marking_member_list

admin_marking_member_remove

admin_marking_parse_classifications

admin_marking_replace

admin_marking_role_assignment_add

admin_marking_role_assignment_list

admin_marking_role_assignment_remove

admin_organization_create

admin_organization_get

admin_organization_guest_member_add

admin_organization_guest_member_list

admin_organization_guest_member_remove

admin_organization_list_available_roles

admin_organization_replace

admin_organization_role_assignment_add

admin_organization_role_assignment_list

admin_organization_role_assignment_remove

admin_role_get

admin_role_get_batch

admin_user_delete

admin_user_get

admin_user_get_batch

admin_user_get_current

admin_user_get_markings

admin_user_list

admin_user_profile_picture

admin_user_provider_info_get

admin_user_provider_info_replace

admin_user_revoke_all_tokens

admin_user_search

aip_agents_agent_all_sessions

aip_agents_agent_get

aip_agents_agent_version_get

aip_agents_agent_version_list

aip_agents_content_get

aip_agents_session_blocking_continue