A2AFramework
typing.Literal[Any]
default:"a2a"
required
Type
str
default:"/.well-known/agent-card.json"
required
Path to the agent card JSON, relative to the base URL
Account
typing.Optional[str]
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
typing.Dict[(str, typing.Any)]
required
Account manifest
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(bool, Any, Any)]
required
AccountInfo
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
ActivateUserResponse
Union, One Of:AddonComponent
AddonComponentName
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[bool]
typing.Optional[AddonComponentStatus]
typing.Optional[str]
typing.Optional[typing.Dict[(str, typing.Any)]]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[ClusterType]], Any, Any)]
typing.Optional[bool]
typing_extensions.Annotated[(typing.Optional[typing.List[str]], Any, Any)]
typing.Optional[AddOnComponentSource]
typing.Optional[UpgradeData]
typing.Optional[typing.List[str]]
typing.Optional[typing.List[Recommendation]]
🔗 RecommendationRecommendations
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[typing.Dict[(str, typing.Any)]]
Addon metadata. autopilotEnabled is true when the backing addon application has autopilot enabled; otherwise false.
AddOnComponentSource
str
required
Repository URL of the source
str
required
Chart of the source
AddonComponentStatus
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
bool
required
Indicates whether the addon is installed
AgentFramework
Union, One Of:AgentManifest
Union, One Of:AgentSkill
str
required
str
required
str
required
typing.Optional[typing.List[str]]
typing.Optional[typing.List[str]]
typing_extensions.Annotated[(typing.Optional[typing.List[str]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[str]], Any, Any)]
AgentSkillManifest
str
required
Name of the skill.
typing.Dict[(str, typing.Any)]
required
Key value metadata. Should be valid JSON. For e.g.
\{"business-unit": "sales", "quality": "good", "rating": 4.5\}str
required
Name of the ML Repo
typing.Optional[int]
Version of the entity
typing.Literal[Any]
default:"agent-skill"
required
AgentSkillManifestSource
required
AgentSkillManifestSource
Union, One Of:AgentSkillSourceBlobStorage
typing.Literal[Any]
default:"blob-storage"
required
str
required
1–1024 chars.
str
required
Storage URI of the blob storage object where the skill is stored.
AgentSkillSourceInline
typing.Literal[Any]
default:"inline"
required
str
required
Main body of SKILL.md file.
AgentSkillSourceLocal
typing.Literal[Any]
default:"local"
required
str
required
Path to the skill root directory, including SKILL.md and related assets.
AgentSkillVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
AgentSkillManifest
required
🔗 AgentSkillManifestManifest containing metadata specific to this agent skill version
str
required
ID of the ML Repo that this artifact version belongs to
str
required
ID of the parent agent skill artifact that this version belongs to
AgentSource
Union, One Of:Ai21KeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for AI21 authentication
Ai21Model
typing.Literal[Any]
default:"integration/model/ai21"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The AI21 model identifier (e.g., jamba-large, jamba-mini). This is the model name from AI21’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the AI21 model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
Ai21ProviderAccount
typing.Literal[Any]
default:"provider-account/ai21"
required
str
required
The name of the AI21 provider account
Ai21KeyAuth
required
typing.Optional[typing.List[Ai21Integrations]]
List of integrations that are associated with the AI21 provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
AiFeaturesSettings
typing.Literal[Any]
default:"settings/ai-features"
required
bool
required
Enable/Disable AI features. Other fields only apply when this is true
typing.Literal[Any]
default:"truefoundry"
required
AI provider to use for AI features When TrueFoundry is selected, TrueFoundry will manage and provide the AI models for the features.
AktoGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/akto"
required
AktoTokenAuth
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Akto guardrails can only be used for validation.
EnforcingStrategy
required
AktoGuardrailConfigConfig
required
AktoGuardrailConfigConfig
str
required
The base URL of the Akto guardrails service (e.g.
https://your-akto-host:port)AktoTokenAuth
typing.Literal[Any]
default:"token"
required
str
required
JWT token for authenticating with the Akto guardrails service
Alert
typing.Optional[str]
str
required
typing.List[dt.datetime]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
str
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
AlertConfig
typing.Literal[Any]
default:"alert-config"
required
Type
str
required
Name - 3 to 35 lower case characters long alphanumeric word, may contain - in between, cannot start with a number
AlertConfigResource
required
typing.List[NotificationTargetForAlertRule]
required
🔗 NotificationTargetForAlertRuleConfigure one or more notification targets where alerts will be sent. Each target specifies a notification channel (email or slack).
typing.List[PrometheusAlertRule]
required
🔗 PrometheusAlertRuleDefine one or more alert rules that specify the conditions to monitor, when to trigger alerts, and how they should be handled.
AlertConfigResource
AlertConfigResourceType
required
🔗 AlertConfigResourceTypeThe type of resource this alert config belongs to. Can be either an application or a cluster.
str
required
FQN of the resource this alert config belongs to.
AllDataAccessRule
typing.Literal[Any]
default:"all_data"
required
Data access scope - access to all data with optional filters
typing.Optional[typing.List[AllDataAccessRuleFiltersItem]]
🔗 AllDataAccessRuleFiltersItemOptional filters to restrict data access (only applicable for all_data scope)
AllDataAccessRuleFiltersItem
Union, One Of:AmqpInputConfig
typing.Literal[Any]
default:"amqp"
required
str
required
AMQP Queue URL of Subscriber
str
required
AMQP Queue Name
int
default:"5"
required
Wait timeout for long polling.
AmqpMetricConfig
typing.Literal[Any]
default:"amqp"
required
int
required
Upper limit of the number of backlog messages the auto-scaler will try to maintain per replica. If you set this number to 10 and have 30 messages in the stream and one replica, the auto-scaler will scale the number of replicas to 3.
AmqpOutputConfig
typing.Literal[Any]
default:"amqp"
required
str
required
AMQP Queue URL of Publisher
str
required
AMQP Routing Key to publish to.
typing.Optional[str]
AMQP Exchange Name
AnthropicKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Anthropic authentication
AnthropicModel
str
required
A descriptive name to identify this model integration in the UI
str
required
The Anthropic model identifier (e.g., claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-haiku-20240307). This is the standard model name from Anthropic’s API documentation.
typing.Literal[Any]
default:"integration/model/anthropic"
required
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Anthropic model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AnthropicProviderAccount
typing.Literal[Any]
default:"provider-account/anthropic"
required
str
required
The name of the Anthropic provider account
typing.Optional[AnthropicKeyAuth]
typing.Optional[typing.List[AnthropicIntegrations]]
List of integrations that are associated with the Anthropic provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
Application
typing.Optional[str]
typing.Optional[str]
typing.Optional[str]
typing.Optional[ApplicationType]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[ApplicationMetadata]
typing_extensions.Annotated[(ApplicationLifecycleStage, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[int], Any, Any)]
typing_extensions.Annotated[(typing.Optional[int], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing.Optional[typing.List[Recommendation]]
🔗 RecommendationRecommendations for this application
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, typing.Any)]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[Any]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[ApplicationProblem]], Any, Any)]
typing.Dict[(str, typing.Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[Any]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
ApplicationDebugInfo
typing.Optional[str]
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[Any]
typing_extensions.Annotated[(typing.Dict[(str, typing.Any)], Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
ApplicationMetadata
typing.Optional[bool]
ApplicationProblem
str
required
str
required
ApplicationsCancelDeploymentResponse
typing.Optional[str]
Deployment cancelled
ApplicationSet
typing.Literal[Any]
default:"application-set"
required
str
required
Name of the application set.
typing.Optional[typing.List[ApplicationSetComponentsItem]]
🔗 ApplicationSetComponentsItemArray of components with their specifications.
typing.Optional[str]
Template to be used for the application set.
typing.Optional[typing.Dict[(str, typing.Any)]]
Values to be used to render components for the application set.
typing.Optional[str]
Fully qualified name of the workspace
typing.Optional[bool]
Flag to indicate if the template manifest should be converted to TrueFoundry manifest
ApplicationSetComponentsItem
Union, One Of:ApplyMlEntityResponse
ApplyMlEntityResponseData
required
🔗 ApplyMlEntityResponseDataThe created or updated ML entity (model version, prompt version, agent skill version, artifact version, or data directory)
ApplyMlEntityResponseData
Union, One Of:Artifact
str
required
Unique identifier for the artifact
str
required
ID of the ML Repo that this artifact belongs to
ArtifactType
required
🔗 ArtifactTypeType of the artifact (e.g., ‘artifact’, ‘model’, ‘chat_prompt’, ‘agent-skill’, ‘plot’, ‘image’)
str
required
Name of the artifact (alphanumeric characters, hyphens, and underscores only, max 256 characters)
str
required
Fully qualified name of the artifact in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}’
typing.Optional[dt.datetime]
Timestamp when the artifact was created
typing.Optional[dt.datetime]
Timestamp when the artifact was last updated
typing.Optional[BaseArtifactVersion]
🔗 BaseArtifactVersionThe most recent version of this artifact
typing.Optional[typing.List[int]]
List of run step numbers where this artifact was created or updated
ArtifactManifest
str
required
Name of the artifact (alphanumeric characters, hyphens, and underscores only, max 256 characters)
typing.Dict[(str, typing.Any)]
required
Key value metadata. Should be valid JSON. For e.g.
\{"business-unit": "sales", "quality": "good", "rating": 4.5\}str
required
Name of the ML Repo that this artifact belongs to (must start and end with alphanumeric, 2-100 characters)
typing.Optional[int]
Version of the entity
typing.Literal[Any]
default:"artifact-version"
required
typing.Optional[str]
typing.Optional[str]
Version alias is alternate, ideally human readable, version string to reference an artifact version. It should start with
v followed by alphanumeric and it can include . and - in between (e.g. v1.0.0, v1-prod, v3-dev, etc)ArtifactManifestSource
required
typing.Optional[int]
Step/Epoch number in an iterative training loop the artifact version was created. Generally useful when logging a model version from a MLRepo Run
typing.Optional[str]
ID of the MLRepo Run that generated the artifact version
ArtifactManifestSource
Union, One Of:ArtifactPath
str
required
Local file or folder path
typing.Optional[str]
Relative path where the file or folder will be uploaded to in the artifact
ArtifactsCacheVolume
str
required
Storage class of the Volume where artifacts will be cached
int
default:"200"
required
Size of the Volume (in GB) where artifacts will be cached. Should be greater than twice the size of artifacts getting cached
ArtifactsDownload
typing.Optional[ArtifactsCacheVolume]
typing.List[ArtifactsDownloadArtifactsItem]
required
🔗 ArtifactsDownloadArtifactsItemList of artifacts to be cached
ArtifactsDownloadArtifactsItem
Union, One Of:ArtifactVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
ArtifactManifest
required
🔗 ArtifactManifestManifest containing metadata for a generic artifact version
str
required
ID of the ML Repo that this artifact version belongs to
typing.Optional[typing.List[str]]
List of tags associated with this artifact version for filtering and organization
typing.Optional[str]
Optional human-readable version alias (e.g. v1.0.0)
typing.Optional[str]
Code snippet demonstrating how to use this artifact version
str
required
ID of the parent artifact that this version belongs to
AssistantMessage
typing.Literal[Any]
default:"assistant"
required
Role of the message
typing.Optional[AssistantMessageContent]
🔗 AssistantMessageContentText content for the assistant message
typing.Optional[typing.List[ToolCall]]
🔗 ToolCallList of tool calls made by the assistant
typing.Optional[str]
Name of the assistant this message is from
AssistantMessageContent
Union, One Of:AssistantMessageContentOneItem
Union, One Of:AsyncProcessorSidecar
str
required
URL for the processor to invoke
typing.Optional[int]
default:"10"
Timeout for the invoke request in seconds
typing.Optional[str]
Image for the processor sidecar (This field will be deprecated in the future)
AsyncService
typing.Literal[Any]
default:"async-service"
required
AsyncServiceReplicas
required
🔗 AsyncServiceReplicasDeploy multiple instances of your pods to distribute incoming traffic across them, ensuring effective load balancing.
WorkerConfig
required
typing.Optional[AsyncProcessorSidecar]
AsyncServiceAutoscaling
AsyncServiceAutoscalingMetrics
required
🔗 AsyncServiceAutoscalingMetricsMetrics to use for the autoscaler
AsyncServiceAutoscalingMetrics
Union, One Of:AsyncServiceReplicas
Union, One Of:AutoRotate
int
default:"360"
required
Rotation Interval in days after which the token will be rotated. Minimum value is 30.
int
default:"30"
required
Grace Period in days for which the token will be valid after rotation interval. Minimum value is 1.
Autoshutdown
int
default:"900"
required
The period to wait after the last received request before scaling the replicas to 0. This value should be high enough to allow for the replicas of the service to come up to avoid premature scaling down.
AwsAccessKeyAuth
str
required
AWS Access Key ID
str
required
AWS Secret Access Key for the user to authenticate with
typing.Optional[str]
AWS Session Token, only required when using temporary credentials
AwsAccessKeyBasedAuth
typing.Literal[Any]
default:"access-key-based"
required
str
required
AWS access key ID that you want to use for authentication.
str
required
AWS access key secret that you want to use for authentication.
AwsAssumedRoleBasedAuth
typing.Literal[Any]
default:"assumed-role-based"
required
str
required
ARN of the role you want to assume.
AwsBedrockApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
Your AWS Bedrock API key for authentication
AwsBedrockAssumedRoleBasedAuth
typing.Optional[str]
Optional external ID to use when assuming the role. This provides an added layer of security by ensuring only parties with the correct external ID can assume the role.
AwsBedrockGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/aws-bedrock"
required
typing.Optional[AwsBedrockGuardrailConfigAuthData]
🔗 AwsBedrockGuardrailConfigAuthDataAuthentication data for the AWS account
AwsBedrockGuardrailConfigOperation
required
🔗 AwsBedrockGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
AwsBedrockGuardrailConfigConfig
required
AwsBedrockGuardrailConfigAuthData
Union, One Of:AwsBedrockGuardrailConfigConfig
str
required
The unique identifier of the Bedrock Guardrail created in AWS console
str
required
Version number of the guardrail to use (e.g., 2 for version 2)
AwsRegion
required
AwsBedrockProviderAccount
typing.Literal[Any]
default:"provider-account/aws-bedrock"
required
str
required
The name of the AWS Bedrock provider account
AwsRegion
required
typing.Optional[AwsBedrockProviderAccountAuthData]
🔗 AwsBedrockProviderAccountAuthDataAuthentication data for the AWS account
typing.List[BedrockModel]
required
🔗 BedrockModelList of integrations that are associated with the AWS Bedrock provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
AwsBedrockProviderAccountAuthData
Union, One Of:AwsEcr
typing.Literal[Any]
default:"integration/docker-registry/aws/ecr"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the registry.
typing.Optional[AwsEcrAuthData]
🔗 AwsEcrAuthDataCustom authentication data for the integration.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AwsEcrAuthData
Union, One Of:AwsEksIntegration
typing.Literal[Any]
default:"integration/cluster/aws/eks"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
AwsRegion
required
str
required
Name of the cluster given in the cloud account.
typing.Optional[AwsEksIntegrationAuthData]
🔗 AwsEksIntegrationAuthDataCustom authentication data for the integration.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AwsEksIntegrationAuthData
Union, One Of:AwsInferentia
typing.Literal[Any]
default:"aws_inferentia"
required
typing.Optional[str]
Name of the AWS Inferentia Accccelerator. One of [INF1, INF2]. This field is required for Node Selector and can be ignored in Nodepool Selector.
int
required
Count of Inferentia accelerator chips to provide to the application
AwsIntegrations
Union, One Of:AwsParameterStore
typing.Literal[Any]
default:"integration/secret-store/aws/parameter-store"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
AwsRegion
required
typing.Optional[AwsParameterStoreAuthData]
🔗 AwsParameterStoreAuthDataCustom authentication data for the integration.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
typing.Optional[str]
The ARN of the KMS key to use for encryption.
AwsParameterStoreAuthData
Union, One Of:AwsProviderAccount
typing.Literal[Any]
default:"provider-account/aws"
required
str
required
The name of the AWS provider account.
str
required
The AWS account ID.
typing.Optional[AwsProviderAccountAuthData]
🔗 AwsProviderAccountAuthDataAuthentication data for the AWS account.
typing.List[AwsIntegrations]
required
🔗 AwsIntegrationsList of integrations that are associated with the AWS provider account.
AwsProviderAccountAuthData
Union, One Of:AwsS3
typing.Literal[Any]
default:"integration/blob-storage/aws/s3"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The S3 storage path in the format ‘s3://<bucket-name>/<optional-path-prefix>’. Works with S3-compatible storage providers like MinIO, Ceph, and DigitalOcean Spaces. Example: ‘s3://mybucket’ or ‘s3://mybucket/artifacts/production’.
AwsRegion
required
typing.Optional[AwsS3AuthData]
🔗 AwsS3AuthDataCustom authentication data for the integration.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AwsS3AuthData
Union, One Of:AwsSagemakerProviderAccount
typing.Literal[Any]
default:"provider-account/aws-sagemaker"
required
str
required
The name of the Sagemaker provider account
AwsRegion
required
typing.Optional[AwsSagemakerProviderAccountAuthData]
🔗 AwsSagemakerProviderAccountAuthDataAuthentication data for the AWS account
typing.List[SagemakerModel]
required
🔗 SagemakerModelList of integrations that are associated with the Sagemaker provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
AwsSagemakerProviderAccountAuthData
Union, One Of:AwsSecretsManager
typing.Literal[Any]
default:"integration/secret-store/aws/secrets-manager"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
AwsRegion
required
typing.Optional[AwsSecretsManagerAuthData]
🔗 AwsSecretsManagerAuthDataCustom authentication data for the integration.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
typing.Optional[str]
The ARN of the KMS key to use for encryption.
AwsSecretsManagerAuthData
Union, One Of:AwsSqsAccessKeyBasedAuth
typing.Literal[Any]
default:"access-key-based"
required
str
required
AWS access key ID that you want to use for authentication.
str
required
AWS access key secret that you want to use for authentication.
AwsSqsAssumedRoleBasedAuth
typing.Literal[Any]
default:"assumed-role-based"
required
str
required
ARN of the role you want to assume.
AzureAksIntegration
typing.Literal[Any]
default:"integration/cluster/azure/aks"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The resource group of the cluster in the cloud account.
str
required
Name of the cluster given in the cloud account.
typing.Optional[AzureOAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AzureBasicAuth
typing.Literal[Any]
default:"basic-auth"
required
str
required
The username for the Azure managed identity.
str
required
The password for the Azure managed identity.
AzureBlobStorage
typing.Literal[Any]
default:"integration/blob-storage/azure/blob"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The full Azure Blob Storage URL in the format ‘https://<storage-account-name>.blob.core.windows.net/<container-name>/<optional-path-prefix>’. Example: ‘https://mystorageaccount.blob.core.windows.net/mycontainer’ or ‘https://mystorageaccount.blob.core.windows.net/mycontainer/artifacts/production’.
typing.Optional[AzureConnectionStringAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AzureCertificateAuth
typing.Literal[Any]
default:"certificate"
required
str
required
The Azure AD tenant ID where the application is registered
str
required
The Azure AD application (client) ID for service principal authentication
str
required
Certificate in PEM format (e.g., -----BEGIN CERTIFICATE----- … -----END CERTIFICATE-----)
str
required
The base64url-encoded SHA-1 thumbprint of the certificate (x5t claim)
AzureConnectionStringAuth
typing.Literal[Any]
default:"connection-string"
required
str
required
The connection string for the Azure managed identity.
AzureContainerRegistry
typing.Literal[Any]
default:"integration/docker-registry/azure/acr"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the registry.
typing.Optional[AzureBasicAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AzureContentSafetyGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
required
AzureContentSafetyGuardrailConfigAuthData
required
🔗 AzureContentSafetyGuardrailConfigAuthDataAuthentication data for the Azure account
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Azure Content Safety guardrails can only be used for validation.
EnforcingStrategy
required
AzureContentSafetyGuardrailConfigConfig
required
AzureContentSafetyGuardrailConfigAuthData
Union, One Of:AzureContentSafetyGuardrailConfigConfig
str
required
Name of your Azure Content Safety resource where the service is deployed (e.g., my-content-safety)
str
default:"2024-09-01"
required
API version for the Content Safety API
typing.Optional[str]
Custom endpoint URL for the Content Safety API (optional, uses default Azure endpoint if not specified)
typing.Optional[typing.List[str]]
Names of custom blocklists created in Azure Content Safety to check text against. Leave empty if not using custom blocklists
float
default:"2.0"
required
Minimum severity level (0-6) to flag content. Higher values are more restrictive. 0=Safe, 2=Low risk, 4=Medium risk, 6=High risk
typing.List[AzureContentSafetyCategory]
required
🔗 AzureContentSafetyCategoryTypes of harmful content to detect: Hate (hate speech), SelfHarm (self-injury), Sexual (sexual content), Violence (violent content)
AzureFoundryModel
typing.Literal[Any]
default:"integration/model/azure-foundry"
required
str
required
A descriptive name to identify this model integration in the UI
AzureFoundryModelAuthData
required
🔗 AzureFoundryModelAuthDataAzure AI Foundry authentication credentials
typing.List[ModelType]
required
🔗 ModelTypeTypes of models supported by this Azure AI Foundry deployment
str
required
The model deployment name created in your Azure AI Foundry project. This is the deployment name you configured in Azure AI Foundry, not the base model name.
str
required
The Azure AI Foundry endpoint URL. Should look like https://{deployment}.{region}.models.ai.azure.com
typing.Optional[str]
The API version for the Azure Foundry model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AzureFoundryModelAuthData
Union, One Of:AzureFoundryProviderAccount
typing.Literal[Any]
default:"provider-account/azure-foundry"
required
str
required
The name of the Azure AI Foundry provider account
typing.List[AzureFoundryModel]
required
🔗 AzureFoundryModelList of integrations that are associated with the Azure Foundry provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
AzureIntegrations
Union, One Of:- 🔗 AzureAksIntegration
- 🔗 AzureContainerRegistry
- 🔗 AzureBlobStorage
- 🔗 AzureVault
- 🔗 AzureReposIntegration
AzureKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Azure AI Foundry authentication
AzureOAuth
typing.Literal[Any]
default:"oauth"
required
str
required
The Azure Active Directory tenant (directory) ID.
str
required
The client (application) ID of an App Registration in the tenant.
str
required
A client secret that was generated for the App Registration.
str
required
The ID of the target subscription. The value must be an UUID.
AzureOpenAiModel
typing.Literal[Any]
default:"integration/model/azure-openai"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The model deployment name created in your Azure OpenAI resource (e.g., gpt-4-deployment, gpt-35-turbo-deployment). This is NOT the base model name but the deployment name you configured in Azure.
str
required
The Azure OpenAI API version to use
typing.Optional[str]
The foundation model identifier (e.g., gpt-4o-2024-11-20)
AzureOpenAiModelDeploymentType
required
🔗 AzureOpenAiModelDeploymentTypeGlobal: worldwide processing; Data zone (US): US data zone processing; Data zone (EU): EU data zone processing; Standard: single-region processing
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Azure OpenAI model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AzureOpenAiProviderAccount
typing.Literal[Any]
default:"provider-account/azure-openai"
required
str
required
The name of the Azure OpenAI provider account
str
required
The Azure OpenAI Service endpoint URL. Should look like https://{resource-name}.openai.azure.com
AzureOpenAiProviderAccountAuthData
required
🔗 AzureOpenAiProviderAccountAuthDataAzure OpenAI authentication credentials
typing.List[AzureOpenAiModel]
required
🔗 AzureOpenAiModelList of integrations that are associated with the Azure OpenAI provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
AzureOpenAiProviderAccountAuthData
Union, One Of:AzurePiiGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/azure-pii"
required
AzurePiiGuardrailConfigAuthData
required
🔗 AzurePiiGuardrailConfigAuthDataAuthentication data for the Azure account
AzurePiiGuardrailConfigOperation
required
🔗 AzurePiiGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
AzurePiiGuardrailConfigConfig
required
AzurePiiGuardrailConfigAuthData
Union, One Of:AzurePiiGuardrailConfigConfig
str
required
Name of your Azure AI Language resource where the PII detection service is deployed (e.g., my-language-resource)
str
default:"2024-11-01"
required
API version for the PII detection API
typing.Optional[str]
Custom endpoint URL for the PII detection API (optional, uses default Azure endpoint if not specified)
AzurePiiGuardrailConfigConfigDomain
required
🔗 AzurePiiGuardrailConfigConfigDomainSpecialized domain for PII detection. Use phi for PHI (Protected Health Information) or none for general text
typing.List[AzurePiiCategory]
required
🔗 AzurePiiCategoryCategories of PII to detect.
str
default:"latest"
required
Version of the PII detection model to use, use latest for the newest model or specify a specific version for consistency
str
default:"en"
required
Language code for PII detection (e.g., en for English)
AzurePromptShieldGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
required
AzurePromptShieldGuardrailConfigAuthData
required
🔗 AzurePromptShieldGuardrailConfigAuthDataAuthentication data for the Azure account
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Azure Prompt Shield guardrails can only be used for validation.
EnforcingStrategy
required
AzurePromptShieldGuardrailConfigConfig
required
AzurePromptShieldGuardrailConfigAuthData
Union, One Of:AzurePromptShieldGuardrailConfigConfig
str
required
Name of your Azure Content Safety resource where the Prompt Shield service is deployed (e.g., my-content-safety)
str
default:"2024-09-01"
required
API version for the Prompt Shield API
typing.Optional[str]
Custom endpoint URL for the Prompt Shield API (optional, uses default Azure endpoint if not specified)
AzureProviderAccount
typing.Literal[Any]
default:"provider-account/azure"
required
str
required
The name of the Azure provider account.
typing.Optional[str]
The ID of the target subscription. The value must be an UUID.
typing.List[AzureIntegrations]
required
🔗 AzureIntegrationsList of integrations that are associated with the Azure provider account.
AzureReposIntegration
typing.Literal[Any]
default:"integration/vcs/azure"
required
str
required
str
required
Account Name
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
AzureVault
typing.Literal[Any]
default:"integration/secret-store/azure/vault"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
typing.Optional[AzureOAuth]
str
required
Name of key vault name.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
BaseArtifactVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
typing.Optional[BaseArtifactVersionManifest]
str
required
ID of the ML Repo that this artifact version belongs to
BaseArtifactVersionManifest
Union, One Of:BaseAutoscaling
int
default:"1"
required
Minimum number of replicas to keep available
int
required
Maximum number of replicas allowed for the component.
typing.Optional[int]
default:"30"
This is the interval to check each trigger on.
BaseOAuth2Login
str
required
client ID for OAuth2.
typing.Optional[str]
Client secret or the TrueFoundry secret containing the client secret for OAuth2.
str
required
URL for the authorization request
str
required
The endpoint to exchange auth code for tokens.
typing.List[str]
required
List of scopes to request from the OAuth2 provider.
BaseOAuth2LoginJwtSource
required
🔗 BaseOAuth2LoginJwtSourceSource of the JWT token to be used for verification.
BaseRemoteAgent
str
required
The name of the Agent
str
required
The description of the Agent
typing.Optional[typing.Dict[(str, typing.Any)]]
Tags for the Agent
typing.List[Collaborator]
required
🔗 CollaboratorList of users who have access to this Agent
BaseService
str
required
Name of the service. This uniquely identifies this service in the workspace. > Name can only contain alphanumeric characters and ’-’ and can be atmost 25 characters long
BaseServiceImage
required
🔗 BaseServiceImageSpecify whether you want to deploy a Docker image or build and deploy from source code
typing.Optional[ArtifactsDownload]
typing.Optional[Resources]
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the service either as plain text or secrets. Docs
typing.List[Port]
required
typing.Optional[str]
typing.Optional[typing.List[BaseServiceMountsItem]]
🔗 BaseServiceMountsItemConfigure data to be mounted to service pod(s) as a string, secret or volume. Docs
typing.Optional[typing.Dict[(str, str)]]
Labels
typing.Optional[Kustomize]
typing.Optional[HealthProbe]
typing.Optional[HealthProbe]
typing.Optional[HealthProbe]
typing.Optional[str]
Fully qualified name of the workspace
BaseServiceImage
Union, One Of:BaseServiceMountsItem
Union, One Of:BasetenKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Baseten authentication
BasetenModel
typing.Literal[Any]
default:"integration/model/baseten"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Baseten model identifier. This is the model name from Baseten’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Baseten model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
BasetenProviderAccount
typing.Literal[Any]
default:"provider-account/baseten"
required
str
required
The name of the Baseten provider account
BasetenKeyAuth
required
typing.Optional[typing.List[BasetenIntegrations]]
List of integrations that are associated with the Baseten provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
BaseWorkbenchInput
str
required
Name of the workbench. This uniquely identifies this workbench in the workspace. > Name can only contain alphanumeric characters and ’-’ and can be atmost 25 characters long
int
default:"20"
required
Size of the home directory for the workbench (Persistent Storage)
typing.Optional[Resources]
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the service either as plain text or secrets. Docs
typing.Optional[typing.List[BaseWorkbenchInputMountsItem]]
🔗 BaseWorkbenchInputMountsItemConfigure data to be mounted to workbench pod(s) as a string, secret or volume. Docs
typing.Optional[str]
typing.Optional[Kustomize]
typing.Optional[str]
Fully qualified name of the workspace
BaseWorkbenchInputMountsItem
Union, One Of:BasicAuthCreds
typing.Literal[Any]
default:"basic_auth"
required
str
required
Username for service auth - Username for the user to authenticate with
str
required
Password for service auth - Password for the user to authenticate with
BedrockModel
str
required
A descriptive name to identify this model integration in the UI
str
required
The AWS Bedrock model identifier or inference profile. Can be a foundation model ID (e.g., anthropic.claude-3-5-sonnet-20240620-v1:0, amazon.titan-text-express-v1), an inference profile ID (e.g., us.anthropic.claude-3-5-sonnet-20240620-v1:0), or an inference profile ARN (e.g., arn:aws:bedrock:us-east-1:123456789012:inference-profile/my-profile).
typing.Literal[Any]
default:"integration/model/bedrock"
required
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Bedrock model
typing.Optional[AwsRegion]
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
BitbucketIntegration
typing.Literal[Any]
default:"integration/vcs/bitbucket"
required
str
required
str
required
Account Name
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
BitbucketProviderAccount
typing.Literal[Any]
default:"provider-account/bitbucket"
required
str
required
typing.List[BitbucketIntegration]
required
BlobStorageReference
typing.Literal[Any]
default:"blob-storage"
required
str
required
Path to the content in blob storage
MimeType
required
🔗 MimeTypeMIME type of the content
BlueGreen
typing.Literal[Any]
default:"blue_green"
required
typing.Optional[bool]
Promote the new release to handle the complete traffic. A manual promotion would be needed if this is disabled
typing.Optional[int]
default:"30"
Promote the new release to handle the complete traffic after waiting for these many seconds
BudgetAlert
typing.List[float]
required
List of usage percentages (0-100) at which alerts should be triggered. Default thresholds are [75, 90, 95, 100].
typing.List[NotificationTarget]
required
🔗 NotificationTargetSelect where to send budget alert notifications
BudgetConfig
typing.Literal[Any]
default:"gateway-budget-config"
required
typing.List[BudgetRule]
required
🔗 BudgetRuleList of budget rules
BudgetRule
str
required
Unique identifier for the rule
BudgetWhen
required
float
required
Numeric limit value for the budget
BudgetLimitUnit
required
typing.Optional[typing.List[str]]
Create separate budget rules for each unique value of the selected entity. For example, if “user” is selected, a separate budget rule will be created for each unique user making requests. Options: user, virtualaccount, model, or a metadata key (e.g., metadata.appId).
typing.Optional[BudgetAlert]
typing.Optional[bool]
When enabled, requests exceeding the budget are tracked but not blocked
BudgetWhen
typing.Optional[typing.List[str]]
List of subjects that this rule applies to
typing.Optional[typing.List[str]]
List of models that this rule applies to
typing.Optional[typing.Dict[(str, str)]]
Metadata key-value pairs that this rule applies to
Build
typing.Literal[Any]
default:"build"
required
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
BuildBuildSource
required
🔗 BuildBuildSourceSource code location.
BuildBuildSpec
required
🔗 BuildBuildSpecInstructions to build a container image out of the build source
BuildBuildSource
Union, One Of:BuildBuildSpec
Union, One Of:BuildInfo
str
required
float
required
Status of the build: STARTED = 20, SUCCEEDED = 30, FAILED = 40
BuildSecret
str
required
The ID of the build secret.
str
required
The value of the build secret.
typing.Optional[str]
The name of the environment variable to inject the secret into.
Canary
typing.Literal[Any]
default:"canary"
required
typing.List[CanaryStep]
required
🔗 CanaryStepThese steps would be executed in order to enable shifting of traffic slowly from stable to canary version
CanaryStep
int
required
Percentage of total traffic to be shifted to the canary release. The rest will continue to go to the existing deployment
typing.Optional[int]
Duration for which to pause the release. The release process will wait for these seconds before proceeding to the next step. If this is not set, the step will pause indefinitely on this step
CartesiaApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Cartesia authentication
CartesiaModel
typing.Literal[Any]
default:"integration/model/cartesia"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Cartesia model identifier (for example, sonic-2, sonic-multilingual)
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Cartesia model (text_to_speech or audio_transcription)
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
CartesiaProviderAccount
typing.Literal[Any]
default:"provider-account/cartesia"
required
str
required
The name of the Cartesia provider account
typing.Optional[str]
Optional custom base URL for Cartesia API
CartesiaProviderAccountCartesiaVersion
required
🔗 CartesiaProviderAccountCartesiaVersionThe Cartesia API version header. Must be set to a supported API version.
CartesiaApiKeyAuth
required
typing.List[CartesiaModel]
required
🔗 CartesiaModelList of integrations that are associated with the Cartesia provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
CedarGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/cedar"
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Cedar guardrails can only be used for validation.
EnforcingStrategy
required
CedarGuardrailConfigConfig
required
CedarGuardrailConfigConfig
str
required
Enter a Cedar policy string to define access control rules. Supports principal types (user, team, virtualaccount), MCPTool actions, MCPServer resources, and when/unless clauses, refer to Docs
CerebrasKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Cerebras authentication
CerebrasModel
typing.Literal[Any]
default:"integration/model/cerebras"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Cerebras model identifier (e.g., llama-4-scout-17b-16e-instruct, llama3.1-70b). This is the standard model name from Cerebras’s API documentation.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Cerebras model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
CerebrasProviderAccount
typing.Literal[Any]
default:"provider-account/cerebras"
required
str
required
The name of the Cerebras provider account
CerebrasKeyAuth
required
typing.Optional[typing.List[CerebrasIntegrations]]
List of integrations that are associated with the Cerebras provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
ChangePasswordResponse
Union, One Of:ChatPromptManifest
str
required
Name of the prompt (alphanumeric characters, hyphens, and underscores only, max 256 characters)
typing.Dict[(str, typing.Any)]
required
Key value metadata. Should be valid JSON. For e.g.
\{"business-unit": "sales", "quality": "good", "rating": 4.5\}str
required
Name of the ML Repo that this prompt belongs to (must start and end with alphanumeric, 2-100 characters)
typing.Optional[int]
Version of the entity
typing.Literal[Any]
default:"chat_prompt"
required
typing.Optional[str]
typing.Optional[str]
Version alias is alternate, ideally human readable, version string to reference an artifact version. It should start with
v followed by alphanumeric and it can include . and - in between (e.g. v1.0.0, v1-prod, v3-dev, etc)typing.List[ChatPromptManifestMessagesItem]
required
🔗 ChatPromptManifestMessagesItemList of messages in the chat conversation, must be non-empty
typing.Optional[typing.Dict[(str, str)]]
Variables referenced in messages and that can be replaced when running generation
typing.Optional[ModelConfiguration]
typing.Optional[typing.List[ToolSchema]]
🔗 ToolSchemaList of tools to be used in the chat prompt
typing.Optional[typing.List[ChatPromptManifestMcpServersItem]]
🔗 ChatPromptManifestMcpServersItemA list of MCP servers FQNs or URLs and their tools
typing.Optional[Guardrails]
typing.Optional[ChatPromptManifestResponseFormat]
🔗 ChatPromptManifestResponseFormatResponse format configuration for structured outputs
typing.Optional[ChatPromptManifestRoutingConfig]
🔗 ChatPromptManifestRoutingConfigConfiguration for routing requests to different model targets
typing.Optional[ChatPromptManifestCacheConfig]
🔗 ChatPromptManifestCacheConfigCache configuration for the chat prompt
typing.Optional[typing.Dict[(str, McpServerToolDetails)]]
🔗 McpServerToolDetailsMapping of tool calls to MCP server integration IDs and tool names
typing.Optional[LoggingConfig]
typing.Optional[typing.List[SubAgent]]
🔗 SubAgentSub agents to be used in the chat prompt
ChatPromptManifestCacheConfig
Union, One Of:ChatPromptManifestMcpServersItem
Union, One Of:ChatPromptManifestMessagesItem
Union, One Of:ChatPromptManifestResponseFormat
Union, One Of:ChatPromptManifestRoutingConfig
Union, One Of:ClouderaModel
typing.Literal[Any]
default:"integration/model/cloudera"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The unique identifier of the Model in Cloudera Model Registry. This is the model ID assigned when you registered or deployed your model in the CDP Model Registry
str
required
The model endpoint URL up to the API version v1. To get the base_url, copy the model endpoint URL and delete the last two path components
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Cloudera model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
ClouderaProviderAccount
typing.Literal[Any]
default:"provider-account/cloudera"
required
str
required
The name of the Cloudera provider account
ClouderaProviderAccountAuthData
required
🔗 ClouderaProviderAccountAuthDataCloudera authentication credentials
typing.List[ClouderaIntegrations]
required
List of integrations that are associated with the Cloudera provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
ClouderaProviderAccountAuthData
Union, One Of:ClouderaTokenAuth
typing.Literal[Any]
default:"token"
required
str
required
Pre-generated API token for Cloudera CDP authentication. You can generate this token using the CDP CLI or from your user profile settings. This token provides direct access to CDP services without requiring workload-specific authentication.
ClouderaWorkloadAuthToken
typing.Literal[Any]
default:"workload-auth-token"
required
str
required
The base URL for CDP API services
str
required
The access key ID for your Cloudera CDP workload authentication.
str
required
The private key for your Cloudera CDP workload authentication.
str
required
The name of the CDP workload you want to authenticate with.
Cluster
str
required
str
required
ClusterManifest
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
ClusterGateway
typing.Optional[str]
str
required
typing.List[str]
required
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing.Dict[(str, str)]
required
ClusterManifest
typing.Literal[Any]
default:"cluster"
required
str
required
Name - 3 to 35 lower case characters long alphanumeric word, may contain - in between, cannot start with a number
ClusterManifestClusterType
required
🔗 ClusterManifestClusterTypeThe cluster type of this cluster
typing.List[str]
required
Tag the environment like dev, staging or production. You will need to create environments if you don’t have already.
typing.Optional[typing.List[str]]
One or more base URLs, which can be either a wildcard domain (resulting in app URLs like
\<app-name\>-\<workspace-name\>.\<base-domain-URL\>) or a non-wildcard domain (resulting in app URLs like \<base-domain-URL\>/\<app-name\>-\<workspace-name\>) > Read more about routing here and about ‘A’ record and domain mapping heretyping.Optional[ClusterManifestMonitoring]
🔗 ClusterManifestMonitoringMonitoring
typing.Optional[str]
Cluster Default Registry
typing.Optional[ClusterManifestWorkbenchConfig]
🔗 ClusterManifestWorkbenchConfigWorkbench Config
typing.Optional[SparkConfig]
typing.Optional[IngressControllerConfig]
typing.Optional[str]
Cluster Integration FQN
typing.Optional[str]
Workflow Storage Integration
typing.Optional[typing.List[Nodepool]]
🔗 NodepoolAdd nodepools that are already created in your cluster. When deploying, applications can choose to schedule from these nodepools.
typing.Optional[ClusterManifestNodeLabelKeys]
🔗 ClusterManifestNodeLabelKeysThe node label keys that this cluster supports. Note: You will additionally need to add
truefoundry.com/gpu_type label for GPU-supported node pools. For more information, check out this documentation.typing.List[Collaborator]
required
🔗 CollaboratorCollaborators who can access this cluster
ClusterManifestMonitoring
typing.Optional[str]
Cluster Loki URL
typing.Optional[str]
Cluster VictoriaLogs URL
typing.Optional[str]
Cluster Prometheus URL
typing.Optional[str]
Cluster Kubecost URL
ClusterManifestNodeLabelKeys
str
required
The nodepool selector label that this cluster supports
ClusterManifestWorkbenchConfig
typing.Optional[NotebookConfig]
typing.Optional[SshServerConfig]
typing.Optional[str]
The default storage class for the home directory of workbench
ClustersDeleteResponse
typing.Optional[str]
Success message
CodeSafetyLinterGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/code-safety-linter"
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Code Safety Linter guardrails can only be used for validation.
EnforcingStrategy
required
Codeserver
typing.Literal[Any]
default:"codeserver"
required
WorkbenchImage
required
CohereKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Cohere authentication
CohereModel
typing.Literal[Any]
default:"integration/model/cohere"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Cohere model identifier (e.g., command-a-03-2025, command-r-03-2024, command-r-03-2024). This is the standard model id from Cohere’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Cohere model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
CohereProviderAccount
typing.Literal[Any]
default:"provider-account/cohere"
required
str
required
The name of the Cohere provider account
CohereKeyAuth
required
typing.Optional[typing.List[CohereIntegrations]]
List of integrations that are associated with the Cohere provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
Collaborator
str
required
Fully Qualified Name of the subject. eg: user:email or team:teamname
str
required
Role ID for the resource
CommonToolsSettings
typing.Literal[Any]
default:"settings/common-tools"
required
bool
required
Enable web search tool Allows model to search the web for information.
bool
required
Enable code executor tool Allows model to execute code and return the results.
bool
required
Enable sandbox executor tool Allows model to execute shell command in an isolated stateful sandbox environment.
bool
required
Enable sequential thinking tool Allows model to reason step-by-step to solve complex problems.
bool
required
Enable web scraping tool. Allows model to scrape content from web pages with intelligent format selection for structured or unstructured data.
ContainerTaskConfig
typing.Literal[Any]
default:"container-task-config"
required
ContainerTaskConfigImage
required
🔗 ContainerTaskConfigImageSpecify whether you want to deploy a Docker image or build and deploy from source code
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the task either as plain text or secrets. Docs
typing.Optional[Resources]
typing.Optional[typing.List[ContainerTaskConfigMountsItem]]
🔗 ContainerTaskConfigMountsItemConfigure data to be mounted to Workflow pod(s) as a volume.
typing.Optional[str]
Service Account
ContainerTaskConfigImage
Union, One Of:ContainerTaskConfigMountsItem
Union, One Of:CoreNatsOutputConfig
typing.Literal[Any]
default:"core-nats"
required
str
required
Output NATS URL
str
required
Root subject of output NATS
typing.Optional[NatsUserPasswordAuth]
CpuUtilizationMetric
typing.Literal[Any]
default:"cpu_utilization"
required
int
required
Percentage of cpu request averaged over all replicas which the autoscaler should try to maintain
CreateDockerRepositoryResponse
typing_extensions.Annotated[(str, Any, Any)]
required
CreateMultiPartUploadRequest
str
required
ID of the artifact version to upload files to
str
required
Relative path within the artifact version where the file should be uploaded
int
required
Number of parts to split the upload into for multipart upload
CreatePersonalAccessTokenResponse
str
required
Personal Access Token
CronMetric
typing.Literal[Any]
default:"cron"
required
typing.Optional[int]
Desired number of replicas during the given interval. Default value is max_replicas.
str
required
Cron expression indicating the start of the cron schedule.
* * * * * | | | | | | | | | |___ day of week (0-6) (Sunday is 0) | | | |_____ month (1-12) | | |_______ day of month (1-31) | |_________ hour (0-23) |___________ minute (0-59)str
required
Cron expression indicating the end of the cron schedule.
* * * * * | | | | | | | | | |___ day of week (0-6) (Sunday is 0) | | | |_____ month (1-12) | | |_______ day of month (1-31) | |_________ hour (0-23) |___________ minute (0-59)str
default:"UTC"
required
Timezone against which the cron schedule will be calculated, e.g. “Asia/Tokyo”. Default is machine’s local time. https://docs.truefoundry.com/docs/list-of-supported-timezones
CustomAgentServerAuth
Union, One Of:CustomBasicAuth
typing.Literal[Any]
default:"basic-auth"
required
str
required
The username for the basic authentication.
str
required
The password for the basic authentication.
CustomBearerAuth
typing.Literal[Any]
default:"bearer-auth"
required
str
required
The bearer token for the custom bearer authentication.
CustomBlobStorage
typing.Literal[Any]
default:"integration/blob-storage/custom"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The endpoint of the storage provider.
str
required
The S3-compatible storage path in the format ‘s3://<bucket-name>/<optional-path-prefix>’. Works with S3-compatible storage providers like MinIO, Ceph, and DigitalOcean Spaces. Example: ‘s3://mybucket’ or ‘s3://mybucket/artifacts/production’.
typing.Optional[str]
The region where the storage is located.
CustomBasicAuth
required
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
CustomEndpoint
typing.Literal[Any]
default:"integration/model/custom-endpoint"
required
str
required
A descriptive name to identify this endpoint in the UI
str
required
The target base URL to proxy requests to (e.g., https://my-service.example.com/v1)
typing.Optional[CustomHeaderAuth]
typing.Optional[typing.Dict[(str, str)]]
Custom headers forwarded to the upstream endpoint with every request. For example:
\{"X-Custom-Header": "value"\}typing.Optional[CustomTlsSettings]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this endpoint. List of user fqn in format <user_type>:<username>.
CustomEndpointProviderAccount
typing.Literal[Any]
default:"provider-account/custom-endpoint"
required
str
required
The name of the custom endpoint provider account.
typing.Optional[CustomEndpointProviderAccountEndpointType]
🔗 CustomEndpointProviderAccountEndpointTypeThe type of service behind this endpoint (used for tracking purposes)
typing.Optional[CustomHeaderAuth]
typing.List[CustomEndpointIntegrations]
required
🔗 CustomEndpointList of endpoint integrations associated with this provider account.
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorCollaborators
CustomFramework
typing.Literal[Any]
default:"custom"
required
Type
CustomGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/custom"
required
typing.Optional[CustomGuardrailConfigAuthData]
🔗 CustomGuardrailConfigAuthDataAuthentication data for the Guardrail Server.
CustomGuardrailConfigOperation
required
🔗 CustomGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
CustomGuardrailConfigTarget
required
🔗 CustomGuardrailConfigTargetSpecify whether the guardrail should be applied to the request or response. Guardrails with target “Request” can be only used in input guardrails and guardrails with target “Response” can only be used in output guardrails.
CustomGuardrailConfigConfig
required
CustomGuardrailConfigAuthData
Union, One Of:CustomGuardrailConfigConfig
str
required
The URL of the Guardrail to send a post request to.
typing.Optional[typing.Dict[(str, str)]]
Headers for the Guardrail Server. Forwarded to the Guardrail Server as is. For example:
\{"Authorization": "APIKey \<token\>"\}typing.Optional[typing.Dict[(str, typing.Any)]]
The config for the Guardrail Server. This is a JSON object that will be sent as a config to Guardrail Server along with the request.
CustomHeaderAuth
typing.Literal[Any]
default:"header"
required
typing.Dict[(str, str)]
required
Headers passed to the generic secret server with every request.
CustomHelmRepo
typing.Literal[Any]
default:"integration/helm-repo/custom"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the Helm Repo.
CustomBasicAuth
required
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
CustomIntegrations
Union, One Of:- 🔗 CustomUsernamePasswordArtifactsRegistry
- 🔗 EmailNotificationChannel
- 🔗 CustomHelmRepo
- 🔗 CustomBlobStorage
- 🔗 CustomJwtAuthIntegration
- 🔗 GenericSecretStoreIntegration
CustomJwtAuthIntegration
typing.Literal[Any]
default:"integration/jwt-auth/custom"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The base URL of the authentication provider.
str
required
The JSON Web Key Set URI for JWT verification.
typing.Optional[OAuth2LoginProvider]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
CustomProviderAccount
typing.Literal[Any]
default:"provider-account/custom"
required
str
required
The name of the provider account.
typing.Optional[CustomBasicAuth]
typing.List[CustomIntegrations]
required
🔗 CustomIntegrationsList of integrations that are associated with the provider account.
CustomRegexPattern
str
required
A custom regex pattern to match against content (e.g., “\b\d{3}-\d{2}-\d{4}\b” for SSN)
typing.Optional[str]
default:"[REDACTED]"
Text to use when redacting matched content (only applicable in mutate mode). Defaults to ‘[REDACTED]’.
CustomServerHeaderAuth
typing.Literal[Any]
default:"header"
required
typing.Dict[(str, str)]
required
CustomServerPassthrough
typing.Literal[Any]
default:"passthrough"
required
CustomTlsSettings
bool
required
When set to true, it will reject any connection which is not authorized with the list of supplied CAs.
typing.Optional[str]
Add custom CA certificates to use for TLS verification.
CustomUsernamePasswordArtifactsRegistry
typing.Literal[Any]
default:"integration/docker-registry/custom"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the registry.
typing.Optional[CustomBasicAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
DataAccessRule
Union, One Of:DataAccessRuleBase
str
required
Unique identifier for the rule
typing.Optional[str]
Description of the rule
typing.Optional[bool]
Whether this rule is enabled
typing.List[str]
required
List of subjects that this rule applies to (users, teams, roles)
typing.List[GatewayDataType]
required
🔗 GatewayDataTypeList of data types that this rule applies to
DatabricksApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
API key for Databricks authentication.
DatabricksJobTaskConfig
typing.Literal[Any]
default:"databricks-job-task-config"
required
DatabricksJobTaskConfigImage
required
🔗 DatabricksJobTaskConfigImageSpecify the image spec for the task
str
required
Databricks workspace URL, e.g. https://<workspace>.cloud.databricks.com
str
required
The Databricks job ID to run (from Databricks workspace Jobs).
typing.Optional[str]
Service Account
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Optional parameters to pass to the job run (e.g. notebook params, jar params).
typing.Optional[float]
Maximum seconds to wait for the job run to complete. Used by CLI when polling.
typing.Optional[bool]
If false, the task waits for the Databricks job run to complete (trigger and poll). If true, only triggers the job and returns. Default false.
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the task either as plain text or secrets. Docs
typing.Optional[Resources]
DatabricksJobTaskConfigImage
Union, One Of:DatabricksModel
typing.Literal[Any]
default:"integration/model/databricks"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The serving endpoint name configured in your Databricks workspace. This is the endpoint you created in Databricks Model Serving, not the underlying model name.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Databricks model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
DatabricksProviderAccount
typing.Literal[Any]
default:"provider-account/databricks"
required
str
required
The name of the Databricks provider account
DatabricksProviderAccountAuthData
required
🔗 DatabricksProviderAccountAuthDataDatabricks authentication credentials
str
required
The base URL of your Databricks workspace
typing.List[DatabricksIntegrations]
required
List of integrations that are associated with the Databricks provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
DatabricksProviderAccountAuthData
Union, One Of:DatabricksServicePrincipalAuth
typing.Literal[Any]
default:"service-principal"
required
str
required
OAuth secret of the Databricks service principal.
str
required
Client ID or Application ID of the Databricks service principal.
DataDirectory
str
required
Unique identifier for the data directory
str
required
ID of the ML Repo that this data directory belongs to
str
required
Name of the data directory
str
required
Fully qualified name of the data directory
dt.datetime
required
Timestamp when the data directory was created
dt.datetime
required
Timestamp when the data directory was last updated
DataDirectoryManifest
required
🔗 DataDirectoryManifestManifest containing metadata for the data directory
typing.Optional[str]
Code snippet demonstrating how to use this data directory
DataDirectoryManifest
typing.Literal[Any]
default:"data-dir"
required
str
required
Name of the data directory
str
required
Name of the ML Repo to create the data directory under
typing.Optional[str]
Description for the data directory
typing.Dict[(str, typing.Any)]
required
Key Value metadata. Should be valid JSON. For e.g.
\{"business-unit": "sales", "quality": "good", "rating": 4.5\}DataDirectoryManifestSource
required
DataDirectoryManifestSource
Union, One Of:DeactivateUserResponse
Union, One Of:DeepgramApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Deepgram authentication
DeepgramModel
typing.Literal[Any]
default:"integration/model/deepgram"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Deepgram model identifier (for example, nova-2, nova-2-general, aura-asteria-en)
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Deepgram model (text_to_speech or audio_transcription)
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
DeepgramProviderAccount
typing.Literal[Any]
default:"provider-account/deepgram"
required
str
required
The name of the Deepgram provider account
DeepgramApiKeyAuth
required
typing.Optional[str]
Optional custom base URL for Deepgram API
typing.List[DeepgramModel]
required
🔗 DeepgramModelList of integrations that are associated with the Deepgram provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
DeepinfraKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for DeepInfra authentication
DeepinfraModel
typing.Literal[Any]
default:"integration/model/deepinfra"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The DeepInfra model identifier (e.g., meta-llama/Llama-3.3-70B-Instruct-Turbo, mistralai/Mistral-Small-24B-Instruct-2501). This is the full model path from DeepInfra’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the DeepInfra model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
DeepinfraProviderAccount
typing.Literal[Any]
default:"provider-account/deepinfra"
required
str
required
The name of the DeepInfra provider account
DeepinfraKeyAuth
required
typing.Optional[typing.List[DeepinfraIntegrations]]
List of integrations that are associated with the DeepInfra provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
DeleteApplicationResponse
str
required
Application deletion message
DeleteJobRunResponse
str
required
Job run deleted
DeletePersonalAccessTokenResponse
Union, One Of:DeleteSecretGroupResponse
Union, One Of:DeleteTeamResponse
Union, One Of:DeleteUserResponse
Union, One Of:DeleteVirtualAccountResponse
Union, One Of:Deployment
typing.Optional[str]
typing.Optional[float]
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
DeploymentManifest
required
typing.Optional[Any]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[BuildInfo]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[DeploymentStatus]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[DeploymentStatus], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[Recommendation]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
DeploymentBuild
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[BuildInfo]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
typing.Optional[BuildStatus]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[typing.Dict[(str, typing.Any)]]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
DeploymentManifest
Union, One Of:- 🔗 Service
- 🔗 AsyncService
- 🔗 Job
- 🔗 Notebook
- 🔗 Codeserver
- 🔗 SshServer
- 🔗 RStudio
- 🔗 Helm
- 🔗 Volume
- 🔗 ApplicationSet
- 🔗 Workflow
- 🔗 SparkJob
- 🔗 Intercept
DeploymentStatus
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[DeploymentStatusValue]
typing.Optional[typing.Dict[(str, typing.Any)]]
typing.Optional[DeploymentTransition]
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[float], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
DeveloperMessage
typing.Literal[Any]
default:"developer"
required
The role of the messages author, in this case developer.
DeveloperMessageContent
required
🔗 DeveloperMessageContentThe contents of the developer message.
typing.Optional[str]
An optional name for the participant.
DeveloperMessageContent
Union, One Of:DockerFileBuild
typing.Literal[Any]
default:"dockerfile"
required
str
default:"./Dockerfile"
required
The file path of the Dockerfile relative to project root path.
str
default:"./"
required
Build context path for the Dockerfile relative to project root path.
typing.Optional[DockerFileBuildCommand]
🔗 DockerFileBuildCommandOverride the command to run when the container starts When deploying a Job, the command can be templatized by defining
params and referencing them in command E.g. python main.py --learning_rate \{\{learning_rate\}\}typing.Optional[typing.Dict[(str, str)]]
Build arguments to pass to docker build
typing.Optional[typing.List[BuildSecret]]
🔗 BuildSecretBuild secrets you can use in run statements inside dockerfile like RUN —mount=type=secret,id=pip_index_url … you can learn more about build secrets here https://www.truefoundry.com/docs/docker-build-secrets
DockerFileBuildCommand
Union, One Of:DockerhubBasicAuth
typing.Literal[Any]
default:"basic-auth"
required
str
required
str
required
DockerhubProviderAccount
typing.Literal[Any]
default:"provider-account/dockerhub"
required
str
required
3 to 36 lower case characters long alphanumeric word, may contain - in between, cannot start with a number
typing.Optional[str]
Account Name
typing.Optional[DockerhubBasicAuth]
typing.List[DockerhubIntegrations]
required
DockerhubRegistry
typing.Literal[Any]
default:"integration/docker-registry/dockerhub"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
Registry URL
typing.Optional[DockerhubBasicAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
DynamicVolumeConfig
typing.Literal[Any]
default:"dynamic"
required
Volume Type for the volume.
str
required
Name of the storage class to be used for the volume.
int
required
Size of volume in Gi
ElevenLabsApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The XI API key for ElevenLabs authentication
ElevenLabsModel
typing.Literal[Any]
default:"integration/model/elevenlabs"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The ElevenLabs model identifier (for example, eleven_multilingual_v2, eleven_turbo_v2_5)
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the ElevenLabs model (text_to_speech or audio_transcription)
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
ElevenLabsProviderAccount
typing.Literal[Any]
default:"provider-account/elevenlabs"
required
str
required
The name of the ElevenLabs provider account
ElevenLabsApiKeyAuth
required
typing.Optional[str]
Optional custom base URL for ElevenLabs API
typing.List[ElevenLabsModel]
required
🔗 ElevenLabsModelList of integrations that are associated with the ElevenLabs provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
typing.Literal[Any]
default:"email"
required
str
required
Specify the notification channel to send alerts to
typing.List[str]
required
List of recipients’ email addresses if the notification channel is Email.
EmailNotificationChannel
typing.Literal[Any]
default:"integration/notification-channel/email"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
SmtpCredentials
required
str
required
The email address from which the email will be sent.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
EmptyResponse
Union, One Of:Endpoint
str
required
Host e.g. ai.example.com, app.truefoundry.com
typing.Optional[str]
Path e.g. /v1/api/ml/, /v2/docs/
EnkryptAiGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/enkrypt-ai"
required
EnkryptAiKeyAuth
required
EnkryptAiGuardrailConfigOperation
required
🔗 EnkryptAiGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
EnkryptAiGuardrailConfigConfig
required
EnkryptAiGuardrailConfigConfig
str
required
The name of the guardrail to use for the Enkrypt AI Guardrail.
EnkryptAiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Enkrypt AI authentication
Environment
typing.Optional[str]
float
required
EnvironmentColor
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(bool, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[EnvironmentOptimizeFor], Any, Any)]
EnvironmentManifest
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
EnvironmentColor
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
EnvironmentManifest
typing.Literal[Any]
default:"environment"
required
str
required
Environment Name
EnvironmentColor
required
typing_extensions.Annotated[(bool, Any, Any)]
required
typing_extensions.Annotated[(EnvironmentOptimizeFor, Any, Any)]
required
Event
typing.Optional[str]
Name of the event
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(EventInvolvedObject, Any, Any)]
required
str
required
Type of the event
int
required
Number of occurrences of the event
str
required
Reason for the event
str
required
Message describing the event
typing.Optional[str]
Namespace of the event
EventChart
required
🔗 EventChartChart of the event
EventChart
EventChartCategory
required
EventInvolvedObject
str
required
str
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
ExactMatchCacheConfig
typing.Literal[Any]
default:"exact-match"
required
typing.Optional[str]
Cache namespace (defaults to ‘default’ if not provided)
float
default:"3600.0"
required
Time-to-live for cached entries in seconds (max 3 days)
ExternalBlobStorageSource
typing.Literal[Any]
default:"external"
required
str
required
URI referencing a path in the blob storage bucket linked to the MLRepo
FastAiFramework
typing.Literal[Any]
default:"fastai"
required
FiddlerGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/fiddler"
required
FiddlerKeyAuth
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Fiddler guardrails can only be used for validation.
EnforcingStrategy
required
FiddlerGuardrailConfigConfig
required
FiddlerGuardrailConfigConfig
FiddlerGuardType
required
typing.Optional[float]
Confidence threshold (0.0-1.0) for flagging content. Content scoring above the threshold will be flagged
FiddlerKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
API key for the Fiddler account
FileInfo
str
required
Relative path of the file or directory within the artifact version
bool
required
Whether this path represents a directory (true) or a file (false)
typing.Optional[int]
Size of the file in bytes (only present for files, not directories)
typing.Optional[str]
Pre-signed URL to download the file directly (only present for files)
typing.Optional[dt.datetime]
Timestamp when the file was last modified
FlyteLaunchPlan
FlyteLaunchPlanId
required
FlyteLaunchPlanSpec
required
typing.Any
required
FlyteLaunchPlanId
typing_extensions.Annotated[(typing.Literal[Any], Any, Any)]
default:"LAUNCH_PLAN"
required
str
required
FlyteLaunchPlanSpec
typing_extensions.Annotated[(FlyteWorkflowId, Any, Any)]
required
FlyteTask
FlyteTaskTemplate
required
typing.Optional[typing.Any]
FlyteTaskCustom
FlyteTaskCustomTruefoundry
required
FlyteTaskCustomTruefoundry
Union, One Of:FlyteTaskId
typing_extensions.Annotated[(typing.Literal[Any], Any, Any)]
default:"TASK"
required
str
required
FlyteTaskTemplate
FlyteTaskId
required
FlyteTaskCustom
required
FlyteWorkflow
FlyteWorkflowTemplate
required
typing.Optional[typing.Any]
FlyteWorkflowId
typing_extensions.Annotated[(typing.Literal[Any], Any, Any)]
default:"WORKFLOW"
required
str
required
FlyteWorkflowTemplate
FlyteWorkflowId
required
ForwardAction
typing.Literal[Any]
default:"forward"
required
str
required
Service uri to redirect to. This is the kubernetes fully qualified domain name that the target service can be reached on Eg - For a service called
sample-service in workspace ws this would be `sample-service.ws.svc.cluster.localint
required
Port to redirect the service traffic to
Function
str
required
Name of the tool/function being called
str
required
Arguments passed to the tool/function
FunctionSchema
str
required
Name of the function
typing.Optional[str]
Description of the function
typing.Optional[typing.Dict[(str, typing.Any)]]
Parameters schema for the function
typing.Optional[bool]
Indicates if the function should be called strictly
GatewayConfig
Union, One Of:- 🔗 RateLimitConfig
- 🔗 LoadBalancingConfig
- 🔗 GuardrailsConfig
- 🔗 BudgetConfig
- 🔗 GatewayOtelConfig
- 🔗 GatewayMetadataConfig
- 🔗 GatewayLoggingConfig
- 🔗 GlobalSettings
- 🔗 GatewayDataAccessConfig
- 🔗 GatewayDataRoutingConfig
GatewayConfiguration
typing.Optional[str]
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
GatewayDataAccessConfig
typing.Literal[Any]
default:"gateway-data-access-config"
required
typing.List[DataAccessRule]
required
🔗 DataAccessRuleList of data access rules
GatewayDataCreatedByFilter
typing.Literal[Any]
default:"created_by"
required
Filter type
typing.Literal[Any]
default:"IN"
required
Comparison operator
typing.List[str]
required
List of subjects (users, virtual accounts, teams) to filter by
GatewayDataMetadataFilter
typing.Literal[Any]
default:"metadata"
required
Filter type
str
required
Metadata key to filter on
typing.Literal[Any]
default:"IN"
required
Comparison operator
typing.List[str]
required
Values to match against
GatewayDataRoutingConfig
typing.Literal[Any]
default:"gateway-data-routing-config"
required
Type of configuration
typing.Optional[typing.List[GatewayDataRoutingConfigDestination]]
🔗 GatewayDataRoutingConfigDestinationList of conditional routing destinations
GatewayDataRoutingConfigDestinationStorage
required
GatewayDataRoutingConfigDestination
str
required
Name for the destination
bool
required
Whether this destination is enabled
typing.Optional[str]
Description of the destination
typing.List[GatewayDataRoutingConfigDestinationCondition]
required
🔗 GatewayDataRoutingConfigDestinationConditionConditions that must be met to use this destination
GatewayDataRoutingConfigDestinationCondition
Union, One Of:- 🔗 GatewayDataRoutingConfigDestinationMetadataCondition
- 🔗 GatewayDataRoutingConfigDestinationCreatedByCondition
GatewayDataRoutingConfigDestinationControlPlaneManagedStorage
typing.Literal[Any]
default:"controlplane-managed"
required
Type of storage configuration
typing.Optional[GatewayDataRoutingConfigDestinationControlPlaneManagedStorageRegion]
🔗 GatewayDataRoutingConfigDestinationControlPlaneManagedStorageRegionSpecifies the region where control plane–managed storage is located.
GatewayDataRoutingConfigDestinationCreatedByCondition
typing.Literal[Any]
default:"created_by"
required
Field to evaluate the condition on
typing.Literal[Any]
default:"IN"
required
Operator to use for comparison
typing.List[str]
required
Value to compare against
GatewayDataRoutingConfigDestinationCustomerManagedStorage
typing.Literal[Any]
default:"customer-managed"
required
Type of storage configuration
str
required
Storage Integration FQN to store traces and spans. A storage integration represents a connected blob storage like AWS S3 / Azure Blob Storage / Google Cloud Storage.
GatewayDataRoutingConfigDestinationMetadataCondition
typing.Literal[Any]
default:"metadata"
required
Field to evaluate the condition on
str
required
Metadata key to match
typing.Literal[Any]
default:"IN"
required
Operator to use for comparison
typing.List[str]
required
Value to compare against
GatewayDataRoutingConfigDestinationStorage
GatewayDataRoutingConfigDestinationStorageStorage
required
🔗 GatewayDataRoutingConfigDestinationStorageStorageStorage configuration for traces and spans
typing.Optional[int]
Number of days to retain traces (this does not affect metrics storage)
GatewayDataRoutingConfigDestinationStorageStorage
Union, One Of:- 🔗 GatewayDataRoutingConfigDestinationControlPlaneManagedStorage
- 🔗 GatewayDataRoutingConfigDestinationCustomerManagedStorage
GatewayLoggingConfig
str
required
Name of the logging configuration
typing.Literal[Any]
default:"gateway-logging-config"
required
typing.List[GatewayLoggingRule]
required
🔗 GatewayLoggingRuleList of logging rules
GatewayLoggingRule
str
required
Unique identifier for the rule
GatewayLoggingWhen
required
str
required
FQN of the tracing project to send logs to
GatewayLoggingWhen
typing.Optional[typing.List[str]]
List of subjects that this rule applies to
GatewayMetadataConfig
str
required
Name of the metadata configuration
typing.Literal[Any]
default:"gateway-metadata-config"
required
typing.List[GatewayMetadataRule]
required
🔗 GatewayMetadataRuleList of metadata rules
GatewayMetadataRule
str
required
Unique identifier for the rule
GatewayMetadataWhen
required
typing.Dict[(str, str)]
required
Metadata key-value pairs to override in the request metadata
GatewayMetadataWhen
typing.Optional[typing.List[str]]
List of subjects that this rule applies to
GatewayOtelConfig
typing.Literal[Any]
default:"gateway-otel-config"
required
typing.Optional[GatewayOtelConfigOtelTracesExporterConfig]
🔗 GatewayOtelConfigOtelTracesExporterConfigSet this configuration to export LLM gateway OTEL traces to an external platform. Note that we only export OTEL traces via this configuration.
typing.Optional[GatewayOtelConfigOtelMetricsExporterConfig]
🔗 GatewayOtelConfigOtelMetricsExporterConfigSet this configuration to export LLM gateway OTEL metrics to an external platform. Note that we only export OTEL metrics via this configuration.
GatewayOtelConfigOtelMetricsExporterConfig
Union, One Of:GatewayOtelConfigOtelTracesExporterConfig
Union, One Of:GatewayRequestMetadataFilter
typing_extensions.Annotated[(str, Any, Any)]
required
GatewayRequestMetadataFilterOperator
required
GatewayRequestMetadataFilterValue
required
GatewayRequestMetadataFilterValue
Union, One Of:GcpApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
typing_extensions.Annotated[(str, Any, Any)]
required
GcpGcr
typing.Literal[Any]
default:"integration/docker-registry/gcp/gcr"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the registry.
typing.Optional[GcpKeyFileAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GcpGcs
typing.Literal[Any]
default:"integration/blob-storage/gcp/gcs"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The Google Cloud Storage path in the format ‘gs://<bucket-name>/<optional-path-prefix>’. Example: ‘gs://mybucket’ or ‘gs://mybucket/artifacts/production’.
typing.Optional[GcpKeyFileAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GcpGkeIntegration
typing.Literal[Any]
default:"integration/cluster/gcp/gke-standard"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
GcpRegion
required
str
required
Name of the cluster given in the cloud account.
typing.Optional[GcpKeyFileAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GcpGsm
typing.Literal[Any]
default:"integration/secret-store/gcp/gsm"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
typing.Optional[GcpKeyFileAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GcpIntegrations
Union, One Of:GcpKeyFileAuth
typing.Literal[Any]
default:"key-file"
required
GcpKeyFileAuthKeyFileContent
required
🔗 GcpKeyFileAuthKeyFileContentKey File Content - Key file content must be valid JSON
GcpKeyFileAuthKeyFileContent
Union, One Of:GcpProviderAccount
typing.Literal[Any]
default:"provider-account/gcp"
required
str
required
The name of the GCP provider account.
typing.Optional[str]
The project id of the GCP account.
typing.Optional[GcpKeyFileAuth]
typing.List[GcpIntegrations]
required
🔗 GcpIntegrationsList of integrations that are associated with the GCP provider account.
GcpTpu
typing.Literal[Any]
default:"gcp_tpu"
required
str
required
Name of the TPU Type. One of -
tpu-v4-podslice (TPU v4, ct4p) - tpu-v5-lite-device (TPU v5e, ct5l) - tpu-v5-lite-podslice (TPU v5e, ct5lp) - tpu-v5p-slice (TPU v5p, ct5p)str
required
Topology of the TPU slices. Currently only single-host topology is supported. Please refer to TPUs on GKE docs Allowed Values: -
2x2x1 for tpu-v4-podslice - One of 1x1, 2x2, 2x4 for tpu-v5-lite-device and tpu-v5-lite-podslice - 2x2x1 for tpu-v5p-sliceGeminiModel
typing.Literal[Any]
default:"integration/model/gemini"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Google Gemini model identifier (e.g., gemini-2.0-flash, gemini-2.0-flash-lite-preview-02-05, gemini-2.0-flash-lite-preview-02-05). This is the standard model name from Google’s Gemini API documentation.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Gemini model (e.g., chat, text, etc.)
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GenericSecretStoreIntegration
typing.Literal[Any]
default:"integration/secret-store/custom/generic"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
Base URL of the generic secret server.
CustomHeaderAuth
required
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GetAgentSkillResponse
AgentSkill
required
🔗 AgentSkillThe agent skill data
GetAgentSkillVersionResponse
AgentSkillVersion
required
🔗 AgentSkillVersionThe agent skill version data
GetAlertsResponse
typing.Dict[(str, typing.List[Alert])]
required
🔗 AlertObject containing alert data grouped by alert name
GetApplicationDeploymentResponse
Any
required
Deployment
GetApplicationResponse
Any
required
Application
GetArtifactResponse
Artifact
required
🔗 ArtifactThe artifact data
GetArtifactVersionResponse
ArtifactVersion
required
🔗 ArtifactVersionThe artifact version data
GetAuthenticatedVcsurlResponse
typing_extensions.Annotated[(str, Any, Any)]
required
GetAutoProvisioningStateResponse
typing.Optional[typing.Dict[(str, typing.Any)]]
State of auto-provisioning for the cluster.
GetChartsResponse
str
required
Step size
GetClusterResponse
GetDataDirectoryResponse
DataDirectory
required
🔗 DataDirectoryThe data directory data
GetDockerRegistryCredentialsResponse
str
required
Docker registry FQN
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
Docker registry username
str
required
Docker registry password
GetEnvironmentResponse
Environment
required
🔗 EnvironmentEnvironment
GetEventsResponse
GetJobRunResponse
GetLogsResponse
GetMlRepoResponse
GetModelResponse
GetModelVersionResponse
ModelVersion
required
🔗 ModelVersionThe model version data
GetOrCreatePersonalAccessTokenResponse
VirtualAccount
required
🔗 VirtualAccountPersonal Access Token data
str
required
Personal Access Token
bool
required
Whether the PAT was created (true) or already existed (false)
GetPromptResponse
GetPromptVersionResponse
PromptVersion
required
🔗 PromptVersionThe prompt version data
GetSecretGroupResponse
SecretGroup
required
🔗 SecretGroupSecret Group
GetSecretResponse
Any
required
Secret
GetSignedUrLsRequest
str
required
ID of the artifact version to get signed URLs for
typing.List[str]
required
List of relative file paths within the artifact version to get signed URLs for
Operation
required
🔗 OperationOperation type for the signed URL (e.g., ‘READ’ or ‘WRITE’)
GetSignedUrLsResponse
typing.List[SignedUrl]
required
🔗 SignedUrlList of signed URLs for the requested file paths
GetSuggestedDeploymentEndpointResponse
str
required
Host name
typing.Optional[str]
Path
typing.Optional[ClusterGateway]
🔗 ClusterGatewayGateway configuration
GetTeamPermissionsResponse
typing.List[SubjectPermission]
required
🔗 SubjectPermissionRole bindings for the team
GetTeamResponse
GetTokenForVirtualAccountResponse
str
required
Token for the virtual account
GetUserPermissionsResponse
typing.List[SubjectPermission]
required
🔗 SubjectPermissionRole bindings for the user (including team-inherited)
GetUserResourcesResponse
typing.List[UserResource]
required
🔗 UserResourceResources where user is a collaborator
GetUserResponse
GetUserTeamsResponse
typing.List[UserTeamInfo]
required
🔗 UserTeamInfoTeams where user is a member, with their role
GetVirtualAccountResponse
VirtualAccount
required
🔗 VirtualAccountVirtual Account
typing.Optional[str]
Virtual Account token (present only when creating a virtual account)
GetWorkspaceResponse
Workspace
required
🔗 WorkspaceWorkspace
GitHelmRepo
typing.Literal[Any]
default:"git-helm-repo"
required
str
required
Git repository URL - Needs to be a valid URL.
str
required
Branch/Commit SHA/Tag of the git repo.
str
required
Path to the chart.
typing.Optional[typing.List[str]]
Helm values files for overriding values in the helm chart. The path is relative to the Path directory defined above
GithubIntegration
typing.Literal[Any]
default:"integration/vcs/github"
required
str
required
str
required
Account Name
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GithubProviderAccount
typing.Literal[Any]
default:"provider-account/github"
required
str
required
typing.List[GithubIntegration]
required
GitlabIntegration
typing.Literal[Any]
default:"integration/vcs/gitlab"
required
str
required
str
required
Account Name
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GitlabProviderAccount
typing.Literal[Any]
default:"provider-account/gitlab"
required
str
required
typing.List[GitlabIntegration]
required
GitRepositoryExistsResponse
bool
required
The flag if repository exists or not
typing.Optional[str]
The integration id of the repository
GitSource
typing.Literal[Any]
default:"git"
required
str
required
The repository URL.
str
required
The commit SHA.
typing.Optional[str]
Selecting branch will select latest commit SHA of the branch.
GlobalSettings
typing.Literal[Any]
default:"gateway-global-settings"
required
typing.Optional[RetryConfig]
typing.Optional[LoggingMode]
typing.Optional[SemanticCacheSettings]
GluonFramework
typing.Literal[Any]
default:"gluon"
required
GoogleGeminiProviderAccount
typing.Literal[Any]
default:"provider-account/google-gemini"
required
str
required
The name of the Google Gemini provider account
GcpApiKeyAuth
required
typing.List[GeminiModel]
required
🔗 GeminiModelList of integrations that are associated with the Google Gemini provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
GoogleModelArmorApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
Google Cloud API key with Model Armor access
GoogleModelArmorGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/google-model-armor"
required
GoogleModelArmorGuardrailConfigAuthData
required
🔗 GoogleModelArmorGuardrailConfigAuthDataAuthentication credentials for Google Cloud Model Armor
GoogleModelArmorGuardrailConfigOperation
required
🔗 GoogleModelArmorGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
GoogleModelArmorGuardrailConfigConfig
required
GoogleModelArmorGuardrailConfigAuthData
Union, One Of:GoogleModelArmorGuardrailConfigConfig
str
required
The Google Cloud project ID where Model Armor is enabled
GcpRegion
required
str
required
The Model Armor template name that defines which filters and confidence thresholds to apply (e.g. my-template)
GoogleModelArmorKeyFileAuth
typing.Literal[Any]
default:"key-file"
required
GoogleModelArmorKeyFileAuthKeyFileContent
required
🔗 GoogleModelArmorKeyFileAuthKeyFileContentThe JSON content of your Google Cloud service account key file with Model Armor permissions
GoogleModelArmorKeyFileAuthKeyFileContent
Union, One Of:GoogleVertexProviderAccount
typing.Literal[Any]
default:"provider-account/google-vertex"
required
str
required
The name of the Google Vertex provider account
str
required
The Google Cloud project ID where Vertex AI is enabled
VertexRegion
required
typing.Optional[GoogleVertexProviderAccountAuthData]
🔗 GoogleVertexProviderAccountAuthDataService account key JSON, or Workload Identity Federation file (workload-identity-federation-file) with external_account JSON (e.g. create-cred-config). https://docs.truefoundry.com/gateway/google-vertex
typing.List[VertexModel]
required
🔗 VertexModelList of integrations that are associated with the Google Vertex provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
GoogleVertexProviderAccountAuthData
Union, One Of:Graph
str
required
Name
str
required
Description
str
required
Chart name
typing_extensions.Annotated[(GraphChartType, Any, Any)]
required
str
required
Chart params
GraySwanCygnalApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
GraySwan API key for Cygnal access
GraySwanCygnalGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/grayswan-cygnal"
required
GraySwanCygnalApiKeyAuth
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. GraySwan Cygnal guardrails can only be used for validation.
EnforcingStrategy
required
GraySwanCygnalGuardrailConfigConfig
required
GraySwanCygnalGuardrailConfigConfig
typing.Optional[str]
Optional override for the Cygnal monitor endpoint. Defaults to https://api.grayswan.ai/cygnal/monitor if not provided.
typing.Optional[typing.List[str]]
Custom policy IDs to use for monitoring. Rules from all policies are merged in order, with earlier policies taking precedence. If not provided, the default Basic Content Safety policy is applied, refer to Docs
typing.Optional[typing.Dict[(str, str)]]
Custom rule definitions for monitoring. Each key is a rule name and its value is the rule description, refer to Docs
GraySwanCygnalGuardrailConfigConfigReasoningMode
required
🔗 GraySwanCygnalGuardrailConfigConfigReasoningModeControls whether Cygnal uses internal reasoning steps before determining if content violates policy. “off” is fastest, “hybrid” adds moderate reasoning, “thinking” performs guided reasoning for highest quality.
GroqKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Groq authentication
GroqModel
typing.Literal[Any]
default:"integration/model/groq"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Groq model identifier (e.g., llama-3.1-8b-instant, openai/gpt-oss-20b). This is the standard model id from Groq’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Groq model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
GroqProviderAccount
typing.Literal[Any]
default:"provider-account/groq"
required
str
required
The name of the Groq provider account
GroqKeyAuth
required
typing.List[GroqIntegrations]
required
List of integrations that are associated with the Groq provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
GuardrailConfigGroup
typing.Literal[Any]
default:"provider-account/guardrail-config-group"
required
str
required
The name of the Guardrail Config Group.
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this Guardrail Config Group.
typing.List[GuardrailConfigIntegrations]
required
🔗 GuardrailConfigIntegrationsList of Guardrail Configs, which are part of this Guardrail Config Group.
GuardrailConfigIntegrations
Union, One Of:- 🔗 OpenAiModerationsGuardrailConfig
- 🔗 AwsBedrockGuardrailConfig
- 🔗 CustomGuardrailConfig
- 🔗 AzurePiiGuardrailConfig
- 🔗 AzureContentSafetyGuardrailConfig
- 🔗 AzurePromptShieldGuardrailConfig
- 🔗 EnkryptAiGuardrailConfig
- 🔗 PaloAltoPrismaAirsGuardrailConfig
- 🔗 FiddlerGuardrailConfig
- 🔗 PangeaGuardrailConfig
- 🔗 PatronusGuardrailConfig
- 🔗 SecretDetectionGuardrailConfig
- 🔗 CodeSafetyLinterGuardrailConfig
- 🔗 SqlSanitizerGuardrailConfig
- 🔗 RegexGuardrailConfig
- 🔗 TfyContentModerationGuardrailConfig
- 🔗 TfyPiiGuardrailConfig
- 🔗 TfyPromptInjectionGuardrailConfig
- 🔗 CedarGuardrailConfig
- 🔗 OpaGuardrailConfig
- 🔗 GoogleModelArmorGuardrailConfig
- 🔗 GraySwanCygnalGuardrailConfig
- 🔗 AktoGuardrailConfig
- 🔗 TrojAiGuardrailConfig
Guardrails
typing.Optional[typing.List[str]]
List of guardrail names to apply to user input messages before processing.
typing.Optional[typing.List[str]]
List of guardrail names to apply to AI response messages before returning to user.
GuardrailsConfig
typing.Literal[Any]
default:"gateway-guardrails-config"
required
typing.List[GuardrailsRule]
required
🔗 GuardrailsRuleList of guardrail rules
GuardrailsRule
str
required
Unique identifier for the rule
GuardrailsWhen
required
typing.List[str]
required
Guardrail selectors of the guardrails to apply to the input (format: groupName/guardrailName)
typing.List[str]
required
Guardrail selectors of the guardrails to apply to the output (format: groupName/guardrailName)
typing.List[str]
required
Guardrail selectors of the guardrails to apply to the MCP tool pre invoke (format: groupName/guardrailName)
typing.List[str]
required
Guardrail selectors of the guardrails to apply to the MCP tool post invoke (format: groupName/guardrailName)
GuardrailsWhen
typing.Optional[TargetConditionGroup]
typing.Optional[SubjectConditionGroup]
typing.Optional[typing.Dict[(str, str)]]
H2OFramework
typing.Literal[Any]
default:"h2o"
required
HashicorpAppRoleAuth
typing.Literal[Any]
default:"approle"
required
str
required
AppRole role ID for Vault authentication.
str
required
AppRole secret ID for Vault authentication.
HashicorpProviderAccount
typing.Literal[Any]
default:"provider-account/hashicorp"
required
str
required
The name of the HashiCorp Vault provider account.
typing.List[HashicorpIntegrations]
required
List of integrations that are associated with the HashiCorp Vault provider account.
HashicorpTokenAuth
typing.Literal[Any]
default:"token"
required
str
required
Vault authentication token that you want to use for authentication.
HashicorpVaultIntegration
typing.Literal[Any]
default:"integration/secret-store/hashicorp/vault"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the HashiCorp Vault server (e.g., https://vault.example.com:8200).
str
required
Mount path of the KV v2 engine vault to use for secrets.
typing.Optional[str]
HashicorpVaultIntegrationAuthData
required
🔗 HashicorpVaultIntegrationAuthDataAuthentication data for the Vault integration.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
typing.Optional[str]
Namespace for vault operations, used for multi-tenancy in HashiCorp Vault Enterprise. Optional for open source Vault.
HashicorpVaultIntegrationAuthData
Union, One Of:HeaderMatch
typing.Literal[Any]
default:"header"
required
str
required
Header name to match on
str
required
Header value to match on
HeaderRoutingConfig
Union, One Of:HeadersOverride
typing.Optional[typing.List[str]]
List of headers to remove from upstream request
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, str)]], Any, Any)]
HealthProbe
HttpProbe
required
typing.Optional[int]
Time to wait after container has started before checking the endpoint
typing.Optional[int]
default:"10"
How often to check the endpoint
typing.Optional[int]
default:"1"
Time to wait for a response from the endpoint before considering it down
typing.Optional[int]
default:"1"
Number of successful responses from the endpoint before container is considered healthy
typing.Optional[int]
default:"3"
Number of consecutive failures before the container is considered down
Helm
typing.Literal[Any]
default:"helm"
required
str
required
Name of the Helm deployment. This will be set as the release name of the chart you are deploying.
typing.Optional[typing.Dict[(str, str)]]
Add labels to base argo app
HelmSource
required
🔗 HelmSourceSource helm repository
typing.Optional[typing.Dict[(str, typing.Any)]]
Values file as block file
typing.Optional[Kustomize]
typing_extensions.Annotated[(typing.Optional[typing.List[typing.Dict[(str, typing.Any)]]], Any, Any)]
typing.Optional[str]
Fully qualified name of the workspace
HelmRepo
typing.Literal[Any]
default:"helm-repo"
required
str
required
Helm repository URL - Needs to be a valid URL.
typing.Optional[str]
FQN of the helm repo integration. If you can’t find your integration here, add it through the Integrations page
str
required
The helm chart name
str
required
Helm chart version
HelmSource
Union, One Of:HostedA2AAgent
typing.Literal[Any]
default:"hosted-a2a-agent"
required
Type of agent source
str
required
Agent Card URL for the A2A Agent
typing.Optional[typing.Dict[(str, str)]]
Headers to be sent with the request to the hosted A2A agent. Primarily used for authentication.
HttpError
typing_extensions.Annotated[(int, Any, Any)]
required
str
required
Error Message
typing.Optional[HttpErrorCode]
🔗 HttpErrorCodeError code
typing.Optional[typing.List[typing.Dict[(str, typing.Any)]]]
Error details
HttpErrorCode
Union, One Of:HttpProbe
typing.Literal[Any]
default:"http"
required
Request Type
str
required
Path to the health check endpoint
int
required
Listening port for the health check endpoint
typing.Optional[str]
Host name to connect to, defaults to the pod IP
typing.Optional[str]
default:"HTTP"
Scheme to use for connecting to the host
HttpValidationError
typing.Optional[typing.List[ValidationError]]
HuggingfaceArtifactSource
typing.Literal[Any]
default:"huggingface-hub"
required
str
required
Model ID of the artifact to be downloaded
str
required
Revision of the artifact to be downloaded
typing.List[str]
required
List of patterns to ignore while downloading the artifact
str
required
Environment variable which will contain the download path of the artifact
IChange
IChangeOperation
required
str
required
typing.Optional[typing.Dict[(str, typing.Any)]]
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, typing.Any)]], Any, Any)]
typing.Optional[typing.List[Any]]
Image
typing.Literal[Any]
default:"image"
required
str
required
The image URI. Specify the name of the image and the tag. If the image is in Dockerhub, you can skip registry-url (for e.g.
tensorflow/tensorflow). You can use an image from a private registry using Advanced fieldstyping.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
typing.Optional[ImageCommand]
🔗 ImageCommandOverride the command to run when container starts. When deploying a Job, the command can be templatized by defining
params and referencing them in command E.g. python main.py --learning_rate \{\{learning_rate\}\}ImageCommand
Union, One Of:ImageContentPart
typing.Literal[Any]
default:"image_url"
required
Type of the content part
ImageContentPartImageUrl
required
🔗 ImageContentPartImageUrlImage URL linking to the image
ImageContentPartImageUrl
ImageContentPartImageUrlUrl
required
🔗 ImageContentPartImageUrlUrlImage URL linking to the image
typing.Optional[str]
Details
ImageContentPartImageUrlUrl
Union, One Of:InfraProviderAccount
Union, One Of:- 🔗 AwsProviderAccount
- 🔗 AzureProviderAccount
- 🔗 GcpProviderAccount
- 🔗 DockerhubProviderAccount
- 🔗 BitbucketProviderAccount
- 🔗 CustomProviderAccount
- 🔗 GithubProviderAccount
- 🔗 GitlabProviderAccount
- 🔗 JfrogProviderAccount
- 🔗 TtlProviderAccount
- 🔗 TrueFoundryProviderAccount
- 🔗 QuayProviderAccount
- 🔗 SlackProviderAccount
- 🔗 WebhookProviderAccount
- 🔗 PagerDutyProviderAccount
- 🔗 HashicorpProviderAccount
IngressControllerConfig
str
default:"nginx"
required
Ingress Class Name
typing.Optional[bool]
Whether TLS is managed by the ingress controller. If enabled, the ingress object will have TLS configuration.
InlineSpecSource
typing.Literal[Any]
default:"inline"
required
InlineSpecSourceOpenapiSpec
required
🔗 InlineSpecSourceOpenapiSpecThe OpenAPI specification as a JSON object or a JSON/YAML string.
InlineSpecSourceOpenapiSpec
Union, One Of:InNotInOperator
InNotInOperatorCondition
required
typing.List[str]
required
InputOutputBasedCostMetricValue
NonNegativeFloat
required
NonNegativeFloat
required
typing.Optional[NonNegativeFloat]
typing.Optional[NonNegativeFloat]
typing.Optional[typing.List[PrivatePricingTier]]
🔗 PrivatePricingTierOptional volume-based pricing tiers for input tokens. Tokens up to the first tier use base rate above.
typing.Optional[typing.List[PrivatePricingTier]]
🔗 PrivatePricingTierOptional volume-based pricing tiers for output tokens. Tokens up to the first tier use base rate above.
typing.Optional[typing.List[PrivatePricingTier]]
🔗 PrivatePricingTierOptional volume-based pricing tiers for cache read tokens. Tokens up to the first tier use base rate above.
typing.Optional[typing.List[PrivatePricingTier]]
🔗 PrivatePricingTierOptional volume-based pricing tiers for cache write tokens. Tokens up to the first tier use base rate above.
Intercept
typing.Literal[Any]
default:"intercept"
required
str
required
Name of the service this intercept is for
typing.List[InterceptRulesItem]
required
InterceptRulesItem
int
required
Port of service to be intercepted
typing.Optional[HeaderMatch]
InterceptRulesItemAction
required
🔗 InterceptRulesItemActionAction to take on succesful match
InterceptRulesItemAction
Union, One Of:InternalArtifactVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
ArtifactManifest
required
🔗 ArtifactManifestManifest containing metadata for a generic artifact version
str
required
ID of the ML Repo that this artifact version belongs to
typing.Optional[typing.List[str]]
List of tags associated with this artifact version for filtering and organization
typing.Optional[str]
Optional human-readable version alias (e.g. v1.0.0)
typing.Optional[str]
Code snippet demonstrating how to use this artifact version
str
required
ID of the parent artifact that this version belongs to
str
required
Fully qualified name of the parent artifact (internal use only)
typing.Optional[int]
Total size of the artifact version in bytes (internal use only)
InternalListArtifactVersionsResponse
typing.List[InternalListArtifactVersionsResponseDataItem]
required
🔗 InternalListArtifactVersionsResponseDataItemList of artifact versions and model versions with internal metadata
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
InternalListArtifactVersionsResponseDataItem
Union, One Of:InternalModelVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
ModelManifest
required
🔗 ModelManifestManifest containing metadata specific to the model version
str
required
ID of the ML Repo that this artifact version belongs to
typing.Optional[typing.List[str]]
List of tags associated with this artifact version for filtering and organization
typing.Optional[str]
Optional human-readable version alias (e.g. v1.0.0)
typing.Optional[str]
Code snippet demonstrating how to use this artifact version
str
required
ID of the parent model that this version belongs to
typing.Optional[bool]
Whether this model version is ready for deployment
str
required
Fully qualified name of the parent model (internal use only)
typing.Optional[int]
Total size of the model version in bytes (internal use only)
InviteUserResponse
str
required
IsClusterConnectedResponse
typing_extensions.Annotated[(bool, Any, Any)]
required
JfrogArtifactsRegistry
typing.Literal[Any]
default:"integration/docker-registry/jfrog"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the registry.
typing.Optional[JfrogBasicAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
JfrogBasicAuth
typing.Literal[Any]
default:"basic-auth"
required
str
required
The username for the basic authentication.
str
required
The password for the basic authentication.
JfrogProviderAccount
typing.Literal[Any]
default:"provider-account/jfrog"
required
str
required
The name of the provider account.
typing.Optional[str]
The name of the JFrog account.
typing.Optional[JfrogBasicAuth]
typing.List[JFrogIntegrations]
required
List of integrations that are associated with the provider account.
Job
typing.Literal[Any]
default:"job"
required
str
required
Name of the job
JobImage
required
🔗 JobImageSpecify whether you want to deploy a Docker image or build and deploy from source code
JobTrigger
required
🔗 JobTriggerSpecify the trigger
typing.Optional[bool]
Trigger the job after deploy immediately
typing.Optional[typing.List[Param]]
🔗 ParamConfigure params and pass it to create different job runs
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the service either as plain text or secrets. Docs
typing.Optional[Resources]
typing.Optional[typing.List[JobAlert]]
🔗 JobAlertConfigure alerts to be sent when the job starts/fails/completes
typing.Optional[int]
Specify the maximum number of attempts to retry a job before it is marked as failed.
typing.Optional[int]
Job timeout in seconds.
typing.Optional[int]
Number of runs that can run concurrently
typing.Optional[str]
typing.Optional[typing.List[JobMountsItem]]
🔗 JobMountsItemConfigure data to be mounted to job pod(s) as a string, secret or volume. Docs
typing.Optional[typing.Dict[(str, str)]]
Labels
typing.Optional[Kustomize]
typing.Optional[str]
Fully qualified name of the workspace
JobAlert
typing.Optional[str]
Specify the notification channel to send alerts to
typing.Optional[typing.List[str]]
List of recipients’ email addresses if the notification channel is Email.
typing.Optional[NotificationTarget]
typing.Optional[bool]
Send an alert when the job starts
typing.Optional[bool]
typing.Optional[bool]
Send an alert when the job fails
JobImage
Union, One Of:JobMountsItem
Union, One Of:JobRun
str
required
JobRun ID
str
required
JobRun Name
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(float, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[float], Any, Any)]
typing.Optional[int]
Duration of JobRun
str
required
Command
typing_extensions.Annotated[(int, Any, Any)]
required
typing.Optional[str]
Error
JobRunStatus
required
🔗 JobRunStatusStatus of JobRun
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[int], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
JobTrigger
Union, One Of:JobTriggerInput
typing.Optional[JobTriggerInputCommand]
🔗 JobTriggerInputCommandCommand
typing.Optional[typing.Dict[(str, typing.Any)]]
Parameters used to populate template command
JobTriggerInputCommand
Union, One Of:JsonObjectResponseFormat
typing.Literal[Any]
default:"json_object"
required
JsonSchema
str
required
Name of the schema
typing_extensions.Annotated[(typing.Dict[(str, typing.Any)], Any, Any)]
required
JsonSchemaResponseFormat
typing.Literal[Any]
default:"json_schema"
required
JsonSchema
required
Jwt
str
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[typing.Dict[(str, typing.Any)]]
dt.datetime
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
JwtAuthConfig
typing.Literal[Any]
default:"jwt_auth"
required
str
required
FQN of the JWT Auth integration. If you can’t find your integration here, add it through the Integrations page
typing.Optional[bool]
Enable login for the service
typing.Optional[typing.List[JwtAuthConfigClaimsItem]]
🔗 JwtAuthConfigClaimsItemList of key-value pairs of claims to verify in the JWT token
typing.Optional[typing.List[str]]
List of paths that will bypass auth. needs to start with a forward slash(/) and should not contain wildcards(*)
JwtAuthConfigClaimsItem
str
required
typing.List[str]
required
KafkaInputConfig
typing.Literal[Any]
default:"kafka"
required
str
required
‘Kafka Bootstrap servers - Comma separated list of Kafka brokers “hostname:port” to connect to for bootstrap’
str
required
Kafka topic to subscribe to
str
required
The name of the consumer group to join for dynamic partition assignment
bool
required
TLS configuration for SASL authentication
typing.Optional[int]
default:"10"
Wait timeout for long polling.
typing.Optional[KafkaSaslAuth]
KafkaMetricConfig
typing.Literal[Any]
default:"kafka"
required
int
required
Upper limit of the number of backlog messages the auto-scaler will try to maintain per replica. If you set this number to 10 and have 30 messages in the stream and one replica, the auto-scaler will scale the number of replicas to 3.
KafkaOutputConfig
typing.Literal[Any]
default:"kafka"
required
str
required
‘Kafka Bootstrap servers - Comma separated list of Kafka brokers “hostname:port” to connect to for bootstrap’
str
required
Kafka topic to publish to
bool
required
TLS configuration for SASL authentication
typing.Optional[KafkaSaslAuth]
KafkaSaslAuth
str
required
Username for SASL authentication
str
required
Password for SASL authentication
KerasFramework
typing.Literal[Any]
default:"keras"
required
Kustomize
typing.Optional[typing.Dict[(str, typing.Any)]]
Content of kustomization.yaml to perform kustomize operation. Please do not include the
resources section. It is filled in automaticallytyping.Optional[typing.List[typing.Dict[(str, typing.Any)]]]
Additional kubernetes manifests to be included in the application
LatencyBasedLoadBalanceTarget
str
required
Target model or provider FQN
typing.Optional[RetryConfig]
typing.Optional[typing.List[str]]
Status Codes for which the request will fallback to other targets. If the status code is not present in fallback_status_codes, it fails immediately.
typing.Optional[bool]
Whether this target is a fallback candidate. If set to false, this model will not be considered as a fallback option for targets of this load-balance-rule
typing.Optional[typing.Dict[(str, typing.Any)]]
Optional parameters to override in the request
typing.Optional[HeadersOverride]
typing.Optional[typing.Dict[(str, str)]]
Optional metadata key-value pairs that must match incoming request metadata headers for this target to be considered for routing.
LatencyBasedLoadBalancing
typing.Literal[Any]
default:"latency-based-routing"
required
typing.List[LatencyBasedLoadBalanceTarget]
required
🔗 LatencyBasedLoadBalanceTargetList of targets for latency-based load balancing
LatencyBasedLoadBalancingRule
str
required
Unique identifier for the rule
LoadBalancingWhen
required
LegacyAgentManifest
typing.Literal[Any]
default:"agent"
required
Type of the manifest
str
required
The name of the Agent
str
required
The description of the Agent
AgentSource
required
typing.List[Collaborator]
required
🔗 CollaboratorList of users who have access to this Agent
typing.Optional[typing.List[SampleAgentInput]]
🔗 SampleAgentInputSample inputs for your agent. These inputs are shown as an example in the “Agent Chat” page. (Click on Try Now in the agent listing page)
LightGbmFramework
typing.Literal[Any]
default:"lightgbm"
required
ListAgentSkillsResponse
typing.List[AgentSkill]
required
🔗 AgentSkillList of agent skills matching the query
Pagination
required
🔗 PaginationPagination information
ListAgentSkillVersionsResponse
typing.List[AgentSkillVersion]
required
🔗 AgentSkillVersionList of agent skill versions
Pagination
required
🔗 PaginationPagination information
ListApplicationDeploymentsResponse
typing.List[Any]
required
Array of Deployments
Pagination
required
🔗 PaginationPagination information
ListApplicationsResponse
typing.List[Any]
required
Array of Applications
Pagination
required
🔗 PaginationPagination information
ListArtifactsResponse
typing.List[Artifact]
required
🔗 ArtifactList of artifacts matching the query
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListArtifactVersionsResponse
typing.List[ArtifactVersion]
required
🔗 ArtifactVersionList of artifact versions matching the query
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListClusterAddonsResponse
typing.List[AddonComponent]
required
🔗 AddonComponentArray of Cluster Addons
Pagination
required
🔗 PaginationPagination information
ListClustersResponse
Pagination
required
🔗 PaginationPagination information
ListDataDirectoriesResponse
typing.List[DataDirectory]
required
🔗 DataDirectoryList of data directories matching the query
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListEnvironmentsResponse
typing.List[Environment]
required
🔗 EnvironmentArray of Environments
Pagination
required
🔗 PaginationPagination information
ListFilesRequest
str
required
ID of the artifact version to list files from
typing.Optional[str]
Relative path within the artifact version to list files from (defaults to root)
typing.Optional[int]
Maximum number of files/directories to return
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
ListFilesResponse
typing.List[FileInfo]
required
🔗 FileInfoList of files and directories in the artifact version
TokenPagination
required
🔗 TokenPaginationPagination information including page tokens for navigation
ListJobRunResponse
Pagination
required
🔗 PaginationPagination Information
ListMlReposResponse
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListModelsResponse
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListModelVersionsResponse
typing.List[ModelVersion]
required
🔗 ModelVersionList of model versions matching the query
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListPersonalAccessTokenResponse
typing.List[VirtualAccount]
required
🔗 VirtualAccountArray of Personal Access Tokens
Pagination
required
🔗 PaginationPagination Information
ListPromptsResponse
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListPromptVersionsResponse
typing.List[PromptVersion]
required
🔗 PromptVersionList of prompt versions matching the query
Pagination
required
🔗 PaginationPagination information including total count, offset, and limit
ListSecretGroupResponse
typing.List[SecretGroup]
required
🔗 SecretGroupArray of Secret Groups
Pagination
required
🔗 PaginationPagination information
ListSecretsResponse
typing.List[Any]
required
Array of Secrets
Pagination
required
🔗 PaginationPagination Information
ListTeamsResponse
Pagination
required
🔗 PaginationPagination Information
ListUsersResponse
Pagination
required
🔗 PaginationPagination information
ListVirtualAccountResponse
typing.List[VirtualAccount]
required
🔗 VirtualAccountArray of Virtual Accounts
Pagination
required
🔗 PaginationPagination Information
ListWorkspacesResponse
typing.List[Workspace]
required
🔗 WorkspaceArray of Workspace
Pagination
required
🔗 PaginationPagination information
LoadBalanceTarget
str
required
Target model or provider FQN
int
required
Relative weight for routing decisions (higher values mean more traffic)
typing.Optional[RetryConfig]
typing.Optional[typing.List[str]]
Status Codes for which the request will fallback to other targets. If the status code is not present in fallback_status_codes, it fails immediately.
typing.Optional[bool]
Whether this target is a fallback candidate. If set to false, this model will not be considered as a fallback option for targets of this load-balance-rule
typing.Optional[typing.Dict[(str, typing.Any)]]
Optional parameters to override in the request
typing.Optional[HeadersOverride]
typing.Optional[typing.Dict[(str, str)]]
Optional metadata key-value pairs that must match incoming request metadata headers for this target to be considered for routing.
LoadBalancingConfig
typing.Literal[Any]
default:"gateway-load-balancing-config"
required
typing.List[LoadBalancingRule]
required
🔗 LoadBalancingRuleList of load balancing rules
LoadBalancingRule
Union, One Of:LoadBalancingWhen
typing.Optional[typing.List[str]]
List of subjects that this rule applies to
typing.Optional[typing.List[str]]
List of models that this rule applies to
typing.Optional[typing.Dict[(str, str)]]
Metadata key-value pairs that this rule applies to
LocalArtifactSource
typing.Literal[Any]
default:"local"
required
typing.List[ArtifactPath]
required
🔗 ArtifactPathArray of ArtifactPath objects representing the source and destination paths
LocalModelSource
typing.Literal[Any]
default:"local"
required
str
required
Path to the model file or folder
LocalSource
typing.Literal[Any]
default:"local"
required
str
default:"./"
required
Local project root path.
bool
required
run docker build locally
Log
typing.Optional[str]
Job Name
str
required
Log Content
str
required
Log Stream
str
required
Log Time
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
LoggingConfig
bool
required
Whether logging is enabled for the chat prompt
typing.Optional[str]
The FQN of the tracing project where the logs will be stored
LoggingMode
Union, One Of:LoggingModeAlways
typing.Literal[Any]
default:"always"
required
LoggingModeHeaderControlled
typing.Literal[Any]
default:"header_controlled"
required
bool
required
Sets the default body logging behaviour when no header is present. Enabling it will log requests by default and clients can opt out. Disabling it will NOT log by default and clients can opt in to log requests.
LoggingModeNever
typing.Literal[Any]
default:"never"
required
LogsFilterQuery
typing_extensions.Annotated[(str, Any, Any)]
required
LogsFilterQueryType
required
🔗 LogsFilterQueryTypequery filter type,
regex or substringLogsSearchOperatorType
required
🔗 LogsSearchOperatorTypeComparison operator for filter.
equal or not_equalLogsResponse
Manual
typing.Literal[Any]
default:"manual"
required
McpServerAuth
Union, One Of:McpServerEnvAuth
typing.Literal[Any]
default:"env"
required
typing.Dict[(str, str)]
required
Map each env variable to its value. For shared, enter the actual value. For individual, use a placeholder that will be filled in by each user (e.g. API_KEY {{API_KEY}}).
typing.Optional[McpServerEnvAuthAuthLevel]
🔗 McpServerEnvAuthAuthLevelLevel at which this authentication will be applied. Values: global (default), per_user
McpServerHeaderAuth
typing.Literal[Any]
default:"header"
required
typing.Dict[(str, str)]
required
Map each header name to its value. For shared, enter the actual value. For individual, use a placeholder that will be filled in by each user (e.g. Bearer {{API_KEY}}).
McpServerHeaderAuthAuthLevel
required
🔗 McpServerHeaderAuthAuthLevelLevel at which this authentication will be applied. Values: global (default), per_user
McpServerHeaderOverrideAuth
typing.Literal[Any]
default:"header"
required
typing.Dict[(str, str)]
required
McpServerIntegration
typing.Literal[Any]
default:"integration/mcp-server/remote"
required
str
required
The name of the MCP Server.
str
required
Provide a brief description of the purpose of this MCP Server.
str
required
The endpoint URL for the MCP Server.
McpServerIntegrationTransport
required
🔗 McpServerIntegrationTransportThe transport protocol to use for communication with the MCP Server.
typing.Optional[McpServerAuth]
typing.Optional[typing.List[str]]
List of teams/users who can use this MCP server.
McpServerIntegrations
Union, One Of:McpServerManifest
Union, One Of:- 🔗 RemoteMcpServerManifest
- 🔗 VirtualMcpServerManifest
- 🔗 OpenApimcpServerManifest
- 🔗 StdioMcpServerManifest
McpServerOAuth2
typing.Literal[Any]
default:"oauth2"
required
OAuth2 authentication
McpServerOAuth2GrantType
required
🔗 McpServerOAuth2GrantTypeThe OAuth2 grant type to use for authentication.
typing.Optional[str]
URL for the authorization request
str
required
The endpoint to exchange auth code for tokens.
typing.Optional[str]
client ID for OAuth2 or the TrueFoundry secret FQN containing the client ID.
typing.Optional[str]
Client secret or the TrueFoundry secret FQN containing the client secret for OAuth2.
typing.Optional[str]
URL for dynamic client registration (RFC 7591). If provided, client credentials will be obtained automatically using the Dynamic Client Registration (DCR) process.
typing.Optional[typing.List[typing.Literal[Any]]]
List of supported PKCE code challenge methods (S256 only)
McpServerOAuth2JwtSource
required
🔗 McpServerOAuth2JwtSourceSource of the JWT token to be used for verification.
typing.Optional[typing.List[str]]
List of scopes to request from the OAuth2 provider.
McpServerPassthrough
typing.Literal[Any]
default:"passthrough"
required
McpServerProviderAccount
typing.Literal[Any]
default:"provider-account/mcp-server-group"
required
str
required
The name of the MCP Server Group.
typing.List[Collaborator]
required
🔗 CollaboratorList of teams/users who can manage this MCP Server Group. These subjects can add new MCP server integrations, can edit existing ones and can also use the MCP server.
typing.List[McpServerIntegrations]
required
🔗 McpServerIntegrationsList of MCP Servers, which are part of this MCP Server Group.
McpServerSource
str
required
Name of the MCP server
typing.Optional[typing.List[str]]
List of tools to enable from this source server.
typing.Optional[McpServerHeaderOverrideAuth]
McpServerToolDetails
str
required
The integration ID of the MCP server
str
required
The name of the tool in the MCP server
McpServerWithFqn
typing.Literal[Any]
default:"mcp-server-fqn"
required
The FQN of the MCP server
str
required
The FQN of the MCP server
bool
required
Whether to enable all tools from the MCP server
McpServerWithUrl
typing.Literal[Any]
default:"mcp-server-url"
required
The URL of the MCP server
str
required
The URL of the MCP server
typing.Optional[typing.Dict[(str, str)]]
The headers to send to the MCP server
bool
required
Whether to enable all tools from the MCP server
McpTool
str
required
The name of the tool as it appears in the MCP server
McpToolSetting
str
required
The unique name of the tool.
typing.Optional[str]
Describe what this tool does. This helps AI models understand when to use it.
typing.Optional[bool]
Allows to disable the tool.
McpToolsOperator
McpToolsOperatorCondition
required
typing.List[McpToolTarget]
required
McpToolTarget
str
required
Name of the MCP server
bool
required
When enabled, all tools from this MCP server are targeted. Disable to select specific tools.
typing.Optional[typing.List[str]]
List of specific tools to target from this MCP server.
Metadata
typing.Optional[str]
Job Run Name Alias
Metric
str
required
Name of the metric
typing.Optional[float]
Value of the metric
typing.Optional[int]
Timestamp when the metric was recorded (epoch milliseconds)
typing.Optional[int]
Training step number when the metric was recorded
MirrorAction
typing.Literal[Any]
default:"mirror"
required
str
required
Service uri to mirror to. This is the kubernetes fully qualified domain name that the target service can be reached on Eg - For a service called
sample-service in workspace ws this would be `sample-service.ws.svc.cluster.localint
required
Port to redirect the service traffic to
int
required
Percentage of requests to mirror
MistralAiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Mistral AI authentication
MistralAiModel
typing.Literal[Any]
default:"integration/model/mistral-ai"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Mistral AI model identifier (e.g., mistral-medium-2312, ministral-8b-2410). This is the API Endpoint name from Mistral AI’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Mistral AI model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
MistralAiProviderAccount
typing.Literal[Any]
default:"provider-account/mistral-ai"
required
str
required
The name of the Mistral AI provider account
MistralAiKeyAuth
required
typing.List[MistralAiIntegrations]
required
List of integrations that are associated with the Mistral AI provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
MlRepo
str
required
Tenant Name
MlRepoManifest
required
dt.datetime
required
Created At
str
required
str
required
Experiment Id
typing.Optional[int]
Number of runs
typing.Optional[typing.Dict[(str, int)]]
typing.Optional[int]
Number of datasets
MlRepoManifest
typing.Literal[Any]
default:"ml-repo"
required
str
required
Name of the ML Repo.
typing.Optional[str]
Description for the ML Repo.
str
required
Storage Integration to store artifacts and models. A storage integration represents a connected blob storage like AWS S3 / Azure Blob Storage / Google Cloud Storage.
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to MLRepo
Model
str
required
Unique identifier for the artifact
str
required
ID of the ML Repo that this artifact belongs to
typing.Optional[typing.Literal[Any]]
Type of the artifact, always ‘model’ for Model entities
str
required
Name of the artifact (alphanumeric characters, hyphens, and underscores only, max 256 characters)
str
required
Fully qualified name of the artifact in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}’
typing.Optional[dt.datetime]
Timestamp when the artifact was created
typing.Optional[dt.datetime]
Timestamp when the artifact was last updated
typing.Optional[ModelVersion]
🔗 ModelVersionThe most recent version of this model
typing.Optional[typing.List[int]]
List of run step numbers where this artifact was created or updated
ModelConfiguration
str
required
Name of the provider, must be one of the integration providers configured for the Gateway
str
required
Name of the model to be used for generations. This model should be available in the provider
typing.Optional[Parameters]
🔗 ParametersParameters to pass to the model when generating
typing.Optional[typing.Dict[(str, typing.Any)]]
Arbitrary extra parameters to pass to the model when generating
ModelCostMetric
Union, One Of:ModelManifest
str
required
Name of the model (alphanumeric characters, hyphens, and underscores only, max 256 characters)
typing.Dict[(str, typing.Any)]
required
Key value metadata. Should be valid JSON. For e.g.
\{"business-unit": "sales", "quality": "good", "rating": 4.5\}str
required
Name of the ML Repo that this model belongs to (must start and end with alphanumeric, 2-100 characters)
typing.Optional[int]
Version of the entity
typing.Literal[Any]
default:"model-version"
required
typing.Optional[str]
typing.Optional[str]
Version alias is alternate, ideally human readable, version string to reference an artifact version. It should start with
v followed by alphanumeric and it can include . and - in between (e.g. v1.0.0, v1-prod, v3-dev, etc)ModelManifestSource
required
typing.Optional[ModelManifestFramework]
🔗 ModelManifestFrameworkFramework for the model version like Transformers, PyTorch, Sklearn, Xgboost etc with framework specific metadata. This will be used to infer model deployment configuration
typing.Optional[ModelVersionEnvironment]
typing.Optional[int]
Step/Epoch number in an iterative training loop the model version was created. Generally useful when logging a model version from a MLRepo Run
typing.Optional[str]
ID of the MLRepo Run that generated the model version
ModelManifestFramework
Union, One Of:- 🔗 TransformersFramework
- 🔗 TensorFlowFramework
- 🔗 SklearnFramework
- 🔗 PyTorchFramework
- 🔗 KerasFramework
- 🔗 XgBoostFramework
- 🔗 LightGbmFramework
- 🔗 FastAiFramework
- 🔗 H2OFramework
- 🔗 OnnxFramework
- 🔗 SpaCyFramework
- 🔗 StatsModelsFramework
- 🔗 GluonFramework
- 🔗 PaddleFramework
ModelManifestSource
Union, One Of:ModelProviderAccount
Union, One Of:- 🔗 AwsBedrockProviderAccount
- 🔗 GoogleVertexProviderAccount
- 🔗 GoogleGeminiProviderAccount
- 🔗 AzureOpenAiProviderAccount
- 🔗 AzureFoundryProviderAccount
- 🔗 CohereProviderAccount
- 🔗 Ai21ProviderAccount
- 🔗 AnthropicProviderAccount
- 🔗 DeepinfraProviderAccount
- 🔗 GroqProviderAccount
- 🔗 MistralAiProviderAccount
- 🔗 PerplexityAiProviderAccount
- 🔗 TogetherAiProviderAccount
- 🔗 NomicProviderAccount
- 🔗 PalmProviderAccount
- 🔗 OllamaProviderAccount
- 🔗 OpenaiProviderAccount
- 🔗 DatabricksProviderAccount
- 🔗 ClouderaProviderAccount
- 🔗 SelfHostedModelProviderAccount
- 🔗 OpenRouterProviderAccount
- 🔗 SambaNovaProviderAccount
- 🔗 XaiProviderAccount
- 🔗 BasetenProviderAccount
- 🔗 AwsSagemakerProviderAccount
- 🔗 CerebrasProviderAccount
- 🔗 SnowflakeCortexProviderAccount
- 🔗 ElevenLabsProviderAccount
- 🔗 DeepgramProviderAccount
- 🔗 CartesiaProviderAccount
- 🔗 VirtualModelProviderAccount
- 🔗 CustomEndpointProviderAccount
ModelVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
ModelManifest
required
🔗 ModelManifestManifest containing metadata specific to the model version
str
required
ID of the ML Repo that this artifact version belongs to
typing.Optional[typing.List[str]]
List of tags associated with this artifact version for filtering and organization
typing.Optional[str]
Optional human-readable version alias (e.g. v1.0.0)
typing.Optional[str]
Code snippet demonstrating how to use this artifact version
str
required
ID of the parent model that this version belongs to
typing.Optional[bool]
Whether this model version is ready for deployment
ModelVersionEnvironment
typing.Optional[str]
Python version to use when running the model
typing.Optional[typing.List[str]]
pip dependencies needed for running the model
MultiPartUpload
MultiPartUploadStorageProvider
required
🔗 MultiPartUploadStorageProviderStorage provider being used for the multipart upload (e.g., ‘S3_COMPATIBLE’ or ‘AZURE_BLOB’)
typing.List[SignedUrl]
required
🔗 SignedUrlList of signed URLs for each part of the multipart upload
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[typing.List[str]]
List of block IDs for Azure Blob Storage multipart upload
SignedUrl
required
🔗 SignedUrlSigned URL to call after all parts are uploaded to finalize the multipart upload
MultiPartUploadResponse
MultiPartUpload
required
🔗 MultiPartUploadMultipart upload information including signed URLs for each part
NatsInputConfig
typing.Literal[Any]
default:"nats"
required
str
required
Input NATS URL
str
required
Name of the NATS stream
str
required
Root subject of input NATS
str
required
Consumer name of input NATS
int
default:"19"
required
Wait timeout for long polling.
typing.Optional[str]
URL for the NATS metrics endpoint. It is compulsory if you want to use NATS autoscaling.
typing.Optional[NatsUserPasswordAuth]
NatsMetricConfig
typing.Literal[Any]
default:"nats"
required
int
required
Upper limit of the number of backlog messages the auto-scaler will try to maintain per replica. If you set this number to 10 and have 30 messages in the stream and one replica, the auto-scaler will scale the number of replicas to 3.
NatsOutputConfig
typing.Literal[Any]
default:"nats"
required
str
required
Output NATS URL
str
required
Root subject of output NATS
typing.Optional[NatsUserPasswordAuth]
NatsUserPasswordAuth
str
default:"$G"
required
Name of the NATS account
str
required
User for NATS authentication
str
required
Password for NATS authentication
Nodepool
str
required
typing.Optional[str]
NodepoolSelector
typing.Literal[Any]
default:"nodepool_selector"
required
typing.Optional[typing.List[str]]
Nodepools where you want to run your workload. Multiple nodepools can be selected. The workload is guaranteed to be scheduled on one of the nodepool
NodeSelector
typing.Literal[Any]
default:"node_selector"
required
typing.Optional[typing.List[str]]
Instance family of the underlying machine to use. Multiple instance families can be supplied. The workload is guaranteed to be scheduled on one of them.
typing.Optional[NodeSelectorCapacityType]
🔗 NodeSelectorCapacityTypeConfigure what type of nodes to run the app. By default no placement logic is applied. “spot_fallback_on_demand” will try to place the application on spot nodes but will fallback to on-demand when spot nodes are not available. “spot” will strictly place the application on spot nodes. “on_demand” will strictly place the application on on-demand nodes.
NomicKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Nomic authentication
NomicModel
typing.Literal[Any]
default:"integration/model/nomic"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The name of the Nomic model to use
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Nomic model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
NomicProviderAccount
typing.Literal[Any]
default:"provider-account/nomic"
required
str
required
The name of the Nomic provider account
NomicKeyAuth
required
typing.List[NomicIntegrations]
required
List of integrations that are associated with the Nomic provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
Notebook
typing.Literal[Any]
default:"notebook"
required
WorkbenchImage
required
typing.Optional[int]
default:"30"
Stop the notebook instance after this much time in minutes of inactivity. The notebook instance will be stopped even if the notebook is open in your browser, but nothing is running on the notebook.
NotebookConfig
str
required
The base domain for the cluster with which you can access your Notebooks
NotificationTarget
Union, One Of:NotificationTargetForAlertRule
Union, One Of:NvidiaGpu
typing.Literal[Any]
default:"nvidia_gpu"
required
typing.Optional[str]
Name of the Nvidia GPU. One of [P4, P100, V100, T4, A10G, A100_40GB, A100_80GB] This field is required for Node Selector and can be ignored in Nodepool Selector. One instance of the card contains the following amount of memory - P4: 8 GB, P100: 16 GB, V100: 16 GB, T4: 16 GB, A10G: 24 GB, A100_40GB: 40GB, A100_80GB: 80 GB
int
required
Count of GPUs to provide to the application Note the exact count and max count available for a given GPU type depends on cloud provider and cluster type.
NvidiaMiggpu
typing.Literal[Any]
default:"nvidia_mig_gpu"
required
typing.Optional[str]
Name of the Nvidia GPU. One of [P4, P100, V100, T4, A10G, A100_40GB, A100_80GB] This field is required for Node Selector and can be ignored in Nodepool Selector. One instance of the card contains the following amount of memory - P4: 8 GB, P100: 16 GB, V100: 16 GB, T4: 16 GB, A10G: 24 GB, A100_40GB: 40GB, A100_80GB: 80 GB
NvidiaMiggpuProfile
required
🔗 NvidiaMiggpuProfileName of the MIG profile to use. One of the following based on gpu type Please refer to https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#supported-mig-profiles for more details A30 - [1g.6gb, 2g.12gb, 4g.24gb] A100 40 GB - [1g.5gb, 1g.10gb, 2g.10gb, 3g.20gb, 4g.20gb, 7g.40gb] A100 80 GB / H100 80 GB - [1g.10gb, 1g.20gb, 2g.20gb, 3g.40gb, 4g.40gb, 7g.80gb] H100 94 GB - [1g.12gb, 1g.24gb, 2g.24gb, 3g.47gb, 4g.47gb, 7g.94gb] H100 96 GB - [1g.12gb, 1g.24gb, 2g.24gb, 3g.48gb, 4g.48gb, 7g.96gb] H200 141 GB - [1g.18gb, 1g.35gb, 2g.35gb, 3g.71gb, 4g.71gb] B200 180 GB - [1g.23gb, 1g.45gb, 2g.45gb, 3g.90gb, 4g.90gb, 7g.180gb]
NvidiaTimeslicingGpu
typing.Literal[Any]
default:"nvidia_timeslicing_gpu"
required
typing.Optional[str]
Name of the Nvidia GPU. One of [P4, P100, V100, T4, A10G, A100_40GB, A100_80GB] This field is required for Node Selector and can be ignored in Nodepool Selector. One instance of the card contains the following amount of memory - P4: 8 GB, P100: 16 GB, V100: 16 GB, T4: 16 GB, A10G: 24 GB, A100_40GB: 40GB, A100_80GB: 80 GB
int
required
Amount of GPU memory (in MB) to allocate. Please note, this limit is not being enforced today but will be in future. Applications are expected to operate in co-opertative mode
OAuth2LoginProvider
typing.Literal[Any]
default:"oauth2"
required
OciRepo
typing.Literal[Any]
default:"oci-repo"
required
str
required
OCI chart URL - Need to be a valid URL.
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
str
required
Helm chart version
OllamaKeyAuth
str
required
The custom host URL for Ollama API
OllamaModel
typing.Literal[Any]
default:"integration/model/ollama"
required
str
required
Name to identify this Ollama model in the UI
str
required
The name of the Ollama model to use
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Ollama model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
OllamaProviderAccount
typing.Literal[Any]
default:"provider-account/ollama"
required
str
required
The name of the Ollama provider account
OllamaKeyAuth
required
typing.List[OllamaIntegrations]
required
List of integrations that are associated with the Ollama provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
OnnxFramework
typing.Literal[Any]
default:"onnx"
required
OpaAuth
Union, One Of:OpaBearerAuth
typing.Literal[Any]
default:"bearer-auth"
required
str
required
The bearer token for OPA server authentication.
OpaGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/opa"
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. OPA guardrails can only be used for validation.
EnforcingStrategy
required
OpaGuardrailConfigConfig
required
OpaGuardrailConfigConfig
str
required
The base URL of the OPA server (e.g., https://opa.example.com:8181). The policy will be queried at {opa_url}/v1/data/{policy_path}.
str
required
The policy path to evaluate in OPA (e.g., “authz/allow”, “guardrails/validate”). This corresponds to the package and rule name in your Rego policy. The full query URL will be {opa_url}/v1/data/{policy_path}.
OpaHeaderAuth
typing.Literal[Any]
default:"header"
required
typing.Dict[(str, str)]
required
Custom headers to include in requests to OPA server (e.g., {“Authorization”: “Bearer <token>”, “X-API-Key”: “<key>”})
OpenaiApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
Your OpenAI API key for authentication
OpenAiModel
typing.Literal[Any]
default:"integration/model/openai"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The OpenAI model identifier (e.g., gpt-4o, gpt-4-turbo, gpt-3.5-turbo, o1-mini). This is the standard model name from OpenAI’s API documentation.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the OpenAI model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
OpenAiModerationsGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/openai-moderations"
required
OpenaiApiKeyAuth
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. OpenAI Moderation guardrails can only be used for validation.
EnforcingStrategy
required
OpenAiModerationsGuardrailConfigConfig
required
OpenAiModerationsGuardrailConfigConfig
str
default:"omni-moderation-latest"
required
The model to use for the OpenAI Moderation API.
typing.Optional[str]
Optional custom base URL for OpenAI API. If not provided, the default base URL will be used.
typing.Optional[typing.Dict[(str, float)]]
OpenaiProviderAccount
typing.Literal[Any]
default:"provider-account/openai"
required
str
required
The name of the OpenAI provider account
OpenaiApiKeyAuth
required
typing.Optional[str]
Optional custom base URL for OpenAI API
typing.List[OpenAiIntegrations]
required
List of integrations that are associated with the OpenAI provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
OpenApimcpServerManifest
typing.Literal[Any]
default:"mcp-server/openapi"
required
str
required
The name of the OpenAPI MCP Server.
str
required
Provide a brief description of the purpose of this OpenAPI MCP Server.
str
required
The base URL where API requests will be sent. This should be the root endpoint of your API server, without any path suffix.
OpenApiSpecSource
required
typing.Optional[CustomTlsSettings]
typing.Optional[bool]
When enabled, all tools from the OpenAPI spec will be available (up to 30 tools). Disable to select specific tools.
typing.Optional[typing.List[OpenApimcpToolSetting]]
🔗 OpenApimcpToolSettingThe tools to customize from the OpenAPI Server.
typing.Optional[McpServerAuth]
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to this OpenAPI Server
typing.Optional[typing.Dict[(str, typing.Any)]]
Key-value pairs to categorize this OpenAPI MCP Server (e.g., by owner or environment).
OpenApimcpToolSetting
OpenApimcpToolSettingMethod
required
🔗 OpenApimcpToolSettingMethodThe HTTP method for this endpoint.
str
required
The API endpoint path (e.g., /users/{id}).
str
required
The unique name of this tool, derived from OpenAPI operationId.
str
required
Describe what this tool does. This helps AI models understand when to use it.
OpenApiSpecSource
Union, One Of:OpenRouterApiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for OpenRouter authentication
OpenRouterModel
typing.Literal[Any]
default:"integration/model/openrouter"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The OpenRouter model identifier (e.g., anthropic/claude-3-haiku, openai/gpt-4o-mini). This is the model name from OpenRouter’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the OpenRouter model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
OpenRouterProviderAccount
typing.Literal[Any]
default:"provider-account/openrouter"
required
str
required
The name of the OpenRouter provider account
OpenRouterApiKeyAuth
required
typing.List[OpenRouterIntegrations]
required
List of integrations that are associated with the OpenRouter provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
OtelExporterGrpcConfigBase
str
required
Endpoint URL where OpenTelemetry data will be sent
typing.Optional[typing.Dict[(str, str)]]
gRPC metadata to include in OpenTelemetry export requests
OtelExporterHttpConfigBase
str
required
Endpoint URL where OpenTelemetry data will be sent
OtelExporterHttpConfigBaseEncoding
required
🔗 OtelExporterHttpConfigBaseEncodingEncoding for OpenTelemetry data
typing.Optional[typing.Dict[(str, str)]]
HTTP headers to include in OpenTelemetry export requests
OtelMetricsExporterGrpcConfig
typing.Literal[Any]
default:"grpc"
required
Configuration type
OtelMetricsExporterHttpConfig
typing.Literal[Any]
default:"http"
required
Configuration type
OtelTracesExporterCommonConfig
typing.Optional[typing.Dict[(str, str)]]
Set additional attributes to append them to existing resource attributes of every exported trace
typing.Optional[bool]
Enable to prevent forwarding the LLM or MCP request and response body in exported traces. The following span attributes are dropped: tfy.input, tfy.output, tfy.input_short_hand
typing.Optional[typing.List[OtelTracesExporterSpanAttributeFilter]]
🔗 OtelTracesExporterSpanAttributeFilterExport spans only when they match all of the following filters. Only matching on spanAttributes with string values in supported.
OtelTracesExporterGrpcConfig
typing.Literal[Any]
default:"grpc"
required
Configuration type
OtelTracesExporterHttpConfig
typing.Literal[Any]
default:"http"
required
Configuration type
OtelTracesExporterSpanAttributeFilter
typing.Literal[Any]
default:"spanAttributes"
required
Type of attribute field to filter on
str
required
Key name of the span attribute to filter on
typing.Literal[Any]
default:"IN"
required
Comparison operator to use for filtering
typing.List[str]
required
Values
OwnDataAccessRule
typing.Literal[Any]
default:"own_data"
required
Data access scope - access to own data only
OwnedBy
str
required
The name of the account that owns this resource
PaddleFramework
typing.Literal[Any]
default:"paddle"
required
PagerDuty
typing.Literal[Any]
default:"pagerduty"
required
str
required
Specify the notification channel to send alerts to
PagerDutyIntegration
typing.Literal[Any]
default:"integration/notification-channel/pagerduty"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
PagerDutyIntegrationKeyAuth
required
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
PagerDutyIntegrationKeyAuth
typing.Literal[Any]
default:"pagerduty-integration-auth"
required
str
required
The integration key for the PagerDuty integration
str
required
The integration URL for the PagerDuty integration
PagerDutyProviderAccount
typing.Literal[Any]
default:"provider-account/pagerduty"
required
str
required
The name of the PagerDuty provider account
typing.List[PagerDutyIntegrations]
required
🔗 PagerDutyIntegrationList of integrations that are associated with the PagerDuty provider account
Pagination
int
required
Total number of items
typing.Optional[int]
Number of items skipped
typing.Optional[int]
Number of items per page
PalmKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
Your PaLM API key for authentication
PalmModel
typing.Literal[Any]
default:"integration/model/palm"
required
str
required
Name to identify this PaLM model in the UI
str
required
The name of the PaLM model to use
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the PaLM model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
PalmProviderAccount
typing.Literal[Any]
default:"provider-account/palm"
required
str
required
The name of the PaLM provider account
PalmKeyAuth
required
typing.List[PalmIntegrations]
required
List of integrations that are associated with the PaLM provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
PaloAltoPrismaAirsGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
required
PaloAltoPrismaAirsKeyAuth
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Palo Alto Prisma AIRS guardrails can only be used for validation.
EnforcingStrategy
required
PaloAltoPrismaAirsGuardrailConfigConfig
required
PaloAltoPrismaAirsGuardrailConfigConfig
typing.Optional[str]
Optional override for the base URL for Palo Alto Prisma AIRS. Defaults to https://service.api.aisecurity.paloaltonetworks.com/v1/ if not provided.
str
required
The profile name associated with this Guardrail Config.
typing.Optional[PaloAltoPrismaAirsGuardrailConfigConfigMode]
🔗 PaloAltoPrismaAirsGuardrailConfigConfigModeExecution mode for the guardrail. Sync waits for the guardrail check to complete before proceeding. Async triggers the check without waiting. Defaults to sync.
typing.Optional[typing.Dict[(str, str)]]
Map Palo Alto AIRS metadata fields to TrueFoundry request metadata keys. Key is the Palo Alto AIRS metadata field name, value is the corresponding key from X-TFY-METADATA header on the TrueFoundry side. Example: {“app_user”: “user_email”, “ai_model”: “model_name”}. Reserved AIRS keys: ai_model, app_user, app_name. Docs
PaloAltoPrismaAirsKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
API key for the Palo Alto Prisma AIRS account
PangeaGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/pangea"
required
PangeaKeyAuth
required
PangeaGuardrailConfigOperation
required
🔗 PangeaGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
PangeaGuardrailConfigConfig
required
PangeaGuardrailConfigConfig
PangeaGuardType
required
str
required
Domain of the cloud provider and region where your Pangea project is configured. Example: if endpoint is: https://<service_name>.aws.us-west-2.pangea.cloud/v1/text/guard, the input should be: aws.us-west-2.pangea.cloud
typing.Optional[str]
Recipe key from Pangea console defining security rules and data types to apply
typing.Optional[typing.Dict[(str, str)]]
Overrides for the Pangea account
PangeaKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
API key for the Pangea account
Param
str
required
Name of the param
typing.Optional[str]
Description of param
typing.Optional[str]
Default value or placeholder
typing.Optional[ParamParamType]
Parameters
typing.Optional[int]
typing.Optional[float]
typing.Optional[float]
typing.Optional[float]
typing.Optional[ParametersStop]
ParametersStop
Union, One Of:PatronusAnswerRelevanceEvaluator
typing.Literal[Any]
default:"answer-relevance"
required
The type of the evaluator to use for the Patronus Guardrail.
PatronusAnswerRelevanceCriteria
default:"patronus:answer-relevance"
required
PatronusEvaluator
Union, One Of:- 🔗 PatronusAnswerRelevanceEvaluator
- 🔗 PatronusGliderEvaluator
- 🔗 PatronusJudgeEvaluator
- 🔗 PatronusPiiEvaluator
- 🔗 PatronusPhiEvaluator
- 🔗 PatronusToxicityEvaluator
PatronusGliderEvaluator
typing.Literal[Any]
default:"glider"
required
The type of the evaluator to use for the Patronus Guardrail.
PatronusGliderCriteria
required
PatronusGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/patronus"
required
PatronusKeyAuth
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. Patronus guardrails can only be used for validation.
EnforcingStrategy
required
PatronusGuardrailConfigConfig
required
PatronusGuardrailConfigConfig
PatronusGuardrailConfigConfigTarget
required
🔗 PatronusGuardrailConfigConfigTargetWhere to apply evaluation: request (evaluate user input) or response (evaluate model response)
typing.List[PatronusEvaluator]
required
🔗 PatronusEvaluatorPatronus evaluators guard against GenAI failures by checking for evaluation criteria, refer to docs
PatronusJudgeEvaluator
typing.Literal[Any]
default:"judge"
required
The type of the evaluator to use for the Patronus Guardrail.
PatronusJudgeCriteria
required
PatronusKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
API key for the Patronus account
PatronusPhiEvaluator
typing.Literal[Any]
default:"phi"
required
The type of the evaluator to use for the Patronus Guardrail.
PatronusPhiCriteria
default:"patronus:phi"
required
PatronusPiiEvaluator
typing.Literal[Any]
default:"pii"
required
The type of the evaluator to use for the Patronus Guardrail.
PatronusPiiCriteria
default:"patronus:pii"
required
PatronusToxicityEvaluator
typing.Literal[Any]
default:"toxicity"
required
The type of the evaluator to use for the Patronus Guardrail.
PatronusToxicityCriteria
default:"patronus:toxicity"
required
Permissions
str
required
The fully qualified name of the resource
str
required
The type of the resource (cluster, workspace, etc.)
str
required
The role id of the role to be assigned to the service account for that resource
PerplexityAiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Perplexity AI authentication
PerplexityAiModel
typing.Literal[Any]
default:"integration/model/perplexity-ai"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Perplexity AI model identifier (e.g., sonar-reasoning, sonar). This is the model name from Perplexity AI’s API documentation.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Perplexity AI model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
PerplexityAiProviderAccount
typing.Literal[Any]
default:"provider-account/perplexity-ai"
required
str
required
The name of the Perplexity AI provider account
PerplexityAiKeyAuth
required
typing.List[PerplexityIntegrations]
required
List of integrations that are associated with the Perplexity AI provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
PersonalAccessTokenManifest
str
required
Personal Access Token Name
typing.Literal[Any]
default:"pat"
required
typing.Optional[str]
Expiration Date of the Personal Access Token (should be in the ISO 8601 format)
str
required
The fully qualified name of the user
PerThousandEmbeddingTokensCostMetric
str
required
NonNegativeFloat
required
PerThousandTokensCostMetric
str
required
InputOutputBasedCostMetricValue
required
Pip
typing.Literal[Any]
default:"pip"
required
typing.Optional[str]
Path to
requirements.txt relative to Path to build contexttyping.Optional[typing.List[str]]
Define pip package requirements. In Python/YAML E.g. [“fastapi>=0.90,<1.0”, “uvicorn”]
Poetry
typing.Literal[Any]
default:"poetry"
required
typing.Optional[str]
default:"latest"
Poetry version to use
typing.Optional[str]
install options to pass to poetry command
PolicyFilters
typing.Optional[typing.List[str]]
Cluster names where Policy applies
typing.Optional[typing.List[str]]
Workspace names where Policy applies
typing.Optional[typing.List[str]]
Environment names where Policy applies
PolicyManifest
typing.Literal[Any]
default:"policy"
required
str
required
Unique identifier of the policy across the organisation
str
required
Description of the policy that explains what the policy does, its purpose, and how it affects resources. This helps other users understand the policy’s behavior and impact.
PolicyManifestOperation
required
🔗 PolicyManifestOperationDefines if the policy validates or mutates resources. Validation policies check TrueFoundry manifests to ensure they meet conditions and can block deployments. Mutation policies modify Kubernetes manifests before they’re applied to the cluster. See this documentation for more details.
PolicyManifestMode
required
🔗 PolicyManifestModeMode of the policy:
Audit logs all policy evaluations without blocking deployments. Enforce blocks deployments if the policy fails. Disabled deactivates the policy.typing.List[PolicyEntityTypes]
required
🔗 PolicyEntityTypesTypes of applications this policy applies to
typing.List[PolicyActions]
required
Actions this policy applies to
typing.Optional[PolicyFilters]
str
required
TypeScript code for Policy logic. To write and test your policy code, please refer to this repository
PolicyManifestOperation
Union, One Of:PolicyMutationOperation
typing.Literal[Any]
default:"mutate"
required
Mutates or Validates Resources
int
required
Determines the sequence in which mutation policies are executed. Policies with lower order value run first, followed by higher value. For example, a policy with order 10 runs before one with order 20. This is crucial when multiple mutation policies need to run in a specific sequence. The order must be between 1 and 100.
PolicyValidationOperation
typing.Literal[Any]
default:"validate"
required
Mutates or Validates Resources
Port
int
default:"80"
required
Port number to expose.
PortProtocol
required
🔗 PortProtocolProtocol for the port.
bool
required
Expose the port
typing.Optional[PortAppProtocol]
🔗 PortAppProtocolApplication Protocol for the port. Select the application protocol used by your service. For most use cases, this should be
http(HTTP/1.1). If you are running a gRPC server, select the grpc option. This is only applicable if expose=true.typing.Optional[str]
Host e.g. ai.example.com, app.truefoundry.com
typing.Optional[str]
Path e.g. /v1/api/ml/, /v2/docs/
typing.Optional[str]
Rewrite the path prefix to a different path. If
path is /v1/api and rewrite_path_to is /api. The URI in the HTTP request http://0.0.0.0:8080/v1/api/houses will be rewritten to http://0.0.0.0:8080/api/houses before the request is forwarded your service. Defaults to /. This is only applicable if path is given.typing.Optional[PortAuth]
🔗 PortAuthAuthentication method for inbound traffic
PortAuth
Union, One Of:PresetRegexPattern
typing.List[PresetRegexPatternEnum]
required
🔗 PresetRegexPatternEnumSelect one or more common regex patterns from the predefined list.
PresignedUrlObject
str
required
str
required
typing.Optional[typing.Dict[(str, typing.Any)]]
PriorityBasedLoadBalanceTarget
str
required
Target model or provider FQN
int
required
Priority for the target, Lower the number, higher the priority (0 is the highest priority)
typing.Optional[SlaCutoff]
typing.Optional[RetryConfig]
typing.Optional[typing.List[str]]
Status Codes for which the request will fallback to other targets. If the status code is not present in fallback_status_codes, it fails immediately.
typing.Optional[bool]
Whether this target is a fallback candidate. If set to false, this model will not be considered as a fallback option for targets of this load-balance-rule
typing.Optional[typing.Dict[(str, typing.Any)]]
Optional parameters to override in the request
typing.Optional[HeadersOverride]
typing.Optional[typing.Dict[(str, str)]]
Optional metadata key-value pairs that must match incoming request metadata headers for this target to be considered for routing.
PriorityBasedLoadBalancing
typing.Literal[Any]
default:"priority-based-routing"
required
typing.List[PriorityBasedLoadBalanceTarget]
required
🔗 PriorityBasedLoadBalanceTargetList of targets for priority-based load balancing
PriorityBasedLoadBalancingRule
str
required
Unique identifier for the rule
LoadBalancingWhen
required
PrivatePricingTier
typing_extensions.Annotated[(int, Any, Any)]
required
NonNegativeFloat
required
PrometheusAlertRule
typing.Literal[Any]
default:"prometheus-alert-rule"
required
Type
str
required
Enter a unique, descriptive name for your Prometheus alert rule. Choose a name that clearly indicates the condition being monitored. Please note that reserved alert names for TrueFoundry managed alerts are not allowed. For checking the list of reserved alert names, please refer to the documentation.
str
required
Enter a valid PromQL expression that defines the condition for triggering this alert. The alert will fire when this expression evaluates to true for the duration specified in the duration to trigger alert field.
typing_extensions.Annotated[(float, Any, Any)]
required
AlertSeverity
required
typing.Optional[str]
Description of the alert rule which will be displayed in the alert rule list. This can be used to provide more context about the alert rule.
bool
required
When enabled, notifications will be sent to all configured target channels when the alert conditions are met.
Prompt
str
required
Unique identifier for the artifact
str
required
ID of the ML Repo that this artifact belongs to
typing.Optional[typing.Literal[Any]]
Type of the artifact, always ‘chat_prompt’ for Prompt entities
str
required
Name of the artifact (alphanumeric characters, hyphens, and underscores only, max 256 characters)
str
required
Fully qualified name of the artifact in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}’
typing.Optional[dt.datetime]
Timestamp when the artifact was created
typing.Optional[dt.datetime]
Timestamp when the artifact was last updated
typing.Optional[PromptVersion]
🔗 PromptVersionThe most recent version of this prompt
typing.Optional[typing.List[int]]
List of run step numbers where this artifact was created or updated
PromptSource
typing.Literal[Any]
default:"prompt"
required
Type of agent source
str
required
Fully qualified name of the prompt version to use as the agent source
typing.Optional[typing.List[AgentSkill]]
🔗 AgentSkillList of skills associated with the agent
PromptVersion
str
required
Unique identifier for the artifact version
str
required
Fully qualified name of the artifact version in the format ‘{artifact_type}:{tenant_name}/{ml_repo_name}/{artifact_name}:{version}’
Subject
required
🔗 SubjectSubject (user, team, or service account) that created this artifact version
typing.Optional[dt.datetime]
Timestamp when the artifact version was created
typing.Optional[dt.datetime]
Timestamp when the artifact version was last updated
ChatPromptManifest
required
🔗 ChatPromptManifestManifest containing metadata specific to the chat prompt version
str
required
ID of the ML Repo that this artifact version belongs to
typing.Optional[typing.List[str]]
List of tags associated with this artifact version for filtering and organization
typing.Optional[str]
Optional human-readable version alias (e.g. v1.0.0)
typing.Optional[str]
Code snippet demonstrating how to use this artifact version
typing.Optional[typing.List[UsageCodeSnippet]]
🔗 UsageCodeSnippetList of code snippets demonstrating how to use this prompt version in different languages
str
required
ID of the parent prompt that this version belongs to
ProviderAccounts
Union, One Of:PublicCostMetric
str
required
PySparkTaskConfig
typing.Literal[Any]
default:"pyspark-task-config"
required
TaskPySparkBuild
required
SparkDriverConfig
required
SparkExecutorConfig
required
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Extra configuration properties to be passed to the spark job. Docs
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the task either as plain text or secrets. Docs
typing.Optional[typing.List[VolumeMount]]
🔗 VolumeMountConfigure data to be mounted to Workflow pod(s) as a volume.
typing.Optional[str]
Service Account
PythonBuild
typing.Literal[Any]
default:"tfy-python-buildpack"
required
typing.Optional[str]
Python version to run your application. Should be one of the tags listed on Official Python Docker Page
str
default:"./"
required
Build path relative to project root path.
typing.Optional[str]
Path to
requirements.txt relative to Path to build contexttyping.Optional[typing.List[str]]
Define pip package requirements. In Python/YAML E.g. [“fastapi>=0.90,<1.0”, “uvicorn”]
typing.Optional[PythonBuildPythonDependencies]
🔗 PythonBuildPythonDependenciesPython dependencies to install
typing.Optional[typing.List[str]]
Debian packages to install via
apt get. In Python/YAML E.g. [“git”, “ffmpeg”, “htop”]PythonBuildCommand
required
🔗 PythonBuildCommandCommand to run when the container starts. Command will be set as the Entrypoint of the generated image. When deploying a Job, the command can be templatized by defining
params and referencing them in command E.g. python main.py --learning_rate \{\{learning_rate\}\}typing.Optional[str]
Version of CUDA Toolkit and CUDNN to install in the image These combinations are based off of publically available docker images on docker hub You can also specify a valid tag of the form {cuda_version_number}-cudnn{cudnn_version_number}-{runtime|devel}-ubuntu{ubuntu_version} Refer https://hub.docker.com/r/nvidia/cuda/tags for valid set of values Note: We use deadsnakes ubuntu ppa to add Python that currently supports only Ubuntu 18.04, 20.04 and 22.04
PythonBuildCommand
Union, One Of:PythonBuildPythonDependencies
Union, One Of:PythonTaskConfig
typing.Literal[Any]
default:"python-task-config"
required
PythonTaskConfigImage
required
🔗 PythonTaskConfigImageSpecify the image spec for the task
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Configure environment variables to be injected in the task either as plain text or secrets. Docs
typing.Optional[Resources]
typing.Optional[typing.List[PythonTaskConfigMountsItem]]
🔗 PythonTaskConfigMountsItemConfigure data to be mounted to Workflow pod(s) as a volume.
typing.Optional[str]
Service Account
PythonTaskConfigImage
Union, One Of:PythonTaskConfigMountsItem
Union, One Of:PyTorchFramework
typing.Literal[Any]
default:"pytorch"
required
QuayArtifactsRegistry
typing.Literal[Any]
default:"integration/docker-registry/quay"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the registry.
typing.Optional[QuayBasicAuth]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
QuayBasicAuth
typing.Literal[Any]
default:"basic-auth"
required
str
required
The username for the basic authentication.
str
required
The password for the basic authentication.
QuayProviderAccount
typing.Literal[Any]
default:"provider-account/quay"
required
str
required
The name of the provider account.
typing.Optional[str]
The name of the account on Quay.
typing.Optional[QuayBasicAuth]
typing.List[QuayIntegrations]
required
List of integrations that are associated with the provider account.
QuerySpansRequestFiltersItem
Union, One Of:QuerySpansResponse
typing.List[TraceSpan]
required
🔗 TraceSpanArray of flat spans
TokenPagination
required
🔗 TokenPaginationPagination information
RateLimitConfig
typing.Literal[Any]
default:"gateway-rate-limiting-config"
required
typing.List[RateLimitRule]
required
🔗 RateLimitRuleList of rate limit rules
RateLimitRule
str
required
Unique identifier for the rule
RateLimitWhen
required
int
required
Maximum number of requests or tokens allowed
RateLimitUnit
required
typing.Optional[typing.List[str]]
Create separate rate limiting rules for each unique value of the selected entity. For example, if “user” is selected, a separate rate limit rule will be created for each unique user making requests. Options: user, virtualaccount, model, or a metadata key (e.g., metadata.appId).
RateLimitWhen
typing.Optional[typing.List[str]]
List of subjects that this rule applies to
typing.Optional[typing.List[str]]
List of models that this rule applies to
typing.Optional[typing.Dict[(str, str)]]
Metadata key-value pairs that this rule applies to
Recommendation
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[int], Any, Any)]
typing_extensions.Annotated[(typing.Dict[(str, typing.Any)], Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
RefusalContentPart
str
required
Type of the content part
str
required
Reason
RegexGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/regex"
required
RegexGuardrailConfigOperation
required
🔗 RegexGuardrailConfigOperationValidate blocks when pattern matches. Mutate replaces matched text and continues.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
RegexGuardrailConfigConfig
required
RegexGuardrailConfigConfig
typing.Optional[PresetRegexPattern]
typing.Optional[typing.List[CustomRegexPattern]]
🔗 CustomRegexPatternEnter your own regex patterns to match against content, each with its own redaction text (used in mutate mode).
RegisterUsersResponse
Union, One Of:RemoteMcpServerManifest
typing.Literal[Any]
default:"mcp-server/remote"
required
str
required
The name of the MCP Server.
str
required
Provide a brief description of the purpose of this MCP Server.
str
required
The endpoint URL for the MCP Server.
typing.Optional[CustomTlsSettings]
typing.Optional[typing.List[McpToolSetting]]
🔗 McpToolSettingCustomize tool descriptions or enable/disable specific tools from the MCP Server.
typing.Optional[McpServerAuth]
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to this MCP Server
typing.Optional[typing.Dict[(str, typing.Any)]]
Key-value pairs to categorize this MCP Server (e.g., by owner or environment).
RemoteSource
typing.Literal[Any]
default:"remote"
required
str
required
Remote repository URI
RemoteSpecSource
typing.Literal[Any]
default:"remote"
required
str
required
URL to fetch the OpenAPI specification (JSON or YAML format).
Resources
float
default:"0.2"
required
Requested CPU which determines the minimum cost incurred. The CPU usage can exceed the requested amount, but not the value specified in the limit. 1 CPU means 1 CPU core. Fractional CPU can be requested like
0.5 or 0.05float
default:"0.5"
required
CPU limit beyond which the usage cannot be exceeded. 1 CPU means 1 CPU core. Fractional CPU can be requested like
0.5. CPU limit should be >= cpu request.int
default:"200"
required
Requested memory which determines the minimum cost incurred. The unit of memory is in megabytes(MB). So 1 means 1 MB and 2000 means 2GB.
int
default:"500"
required
Memory limit after which the application will be killed with an OOM error. The unit of memory is in megabytes(MB). So 1 means 1 MB and 2000 means 2GB. MemoryLimit should be greater than memory request.
int
default:"1000"
required
Requested disk storage. The unit of memory is in megabytes(MB). This is ephemeral storage and will be wiped out on pod restarts or eviction
int
default:"2000"
required
Disk storage limit. The unit of memory is in megabytes(MB). Exceeding this limit will result in eviction. It should be greater than the request. This is ephemeral storage and will be wiped out on pod restarts or eviction
Define the shared memory requirements for your workload. Machine learning libraries like Pytorch can use Shared Memory for inter-process communication. If you use this, we will mount a
tmpfs backed volume at the /dev/shm directory. Any usage will also count against the workload’s memory limit (resources.memory_limit) along with your workload’s memory usage. If the overall usage goes above resources.memory_limit the user process may get killed. Shared Memory Size cannot be more than the defined Memory Limit for the workload.typing.Optional[ResourcesNode]
🔗 ResourcesNodeThis field determines how the underlying node resource is to be utilized
typing.Optional[typing.List[ResourcesDevicesItem]]
🔗 ResourcesDevicesItemDefine custom device or accelerator requirements for your workload. We currently support NVIDIA GPUs, AWS Inferentia Accelerators, Single Host TPU Slices.
ResourcesDevicesItem
Union, One Of:ResourcesNode
Union, One Of:ResponseFormatJsonObject
typing.Literal[Any]
default:"json_object"
required
ResponseFormatJsonSchema
typing.Literal[Any]
default:"json_schema"
required
ResponseFormatJsonSchemaJsonSchema
required
ResponseFormatJsonSchemaJsonSchema
str
required
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, typing.Any)]], Any, Any)]
typing.Optional[bool]
ResponseFormatText
typing.Literal[Any]
default:"text"
required
RetryConfig
int
required
Number of attempts to retry the request
typing.Optional[int]
default:"100"
Delay between retries in milliseconds
typing.Optional[typing.List[str]]
Status codes to retry on
RevokeAllPersonalAccessTokenResponse
Union, One Of:RoleBindingManifest
typing.Literal[Any]
default:"role-binding"
required
str
required
Unique name for this role binding.
typing.List[RoleBindingSubject]
required
🔗 RoleBindingSubjectOne row per principal; set type and name (email, team name, virtual account name, or external identity name).
typing.List[RoleBindingPermission]
required
🔗 RoleBindingPermissionResource-scoped role grants (resource type, FQN, and role name).
RoleBindingPermission
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
Name of the role to bind (e.g. workspace-editor, model-user).
RoleBindingSubject
RoleBindingSubjectType
required
🔗 RoleBindingSubjectTypeWhether this row identifies a user (email), a team (name), a virtual account (name), or an external identity (name).
str
required
User email when type is user; team or virtual account name when type is team or virtualaccount; external identity name when type is external-identity.
RoleManifest
typing.Literal[Any]
default:"role"
required
str
required
Unique identifier of the role across the organization
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
Description of the role that explains its purpose and permissions
typing_extensions.Annotated[(str, Any, Any)]
required
typing.List[str]
required
Define the resource type and the corresponding actions this role can perform on the resource
RoleWithResource
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(RoleWithResourceResourceType, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
Rolling
typing.Literal[Any]
default:"rolling_update"
required
Percentage of total replicas that can be brought down at one time. For a value of 25 when replicas are set to 12 this would mean minimum (25% of 12) = 3 pods might be unavailable during the deployment. Setting this to a higher value can help in speeding up the deployment process.
int
default:"25"
required
Percentage of total replicas of updated image that can be brought up over the total replicas count. For a value of 25 when replicas are set to 12 this would mean (12+(25% of 12) = 15) pods might be running at one time. Setting this to a higher value can help in speeding up the deployment process.
RpsMetric
typing.Literal[Any]
default:"rps"
required
float
required
Average request per second averaged over all replicas that autoscaler should try to maintain
RStudio
typing.Literal[Any]
default:"rstudio"
required
WorkbenchImage
required
SagemakerModel
str
required
A descriptive name to identify this model integration in the UI
str
required
The SageMaker endpoint name you created for your model deployment. This is the name of the inference endpoint in AWS SageMaker, not the model name.
typing.Literal[Any]
default:"integration/model/sagemaker"
required
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Sagemaker model
typing.Optional[AwsRegion]
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
SambaNovaKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for SambaNova authentication
SambaNovaModel
typing.Literal[Any]
default:"integration/model/sambanova"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The SambaNova model identifier (e.g., DeepSeek-R1-0528, Meta-Llama-3.3-70B-Instruct). This is the standard Model ID from SambaNova’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the SambaNova model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
SambaNovaProviderAccount
typing.Literal[Any]
default:"provider-account/sambanova"
required
str
required
The name of the SambaNova provider account
SambaNovaKeyAuth
required
typing.List[SambaNovaIntegrations]
required
List of integrations that are associated with the SambaNova provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
SampleAgentInput
typing.Optional[str]
Input for the agent
typing.Optional[typing.Dict[(str, str)]]
Variable inputs for Prompt Variables defined in the Prompt
Schedule
typing.Literal[Any]
default:"scheduled"
required
str
required
Specify the schedule for this job to be run periodically in cron format.
* * * * * | | | | | | | | | |___ day of week (0-6) (Sunday is 0) | | | |_____ month (1-12) | | |_______ day of month (1-31) | |_________ hour (0-23) |___________ minute (0-59)ScheduleConcurrencyPolicy
required
🔗 ScheduleConcurrencyPolicyChoose whether to allow this job to run while another instance of the job is running, or to replace the currently running instance. Allow will enable multiple instances of this job to run. Forbid will keep the current instance of the job running and stop a new instance from being run. Replace will terminate any currently running instance of the job and start a new one.
typing.Optional[str]
Timezone against which the cron schedule will be calculated, e.g. “Asia/Tokyo”. Default is machine’s local time. https://docs.truefoundry.com/docs/list-of-supported-timezones
Secret
str
required
str
required
str
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[Any]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[int], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
SecretDetectionGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/secret-detection"
required
SecretDetectionGuardrailConfigOperation
required
🔗 SecretDetectionGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
typing.Optional[SecretDetectionGuardrailConfigConfig]
SecretDetectionGuardrailConfigConfig
typing.Optional[str]
default:"[REDACTED]"
Text to use when redacting detected secrets in logs and error messages. Defaults to ‘[REDACTED]’.Only applicable in mutate mode.
SecretGroup
typing.Optional[str]
typing.Optional[str]
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.List[Any], Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[typing.Dict[(str, typing.Any)]]
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
SecretGroupManifest
typing.Literal[Any]
default:"secret-group"
required
str
required
Name of the secret group
str
required
Secret Store to be associated with the secret group
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to Secret Group
SecretInput
str
required
Key of the secret.
str
required
Value of the secret.
SecretMount
typing.Literal[Any]
default:"secret"
required
str
required
Absolute file path where the file will be created.
str
required
The TrueFoundry secret whose value will be the file content.
SecretStoreConfig
str
required
The secret store to store the virtual account token in
str
required
The path where the virtual account token will be stored in the secret store (example: secret/path/to/virtual-account-token)
SecretVersion
str
required
str
required
typing.Optional[str]
typing.Optional[float]
typing.Optional[Any]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
typing_extensions.Annotated[(typing.Optional[dt.datetime], Any, Any)]
SelfHostedAgent
typing.Literal[Any]
default:"remote-agent/self-hosted"
required
Type of the manifest
str
required
The URL of the server
typing.Optional[CustomAgentServerAuth]
AgentFramework
required
SelfHostedModel
typing.Literal[Any]
default:"integration/model/self-hosted-model"
required
str
required
A descriptive name to identify this self-hosted model in the UI
str
required
The name of the hosted model
str
required
The URL where the model is hosted
SelfHostedModelModelServer
required
🔗 SelfHostedModelModelServerThe type of model server being used
typing.Optional[str]
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the model
typing.Optional[CustomTlsSettings]
typing.Optional[SelfHostedModelAuthData]
🔗 SelfHostedModelAuthDataSelf Hosted Model authentication data for the integration.
typing.Optional[typing.Dict[(str, str)]]
Self Hosted Model headers for the integration. Forwarded to the provider as is. For example:
\{"Authorization": "APIKey \<token\>"\}typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
SelfHostedModelAuthData
Union, One Of:SelfHostedModelProviderAccount
typing.Literal[Any]
default:"provider-account/self-hosted-model"
required
str
required
The name of the provider account.
typing.List[SelfHostedModelIntegrations]
required
🔗 SelfHostedModelList of integrations that are associated with the provider account.
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorCollaborators
SemanticCacheConfig
typing.Literal[Any]
default:"semantic"
required
float
required
Similarity threshold for semantic matching (between 0 and 1)
typing.Optional[str]
Cache namespace (defaults to ‘default’ if not provided)
float
default:"3600.0"
required
Time-to-live for cached entries in seconds (max 3 days)
SemanticCacheSettings
str
required
Select the embedding model to use for semantic caching across the gateway. This model will be used to generate embeddings for cache lookups when semantic caching is enabled. The embedding model helps identify semantically similar requests to serve cached responses, improving performance for similar queries.
Service
typing.Literal[Any]
default:"service"
required
ServiceReplicas
required
🔗 ServiceReplicasDeploy multiple instances of your pods to distribute incoming traffic across them, ensuring effective load balancing.
typing.Optional[Autoshutdown]
typing.Optional[bool]
Whether to allow intercepts to be applied for this service. This would inject an additional sidecar in each pod of the service. Not recommended on production
typing.Optional[ServiceRolloutStrategy]
🔗 ServiceRolloutStrategyStrategy to dictate how a rollout should happen when a new release for this service is made Docs
ServiceAutoscaling
ServiceAutoscalingMetrics
required
🔗 ServiceAutoscalingMetricsMetrics to use for the autoscaler
ServiceAutoscalingMetrics
Union, One Of:ServiceReplicas
Union, One Of:ServiceRolloutStrategy
Union, One Of:Session
str
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
typing_extensions.Annotated[(SubjectType, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.List[str]
required
typing.List[SessionTeam]
required
typing.List[SessionAccount]
required
typing.Optional[UserMetadata]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, typing.Any)]], Any, Any)]
typing_extensions.Annotated[(str, Any, Any)]
required
SessionAccount
str
required
str
required
SessionTeam
str
required
str
required
SignedUrl
str
required
Relative path of the file within the artifact storage
str
required
Pre-signed URL that can be used to access the file directly
SklearnFramework
typing.Literal[Any]
default:"sklearn"
required
typing.Optional[str]
Relative path to the model file in the model version contents
typing.Optional[SklearnSerializationFormat]
typing.Optional[SklearnModelSchema]
SklearnModelSchema
InferMethodName
required
🔗 InferMethodNameName of the method used for inference
typing.List[typing.Dict[(str, typing.Any)]]
required
Schema of the input
typing.List[typing.Dict[(str, typing.Any)]]
required
Schema of the output
SlackBot
typing.Literal[Any]
default:"slack-bot"
required
str
required
Specify the notification channel to send alerts to
typing.List[str]
required
List of channels to send messages to.
SlackBotAuth
typing.Literal[Any]
default:"slack-bot"
required
str
required
The bot token for the slack bot to send messages to the channels. This bot should have the following permissions: chat:write, chat:write.public
SlackBotIntegration
typing.Literal[Any]
default:"integration/notification-channel/slack-bot"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
SlackBotAuth
required
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
SlackIntegrations
Union, One Of:SlackProviderAccount
typing.Literal[Any]
default:"provider-account/slack"
required
str
required
The name of the provider account.
typing.List[SlackIntegrations]
required
🔗 SlackIntegrationsList of integrations that are associated with the provider account.
SlackWebhook
typing.Literal[Any]
default:"slack-webhook"
required
str
required
Specify the notification channel to send alerts to
SlackWebhookAuth
typing.Literal[Any]
default:"slack-webhook"
required
str
required
The URL of the slack webhook
SlackWebhookIntegration
typing.Literal[Any]
default:"integration/notification-channel/slack-webhook"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
SlackWebhookAuth
required
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
SlaCutoff
typing.Optional[int]
Time per output token threshold in milliseconds. If time per output token exceeds this value, the target will be marked as unhealthy
SmtpCredentials
typing.Literal[Any]
default:"smtp-credentials"
required
str
required
The SMTP host of the email server.
typing.Optional[str]
The username for the SMTP server.
typing.Optional[str]
The password for the SMTP server.
int
default:"587"
required
The port of the SMTP server.
bool
required
Whether to use TLS for the SMTP server.
SnowflakeCortexModel
typing.Literal[Any]
default:"integration/model/snowflake-cortex"
required
str
required
Name to identify this Snowflake Cortex model in the UI
str
required
ID of the Snowflake Cortex model to use
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Snowflake Cortex model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
SnowflakeCortexPatTokenAuth
typing.Literal[Any]
default:"pat-token"
required
str
required
PAT token for Snowflake Cortex authentication
SnowflakeCortexProviderAccount
typing.Literal[Any]
default:"provider-account/snowflake-cortex"
required
str
required
The name of the Snowflake Cortex provider account
SnowflakeCortexPatTokenAuth
required
str
required
Snowflake account identifier. You can find it in the URL of your Snowflake account. Example: https://<account_identifier>.snowflakecomputing.com. Insert the account identifier only, without the URL.
typing.List[SnowflakeCortexIntegrations]
required
List of integrations that are associated with the Snowflake Cortex provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
SpaCyFramework
typing.Literal[Any]
default:"spacy"
required
SpanAttributeFilter
typing_extensions.Annotated[(str, Any, Any)]
required
SpanAttributeFilterOperator
required
SpanAttributeFilterValue
required
SpanAttributeFilterValue
Union, One Of:SpanFieldFilter
typing_extensions.Annotated[(SpanFieldFilterSpanFieldName, Any, Any)]
required
SpanFieldFilterOperator
required
SpanFieldFilterValue
required
SpanFieldFilterValue
Union, One Of:SparkBuild
typing.Literal[Any]
default:"tfy-spark-buildpack"
required
str
default:"3.5.2"
required
Spark version should match the spark version installed in the image.
str
default:"./"
required
Build path relative to project root path.
typing.Optional[str]
Path to
requirements.txt relative to Path to build contextSparkConfig
str
required
The base domain for the cluster with which you can access your Spark UI
SparkDriverConfig
typing.Optional[Resources]
SparkExecutorConfig
SparkExecutorConfigInstances
required
🔗 SparkExecutorConfigInstancesExecutor Instances
typing.Optional[Resources]
SparkExecutorConfigInstances
Union, One Of:SparkExecutorDynamicScaling
typing.Literal[Any]
default:"dynamic"
required
int
default:"1"
required
Minimum number of instances to start / scale down to
int
default:"1"
required
Maximum number of instances to scale up to
SparkExecutorFixedInstances
typing.Literal[Any]
default:"fixed"
required
int
default:"1"
required
Number of instances to start
SparkImage
typing.Literal[Any]
default:"spark-image"
required
str
default:"3.5.2"
required
Spark version should match the spark version installed in the image.
str
required
The image URI. Specify the name of the image and the tag. If the image is in Dockerhub, you can skip registry-url (for e.g.
tensorflow/tensorflow). You can use an image from a private registry using Advanced fieldstyping.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
SparkImageBuild
typing.Literal[Any]
default:"spark-image-build"
required
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
SparkImageBuildBuildSource
required
🔗 SparkImageBuildBuildSourceFetch source code
SparkBuild
required
SparkImageBuildBuildSource
Union, One Of:SparkJob
typing.Literal[Any]
default:"spark-job"
required
str
required
Name of the job
SparkJobImage
required
🔗 SparkJobImageThe image to use for driver and executors. Must have spark installed. Spark version must match the version in the image.
SparkJobEntrypoint
required
🔗 SparkJobEntrypointEntrypoint
SparkDriverConfig
required
SparkExecutorConfig
required
typing.Optional[typing.Dict[(str, typing.Any)]]
Configure environment variables to be injected in the service either as plain text. Docs
typing.Optional[typing.Dict[(str, typing.Optional[str])]]
Extra configuration properties to be passed to the spark job. Docs
typing.Optional[typing.List[VolumeMount]]
🔗 VolumeMountConfigure volumes to be mounted to driver and executors. Docs
typing.Optional[int]
Specify the maximum number of attempts to retry a job before it is marked as failed.
typing.Optional[str]
Service Account
typing.Optional[str]
Fully qualified name of the workspace
SparkJobEntrypoint
Union, One Of:- 🔗 SparkJobPythonEntrypoint
- 🔗 SparkJobScalaEntrypoint
- 🔗 SparkJobJavaEntrypoint
- 🔗 SparkJobPythonNotebookEntrypoint
- 🔗 SparkJobScalaNotebookEntrypoint
SparkJobImage
Union, One Of:SparkJobJavaEntrypoint
typing.Literal[Any]
default:"java"
required
str
required
The main application file to be executed by the spark job.
str
required
The main class to be executed by the spark job.
typing.Optional[str]
Arguments to be passed to the main application file.
SparkJobPythonEntrypoint
typing.Literal[Any]
default:"python"
required
str
required
The main application file to be executed by the spark job. Relative path in case of git repository.
typing.Optional[str]
Arguments to be passed to the main application file.
SparkJobPythonNotebookEntrypoint
typing.Literal[Any]
default:"python-notebook"
required
str
required
The main application file to be executed by the spark job. Relative path in case of git repository.
SparkJobScalaEntrypoint
typing.Literal[Any]
default:"scala"
required
str
required
The main application file to be executed by the spark job.
str
required
The main class to be executed by the spark job.
typing.Optional[str]
Arguments to be passed to the main application file.
SparkJobScalaNotebookEntrypoint
typing.Literal[Any]
default:"scala-notebook"
required
str
required
The main application file to be executed by the spark job. Relative path in case of git repository.
SparkJobTriggerInput
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing.Optional[str]
Arguments to pass to the main application file
SqlSanitizerGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/sql-sanitizer"
required
SqlSanitizerGuardrailConfigOperation
required
🔗 SqlSanitizerGuardrailConfigOperationValidate (detect and block) or Mutate (detect, sanitize comments, and continue).
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
SqlSanitizerGuardrailConfigConfig
required
SqlSanitizerGuardrailConfigConfig
typing.Optional[bool]
Block SQL DROP statements as dangerous operations.
typing.Optional[bool]
Block SQL TRUNCATE statements as dangerous operations.
typing.Optional[bool]
Block SQL ALTER statements as dangerous operations.
typing.Optional[bool]
Block SQL GRANT statements as dangerous operations.
typing.Optional[bool]
Block SQL REVOKE statements as dangerous operations.
typing.Optional[bool]
Remove SQL comments (— and block comments) from queries. In mutate mode, comments are stripped from the output.
typing.Optional[bool]
Flag DELETE FROM statements that lack a WHERE clause as potentially dangerous.
typing.Optional[bool]
Flag UPDATE statements that lack a WHERE clause as potentially dangerous.
typing.Optional[bool]
Detect naive string interpolation patterns (+, %., {}) that may indicate SQL injection vulnerabilities.
SqsInputConfig
typing.Literal[Any]
default:"sqs"
required
str
required
AWS SQS Queue URL of Subscriber
str
required
AWS Region Name
int
required
A period during which Amazon SQS prevents all consumers from receiving and processing the message. If one message takes 5 seconds to process, you can set this number to 7 or any number higher than 5. This will ensure that while the message is being processed, it will not be available to other replicas. For more information, see here
typing.Optional[AwsAccessKeyAuth]
SqsOutputConfig
typing.Literal[Any]
default:"sqs"
required
str
required
AWS SQS Queue URL of Publisher
str
required
AWS Region Name
typing.Optional[AwsAccessKeyAuth]
SqsQueueMetricConfig
typing.Literal[Any]
default:"sqs"
required
int
required
Upper limit of the number of backlog messages the auto-scaler will try to maintain per replica. If you set this number to 10 and have 30 messages in the queue and one replica, the auto-scaler will scale the number of replicas to 3.
typing.Optional[SqsQueueMetricConfigAuth]
🔗 SqsQueueMetricConfigAuthReceive permissions on the SQS Queue
SqsQueueMetricConfigAuth
Union, One Of:SshServer
typing.Literal[Any]
default:"ssh-server"
required
WorkbenchImage
required
str
required
Add Your SSH Public Key, this will be used to authenticate you to the SSH Server. \ You can find it using
cat ~/.ssh/id_rsa.pub in Mac/Linux or type $home\.ssh\id_rsa.pub in Windows Powershell. \ You can also generate a new SSH key pair using ssh-keygen -t rsa in your local terminal. (same for both Mac/Linux and Windows Powershell)typing.Optional[int]
Stop the SSH Server instance after this much time in minutes of inactivity. The instance is considered active if there is at least one active SSH connection (a client connected to the SSH server), or if a background job is running using tmux or screen, or if the pod has restarted.
SshServerConfig
str
required
The base domain for the cluster with which you can access your SSH containers
float
required
The port for the cluster with which you can access your SSH containers
StageArtifactRequestManifest
Union, One Of:StageArtifactResponse
str
required
ID of the staged artifact version
str
required
Root storage path where the artifact version files should be uploaded
str
required
ID of the artifact that the staged version belongs to
StaticVolumeConfig
typing.Literal[Any]
default:"static"
required
Volume Type for the volume.
str
required
Persistent Volume Name of the volume to be used.
StatsModelsFramework
typing.Literal[Any]
default:"statsmodels"
required
StdioMcpServerManifest
str
required
The name of the MCP Server.
str
required
Provide a brief description of the purpose of this MCP Server.
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to this MCP Server
typing.Literal[Any]
default:"mcp-server/stdio"
required
str
default:"npx"
required
Executable to run for the stdio MCP server process.
typing.Optional[typing.List[str]]
Arguments passed to the stdio MCP server command.
typing.Optional[McpServerEnvAuth]
typing.Optional[typing.Dict[(str, typing.Any)]]
Key-value pairs to categorize this MCP Server (e.g., by owner or environment).
StickyRouting
int
required
Sticky mapping TTL in seconds
typing.List[StickySessionIdentifier]
required
🔗 StickySessionIdentifierList of identifier selectors used to build sticky key
StickySessionIdentifier
StickySessionIdentifierSource
required
🔗 StickySessionIdentifierSourceSource from which session identifier value will be extracted
str
required
Key to read from selected source
StringDataMount
typing.Literal[Any]
default:"string"
required
str
required
Absolute file path where the file will be created.
str
required
The file content.
SubAgent
str
required
Name of the sub agent
Subject
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(SubjectType, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
SubjectClause
typing_extensions.Annotated[(typing.Optional[typing.List[str]], Any, Any)]
typing.Optional[typing.List[str]]
SubjectConditionGroup
SubjectConditionGroupOperator
required
SubjectClause
required
SubjectPermission
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
SyncTokenInSecretStoreInfo
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[str]
Error message if sync failed
SyncVirtualAccountTokenResponse
typing_extensions.Annotated[(SyncTokenInSecretStoreInfo, Any, Any)]
required
SystemMessage
typing.Literal[Any]
default:"system"
required
Role of the message
SystemMessageContent
required
🔗 SystemMessageContentText content for the system message
typing.Optional[str]
Name of the system
SystemMessageContent
Union, One Of:TargetClause
typing_extensions.Annotated[(typing.Optional[InNotInOperator], Any, Any)]
typing_extensions.Annotated[(typing.Optional[McpToolsOperator], Any, Any)]
typing.Optional[InNotInOperator]
TargetConditionGroup
typing.Literal[Any]
default:"or"
required
TargetClause
required
TaskDockerFileBuild
typing.Literal[Any]
default:"task-dockerfile-build"
required
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
str
default:"./Dockerfile"
required
The file path of the Dockerfile relative to project root path.
typing.Optional[typing.Dict[(str, str)]]
Build arguments to pass to docker build
TaskPySparkBuild
typing.Literal[Any]
default:"task-pyspark-build"
required
str
default:"3.5.2"
required
Spark version should match the spark version installed in the image.
typing.Optional[str]
Custom container image URI. If provided, this image is used instead of the default Spark base image (public.ecr.aws/bitnami/spark). The image must be Debian-based and have Python and Spark pre-installed.
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
typing.Optional[str]
Path to
requirements.txt relative to Path to build contexttyping.Optional[typing.List[str]]
Define pip package requirements. In Python/YAML E.g. [“fastapi>=0.90,<1.0”, “uvicorn”]
typing.Optional[typing.List[str]]
Debian packages to install via
apt get. In Python/YAML E.g. [“git”, “ffmpeg”, “htop”]TaskPythonBuild
typing.Literal[Any]
default:"task-python-build"
required
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
typing.Optional[str]
Python version to run your application. Should be one of the tags listed on Official Python Docker Page
typing.Optional[str]
Path to
requirements.txt relative to Path to build contexttyping.Optional[typing.List[str]]
Define pip package requirements. In Python/YAML E.g. [“fastapi>=0.90,<1.0”, “uvicorn”]
typing.Optional[typing.List[str]]
Debian packages to install via
apt get. In Python/YAML E.g. [“git”, “ffmpeg”, “htop”]typing.Optional[str]
Version of CUDA Toolkit and CUDNN to install in the image These combinations are based off of publically available docker images on docker hub You can also specify a valid tag of the form {cuda_version_number}-cudnn{cudnn_version_number}-{runtime|devel}-ubuntu{ubuntu_version} Refer https://hub.docker.com/r/nvidia/cuda/tags for valid set of values Note: We use deadsnakes ubuntu ppa to add Python that currently supports only Ubuntu 18.04, 20.04 and 22.04
Team
str
required
str
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[typing.List[str]]
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
TeamManifest
required
typing.Optional[TeamMetadata]
typing_extensions.Annotated[(bool, Any, Any)]
required
TeamDataAccessRule
typing.Literal[Any]
default:"team_data"
required
Data access scope - access to team data including owned virtual accounts
TeamManifest
typing.Literal[Any]
default:"team"
required
str
required
Name of the Team
typing.Optional[typing.List[str]]
Emails of each of the user who can manage the members of the team. Any tenant admin is by default a team manager.
typing.List[str]
required
Enter email of each of the user you want to add in the team.
typing_extensions.Annotated[(typing.Optional[TeamOwnedBy], Any, Any)]
typing.Optional[typing.Dict[(str, typing.Any)]]
Key-value pairs to categorize this Team (e.g., by owner or environment).
TeamMetadata
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
TeamOwnedBy
str
required
The name of the account that owns the team
TensorFlowFramework
typing.Literal[Any]
default:"tensorflow"
required
TerminateJobResponse
str
required
Terminate Job Message
typing_extensions.Annotated[(JobRunStatus, Any, Any)]
required
TextContentPart
typing.Literal[Any]
default:"text"
required
Type of the content part
TextContentPartText
required
🔗 TextContentPartTextText content for the message
TextContentPartText
Union, One Of:TfyContentModerationGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. TrueFoundry Content Moderation guardrails can only be used for validation.
EnforcingStrategy
required
TfyContentModerationGuardrailConfigConfig
required
TfyContentModerationGuardrailConfigConfig
float
default:"2.0"
required
Minimum severity level (0-6) to flag content. 0=Safe, 2=Low risk, 4=Medium risk, 6=High risk
typing.List[AzureContentSafetyCategory]
required
🔗 AzureContentSafetyCategoryTypes of harmful content to detect: Hate (hate speech), SelfHarm (self-injury), Sexual (sexual content), Violence (violent content)
TfyPiiGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/tfy-pii"
required
TfyPiiGuardrailConfigOperation
required
🔗 TfyPiiGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first.
EnforcingStrategy
required
TfyPiiGuardrailConfigConfig
required
TfyPiiGuardrailConfigConfig
typing.List[AzurePiiCategory]
required
🔗 AzurePiiCategoryCategories of PII to detect.
TfyPromptInjectionGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
required
typing.Literal[Any]
default:"validate"
required
The operation type for this guardrail. TrueFoundry Prompt Shield guardrails can only be used for validation.
EnforcingStrategy
required
TogetherAiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for Together AI authentication
TogetherAiModel
typing.Literal[Any]
default:"integration/model/together-ai"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Together AI model identifier (e.g., deepseek-ai/DeepSeek-R1, moonshotai/Kimi-K2-Instruct-0905). This is the model name from Together AI’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Together AI model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
TogetherAiProviderAccount
typing.Literal[Any]
default:"provider-account/together-ai"
required
str
required
The name of the Together AI provider account
TogetherAiKeyAuth
required
typing.List[TogetherAiIntegrations]
required
List of integrations that are associated with the Together AI provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
TokenPagination
typing.Optional[int]
Number of items per page
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
ToolCall
typing.Literal[Any]
default:"function"
required
Type of the tool call
str
required
Unique identifier for the tool call
Function
required
ToolMessage
typing.Literal[Any]
default:"tool"
required
Role of the message
ToolMessageContent
required
🔗 ToolMessageContentContent of the tool call result
str
required
Unique identifier for the tool call
ToolMessageContent
Union, One Of:ToolSchema
typing.Literal[Any]
default:"function"
required
Type of the tool
FunctionSchema
required
TraceSpan
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
str
required
Timestamp in ISO 8601 format (e.g., 2025-03-12T00:00:09.872Z).
typing_extensions.Annotated[(float, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Dict[(str, typing.Any)], Any, Any)]
required
typing.List[typing.Dict[(str, typing.Any)]]
required
Array of events that occurred during the span execution.
typing.Optional[typing.List[typing.List[typing.Any]]]
Gateway feedbacks associated with this span (if any).
TracingProjectControlPlaneManagedStorage
typing.Literal[Any]
default:"controlplane-managed"
required
Type of storage configuration
TracingProjectCustomerManagedStorage
typing.Literal[Any]
default:"customer-managed"
required
Type of storage configuration
str
required
Storage Integration FQN to store traces and spans. A storage integration represents a connected blob storage like AWS S3 / Azure Blob Storage / Google Cloud Storage. Please note that this cannot be changed once set.
TracingProjectManifest
typing.Literal[Any]
default:"tracing-project"
required
str
required
Name of the Tracing Project
TracingProjectStorageConfig
required
typing.Optional[str]
Description for the Tracing Project.
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to Tracing Project
typing.Optional[float]
Number of days to retain traces for (minimum 7 days). Traces older than these number of days will be deleted automatically. When not set, traces are retained indefinitely. Note: Metrics will be retained regardless of this setting.
TracingProjectStorageConfig
Union, One Of:TransformersFramework
typing.Literal[Any]
default:"transformers"
required
typing.Optional[LibraryName]
🔗 LibraryNameName of the library for the framework
typing.Optional[str]
The
pipeline() task this model can be used with e.g. text-generation. See huggingface docs for all possible valuestyping.Optional[str]
Base model Id from HuggingFace Hub. If this is a finetuned model, this points to the base model id used for finetuning.
TriggerJobRequestInput
Union, One Of:TriggerJobRunResponse
str
required
Job triggered
typing_extensions.Annotated[(str, Any, Any)]
required
TrojAiClientIdAuth
typing.Literal[Any]
default:"client-id"
required
str
required
The client ID that identifies your TrojAI firewall policy (sent as x-eag-clientid header)
TrojAiGuardrailConfig
str
required
The name of the Guardrail Config.
typing.Optional[str]
Optional description for this Guardrail Config.
typing.Literal[Any]
default:"integration/guardrail-config/trojai"
required
TrojAiClientIdAuth
required
TrojAiGuardrailConfigOperation
required
🔗 TrojAiGuardrailConfigOperationThe operation type to use for the Guardrail. Validate guardrails are used to validate requests and mutate can validate as well as mutate requests. Validate guardrails are run in parallel while mutate guardrails are run sequentially.
typing.Optional[int]
default:"1"
Execution order for mutate guardrails. Lower values run first. Only applicable when operation is mutate.
EnforcingStrategy
required
TrojAiGuardrailConfigConfig
required
TrojAiGuardrailConfigConfig
str
required
The base URL of the TrojAI firewall (e.g. https://your-trojai-firewall-host)
TrueFoundryAgentManifest
typing.Literal[Any]
default:"truefoundry-agent"
required
Type of the manifest
str
required
The name of the Agent
str
required
The description of the Agent
typing.Optional[typing.Dict[(str, typing.Any)]]
Tags for the Agent
str
required
Model for the Agent
typing.Optional[TrueFoundryAgentManifestModelParams]
🔗 TrueFoundryAgentManifestModelParamsModel parameters (default and extra). Keys are param names, values are float, int, bool, or string.
typing.Optional[typing.List[TrueFoundryAgentSkill]]
🔗 TrueFoundryAgentSkillList of agent skills to attach to this agent
typing.Optional[typing.List[TrueFoundryAgentMcpServer]]
🔗 TrueFoundryAgentMcpServerList of MCP servers with name, enable_all_tools, and optional tools filter
typing.Optional[str]
System instruction or prompt for the agent
typing.Optional[typing.List[TrueFoundryAgentUserMessage]]
🔗 TrueFoundryAgentUserMessagePre-defined initial messages for the agent. Supports template variable replacement.
typing.Optional[typing.Dict[(str, TrueFoundryAgentVariable)]]
🔗 TrueFoundryAgentVariableVariables keyed by name. Each has optional default_value and optional description.
typing.Optional[TrueFoundryAgentManifestResponseFormat]
🔗 TrueFoundryAgentManifestResponseFormatJSON schema or structure for the agent response format
typing.Optional[TrueFoundryAgentManifestSandbox]
🔗 TrueFoundryAgentManifestSandboxSandbox execution settings
typing.Optional[int]
Maximum number of iterations for the agent
typing.List[Collaborator]
required
🔗 CollaboratorList of users who have access to this Agent
TrueFoundryAgentManifestModelParams
typing.Optional[int]
Maximum number of tokens to generate.
typing.Optional[TrueFoundryAgentManifestModelParamsReasoningEffort]
🔗 TrueFoundryAgentManifestModelParamsReasoningEffortReasoning depth when the model and provider support this parameter.
typing.Optional[float]
Sampling temperature (0–2). Higher values increase randomness.
typing.Optional[float]
Nucleus sampling threshold (0–1). Alternative to temperature.
TrueFoundryAgentManifestResponseFormat
Union, One Of:TrueFoundryAgentManifestSandbox
bool
required
TrueFoundryAgentMcpServer
str
required
MCP server name
typing.Optional[bool]
When true, tools from this server are loaded lazily (deferred loading).
typing.Optional[typing.List[TrueFoundryAgentMcpTool]]
🔗 TrueFoundryAgentMcpToolList of tools to enable from this server
TrueFoundryAgentMcpTool
str
required
TrueFoundryAgentSkill
str
required
Fully qualified name of the agent skill
bool
required
If true, the SKILL.md content is injected into the agent context.
TrueFoundryAgentUserMessage
typing.Literal[Any]
default:"user"
required
Role of the message sender.
str
required
Content of the user message. Supports template variables like {{variable_name}}.
TrueFoundryAgentVariable
typing.Optional[str]
Default value for the variable
typing.Optional[str]
Description of the variable
TrueFoundryApplyRequestManifest
Union, One Of:- 🔗 MlRepoManifest
- 🔗 ArtifactManifest
- 🔗 ModelManifest
- 🔗 ChatPromptManifest
- 🔗 DataDirectory
- 🔗 Service
- 🔗 ApplicationSet
- 🔗 ProviderAccounts
- 🔗 ClusterManifest
- 🔗 WorkspaceManifest
- 🔗 Job
- 🔗 Helm
- 🔗 Volume
- 🔗 Notebook
- 🔗 RStudio
- 🔗 Workflow
- 🔗 AsyncService
- 🔗 SshServer
- 🔗 SparkJob
- 🔗 GatewayConfig
- 🔗 TeamManifest
- 🔗 PolicyManifest
- 🔗 RoleManifest
- 🔗 AlertConfig
- 🔗 VirtualAccountManifest
- 🔗 CommonToolsSettings
- 🔗 AiFeaturesSettings
- 🔗 SecretGroupManifest
- 🔗 AgentManifest
- 🔗 EnvironmentManifest
- 🔗 TracingProjectManifest
- 🔗 McpServerManifest
- 🔗 RoleBindingManifest
TrueFoundryApplyResponse
typing_extensions.Annotated[(typing.Optional[TrueFoundryApplyResponseExistingManifest], Any, Any)]
typing.Optional[TrueFoundryApplyResponseAction]
🔗 TrueFoundryApplyResponseActionThe action performed: CREATE or UPDATE
typing.Optional[typing.Dict[(str, typing.Any)]]
The created or updated resource
TrueFoundryApplyResponseExistingManifest
Union, One Of:- 🔗 MlRepoManifest
- 🔗 ArtifactManifest
- 🔗 ModelManifest
- 🔗 ChatPromptManifest
- 🔗 DataDirectory
- 🔗 Service
- 🔗 ApplicationSet
- 🔗 ProviderAccounts
- 🔗 ClusterManifest
- 🔗 WorkspaceManifest
- 🔗 Job
- 🔗 Helm
- 🔗 Volume
- 🔗 Notebook
- 🔗 RStudio
- 🔗 Workflow
- 🔗 AsyncService
- 🔗 SshServer
- 🔗 SparkJob
- 🔗 GatewayConfig
- 🔗 TeamManifest
- 🔗 PolicyManifest
- 🔗 RoleManifest
- 🔗 AlertConfig
- 🔗 VirtualAccountManifest
- 🔗 CommonToolsSettings
- 🔗 AiFeaturesSettings
- 🔗 SecretGroupManifest
- 🔗 AgentManifest
- 🔗 EnvironmentManifest
- 🔗 TracingProjectManifest
- 🔗 McpServerManifest
- 🔗 RoleBindingManifest
TrueFoundryArtifactSource
typing.Literal[Any]
default:"truefoundry-artifact"
required
str
required
Artifact or Model Version FQN of the artifact to be downloaded
str
required
Environment variable which will contain the download path of the artifact
TrueFoundryDbssm
typing.Literal[Any]
default:"integration/secret-store/truefoundry/db"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
TrueFoundryDeleteRequestManifest
Union, One Of:- 🔗 MlRepoManifest
- 🔗 ArtifactManifest
- 🔗 ModelManifest
- 🔗 ChatPromptManifest
- 🔗 DataDirectory
- 🔗 Service
- 🔗 ApplicationSet
- 🔗 ProviderAccounts
- 🔗 ClusterManifest
- 🔗 WorkspaceManifest
- 🔗 Job
- 🔗 Helm
- 🔗 Volume
- 🔗 Notebook
- 🔗 RStudio
- 🔗 Workflow
- 🔗 AsyncService
- 🔗 SshServer
- 🔗 SparkJob
- 🔗 GatewayConfig
- 🔗 TeamManifest
- 🔗 PolicyManifest
- 🔗 RoleManifest
- 🔗 AlertConfig
- 🔗 VirtualAccountManifest
- 🔗 CommonToolsSettings
- 🔗 AiFeaturesSettings
- 🔗 SecretGroupManifest
- 🔗 AgentManifest
- 🔗 EnvironmentManifest
- 🔗 TracingProjectManifest
- 🔗 McpServerManifest
- 🔗 RoleBindingManifest
TrueFoundryInteractiveLogin
typing.Literal[Any]
default:"truefoundry_oauth"
required
typing.Optional[typing.List[str]]
List of paths that will bypass auth. needs to start with a forward slash(/) and should not contain wildcards(*)
TrueFoundryManagedSource
typing.Literal[Any]
default:"truefoundry"
required
typing.Optional[str]
TrueFoundryProviderAccount
typing.Literal[Any]
default:"provider-account/truefoundry"
required
str
required
The name of the provider account.
typing.Optional[typing.List[TrueFoundryIntegrations]]
List of integrations that are associated with the provider account.
TtlProviderAccount
typing.Literal[Any]
default:"provider-account/ttl"
required
str
required
The name of the provider account.
typing.List[TtlIntegrations]
required
List of integrations that are associated with the provider account.
TtlRegistry
typing.Literal[Any]
default:"integration/docker-registry/ttl"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
default:"https://ttl.sh"
required
The URL of the registry.
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
UpdateSecretInput
str
required
Key of the secret.
typing.Optional[str]
Value of the secret.
UpdateUserRolesResponse
Union, One Of:UpgradeData
typing.Optional[typing.List[Any]]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[str]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
UploadSpecSource
typing.Literal[Any]
default:"upload"
required
str
required
Cloud storage path where the OpenAPI specification is stored (S3, GCS, or Azure Blob).
UsageCodeSnippet
str
required
Display name for the code snippet (e.g., ‘Python’, ‘JavaScript’)
str
required
Programming language of the code snippet (e.g., ‘python’, ‘javascript’)
typing.Optional[typing.List[str]]
List of libraries/frameworks used in the code snippet
str
required
Code snippet demonstrating how to use the prompt version
User
str
required
str
required
typing_extensions.Annotated[(str, Any, Any)]
required
UserMetadata
required
typing.Optional[typing.List[str]]
typing_extensions.Annotated[(typing.Optional[typing.List[RoleWithResource]], Any, Any)]
typing.Optional[typing.List[AccountInfo]]
bool
required
typing_extensions.Annotated[(bool, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
UserMessage
typing.Literal[Any]
default:"user"
required
Role of the message
UserMessageContent
required
🔗 UserMessageContentContent of the user message. can be a mix of text and images
typing.Optional[str]
Name of the user this message is from
UserMessageContent
Union, One Of:UserMessageContentOneItem
Union, One Of:UserMetadata
typing.Optional[str]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, typing.Any)]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing.Optional[typing.Dict[(str, typing.Any)]]
typing.Optional[typing.List[str]]
typing_extensions.Annotated[(typing.Optional[UserMetadataTenantRoleManagedBy], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.Dict[(str, typing.Any)]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
UserResource
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
UserTeamInfo
typing_extensions.Annotated[(str, Any, Any)]
required
typing.List[str]
required
Roles of the user in the team
Uv
typing.Literal[Any]
default:"uv"
required
typing.Optional[str]
default:"latest"
UV version to use
typing.Optional[str]
Sync options to pass to uv command
ValidationError
typing.List[ValidationErrorLocItem]
required
str
required
str
required
ValidationErrorLocItem
Union, One Of:VertexKeyFileAuth
typing.Literal[Any]
default:"key-file"
required
VertexKeyFileAuthKeyFileContent
required
🔗 VertexKeyFileAuthKeyFileContentJSON from a downloadable Google Cloud service account key (type service_account). Not for Workload Identity Federation; use authentication type Workload Identity Federation file (workload-identity-federation-file) for gcloud iam workload-identity-pools create-cred-config output.
VertexKeyFileAuthKeyFileContent
Union, One Of:VertexModel
typing.Literal[Any]
default:"integration/model/vertex"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The Google Vertex AI model identifier (e.g., gemini-2.5-pro, anthropic/claude-sonnet-4-5@20250929). This is the model version name from Vertex AI’s model catalog.
typing.Optional[VertexRegion]
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the Vertex AI model (e.g., chat, text, etc.)
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
VertexWifFileAuth
typing.Literal[Any]
default:"workload-identity-federation-file"
required
VertexWifFileAuthKeyFileContent
required
🔗 VertexWifFileAuthKeyFileContentJSON credential configuration for Workload Identity Federation (ADC type external_account), for example from gcloud iam workload-identity-pools create-cred-config. This is not a service account private key. Same field name as key-file auth (key_file_content); use auth_data.type workload-identity-federation-file vs key-file to distinguish.
VertexWifFileAuthKeyFileContent
Union, One Of:VirtualAccount
str
required
str
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[VirtualAccountManifest]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing_extensions.Annotated[(str, Any, Any)]
required
typing.Optional[typing.Dict[(str, typing.Any)]]
typing_extensions.Annotated[(typing.Optional[typing.List[str]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[typing.List[RoleWithResource]], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
VirtualAccountManifest
str
required
Virtual Account Name
typing.Literal[Any]
default:"virtual-account"
required
typing.List[Permissions]
required
🔗 PermissionsPermissions
typing.Optional[str]
Expiration Date of the Virtual Account (should be in the format yyyy-mm-dd)
typing.Optional[AutoRotate]
typing.Optional[NotificationTarget]
typing.Optional[SecretStoreConfig]
typing_extensions.Annotated[(typing.Optional[VirtualAccountOwnedBy], Any, Any)]
typing.Optional[typing.Dict[(str, typing.Any)]]
Key-value pairs to categorize this Virtual Account (e.g., by owner or environment).
VirtualAccountOwnedBy
typing.Optional[str]
The name of the account that owns this resource
str
required
The name of the team that owns this resource
VirtualMcpServerIntegration
typing.Literal[Any]
default:"integration/mcp-server/virtual"
required
str
required
The name of the Virtual MCP Server.
str
required
Provide a brief description of the purpose of this Virtual MCP Server.
typing.List[VirtualMcpServerSource]
required
🔗 VirtualMcpServerSourceList of source MCP servers to include in this virtual server.
typing.Optional[typing.List[str]]
List of teams/users who can use this MCP server.
VirtualMcpServerManifest
typing.Literal[Any]
default:"mcp-server/virtual"
required
str
required
The name of the Virtual MCP Server.
str
required
Provide a brief description of the purpose of this Virtual MCP Server.
typing.List[McpServerSource]
required
🔗 McpServerSourceList of source MCP servers to include in this virtual server.
typing.List[Collaborator]
required
🔗 CollaboratorUsers and Teams that have access to this Virtual MCP Server
typing.Optional[typing.Dict[(str, typing.Any)]]
Key-value pairs to categorize this Virtual MCP Server (e.g., by owner or environment).
VirtualMcpServerSource
str
required
Name of the source MCP server within this group (use {provider_account_name}/{integration_name} format).
typing.Optional[typing.List[str]]
List of tools to enable from this source server.
typing.Optional[McpServerHeaderOverrideAuth]
VirtualModel
str
required
The name of the Virtual Model
typing.Literal[Any]
default:"integration/model/virtual"
required
typing.List[VirtualModelModelType]
required
🔗 VirtualModelModelTypeSpecify the type of the Virtual Model
typing.Optional[str]
It should be a unique identifier for the virtual model. It is used to uniquely identify the virtual model. It can be used in place of virtualGroupName/virtualModelName.
HeaderRoutingConfig
required
VirtualModelProviderAccount
str
required
The name of the Virtual Model Provider Group
typing.Literal[Any]
default:"provider-account/virtual-model"
required
typing.List[VirtualModel]
required
🔗 VirtualModelList of virtual models in this group
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this Virtual Model Provider Group
Volume
typing.Literal[Any]
default:"volume"
required
str
required
Name of the Volume. This will be set as the volume name.
VolumeConfig
required
🔗 VolumeConfigVolume Config - Volume Configuration, can be either Dynamically provisioned or statically provisioned.
typing.Optional[VolumeBrowser]
typing.Optional[str]
Fully qualified name of the workspace
VolumeBrowser
typing.Optional[str]
Username for logging in the volume browser.
typing.Optional[str]
TFY Secret containing the password for logging in the volume browser.
Endpoint
required
typing.Optional[str]
Kubernetes Service account name for the volume browser.
VolumeConfig
Union, One Of:VolumeMount
typing.Literal[Any]
default:"volume"
required
str
required
Absolute file path where the volume will be mounted.
typing.Optional[str]
Sub path within the volume to mount. Defaults to root of the volume.
str
required
The TrueFoundry volume that needs to be mounted.
WebhookBasicAuth
typing.Literal[Any]
default:"webhook-basic"
required
str
required
Basic auth username
str
required
Basic auth password
WebhookBearerAuth
typing.Literal[Any]
default:"webhook-bearer"
required
str
required
Bearer token for authentication
str
default:"Bearer"
required
Prefix for the token
WebhookIntegration
typing.Literal[Any]
default:"integration/gateway-request-logger/webhook"
required
str
required
The name of the integration that will be displayed in the TrueFoundry UI.
str
required
The URL of the webhook endpoint
typing.Optional[WebhookIntegrationAuthData]
🔗 WebhookIntegrationAuthDataAuthentication configuration for the webhook
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
WebhookIntegrationAuthData
Union, One Of:WebhookProviderAccount
typing.Literal[Any]
default:"provider-account/webhook"
required
str
required
The name of the provider account.
typing.List[WebhookIntegrations]
required
🔗 WebhookIntegrationList of integrations that are associated with the provider account.
WeightBasedLoadBalancing
typing.Literal[Any]
default:"weight-based-routing"
required
typing.List[LoadBalanceTarget]
required
🔗 LoadBalanceTargetList of targets for load balancing with weights
typing.Optional[StickyRouting]
WeightBasedLoadBalancingRule
str
required
Unique identifier for the rule
LoadBalancingWhen
required
WorkbenchImage
str
required
The image URI. Specify the name of the image and the tag. If the image is in Dockerhub, you can skip registry-url (for e.g.
tensorflow/tensorflow). You can use an image from a private registry using Advanced fieldstyping.Optional[str]
The build script to run when building the image. This will be executed as the last step in the docker build process as the root user (RUN DEBIAN_FRONTEND=noninteractive bash -ex build_script.sh)
typing.Optional[str]
FQN of the container registry. If you can’t find your registry here, add it through the Integrations page
WorkerConfig
WorkerConfigInputConfig
required
🔗 WorkerConfigInputConfigInput Config
typing.Optional[WorkerConfigOutputConfig]
🔗 WorkerConfigOutputConfigOutput Config
int
default:"1"
required
Number of concurrent workers to spawn for the processor
WorkerConfigInputConfig
Union, One Of:WorkerConfigOutputConfig
Union, One Of:Workflow
typing.Literal[Any]
default:"workflow"
required
str
required
Name of the workflow
WorkflowSource
required
🔗 WorkflowSourceSource Code for the workflow, either local or remote
str
required
Path to the workflow file relative to the project root path
typing.Optional[typing.List[WorkflowFlyteEntitiesItem]]
🔗 WorkflowFlyteEntitiesItemFlyte Entities
typing.Optional[typing.List[WorkflowAlert]]
🔗 WorkflowAlertAlerts
WorkflowAlert
typing.Optional[NotificationTarget]
typing.Optional[bool]
Send an alert when the job completes
typing.Optional[bool]
Send an alert when the job fails
WorkflowFlyteEntitiesItem
Union, One Of:WorkflowSource
Union, One Of:Workspace
str
required
str
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(dt.datetime, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
WorkspaceManifest
required
typing_extensions.Annotated[(str, Any, Any)]
required
typing_extensions.Annotated[(typing.Optional[bool], Any, Any)]
typing_extensions.Annotated[(typing.Optional[str], Any, Any)]
WorkspaceManifest
typing.Literal[Any]
default:"workspace"
required
str
required
Cluster FQN
str
required
Name - 3 to 32 lower case characters long alphanumeric word, may contain - in between, cannot start with a number
typing.Optional[str]
Tag the environment like dev, staging or production. You will need to create environments if you don’t have already.
typing.Optional[typing.Dict[(str, str)]]
typing.Optional[typing.Dict[(str, str)]]
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorCollaborators
typing.Optional[typing.List[Permissions]]
🔗 PermissionsPermissions
WorkspacesDeleteResponse
typing.Optional[Workspace]
typing.Optional[str]
Destroyed the workspace
XaiKeyAuth
typing.Literal[Any]
default:"api-key"
required
str
required
The API key for xAI authentication
XaiModel
typing.Literal[Any]
default:"integration/model/xai"
required
str
required
A descriptive name to identify this model integration in the UI
str
required
The xAI model identifier (e.g., grok-4-1-fast-reasoning, grok-4-1-fast-non-reasoning, grok-4). This is the model name from xAI’s model catalog.
typing.List[ModelType]
required
🔗 ModelTypeSpecify the type of the xAI model
typing.Optional[ModelCostMetric]
typing.Optional[typing.List[str]]
List of subjects that are authorized to access this integration. List of user fqn in format <user_type>:<username>.
XaiProviderAccount
typing.Literal[Any]
default:"provider-account/xai"
required
str
required
The name of the xAI provider account
XaiKeyAuth
required
typing.Optional[typing.List[XaiIntegrations]]
List of integrations that are associated with the xAI provider account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this provider account
XgBoostFramework
typing.Literal[Any]
default:"xgboost"
required
typing.Optional[XgBoostSerializationFormat]
typing.Optional[str]
Relative path to the model file in the model version contents
typing.Optional[XgBoostModelSchema]
XgBoostModelSchema
typing.Literal[Any]
default:"predict"
required
Name of the method used for inference
typing.List[typing.Dict[(str, typing.Any)]]
required
Schema of the input
typing.List[typing.Dict[(str, typing.Any)]]
required
Schema of the output