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 model account
Ai21KeyAuth
required
typing.Optional[typing.List[Ai21Integrations]]
List of integrations that are associated with the AI21 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
typing.Optional[AnthropicKeyAuth]
typing.Optional[typing.List[AnthropicIntegrations]]
List of integrations that are associated with the Anthropic model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
typing.List[AzureFoundryModel]
required
🔗 AzureFoundryModelList of integrations that are associated with the Azure Foundry model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
BasetenKeyAuth
required
typing.Optional[typing.List[BasetenIntegrations]]
List of integrations that are associated with the Baseten model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
CerebrasKeyAuth
required
typing.Optional[typing.List[CerebrasIntegrations]]
List of integrations that are associated with the Cerebras model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
ClouderaProviderAccountAuthData
required
🔗 ClouderaProviderAccountAuthDataCloudera authentication credentials
typing.List[ClouderaIntegrations]
required
List of integrations that are associated with the Cloudera model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
CohereKeyAuth
required
typing.Optional[typing.List[CohereIntegrations]]
List of integrations that are associated with the Cohere model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model 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 model account.
typing.Optional[CustomBasicAuth]
typing.List[CustomIntegrations]
required
🔗 CustomIntegrationsList of integrations that are associated with the model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
DeepinfraKeyAuth
required
typing.Optional[typing.List[DeepinfraIntegrations]]
List of integrations that are associated with the DeepInfra model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
GcpApiKeyAuth
required
typing.List[GeminiModel]
required
🔗 GeminiModelList of integrations that are associated with the Google Gemini model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model 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 model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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 model account
GroqKeyAuth
required
typing.List[GroqIntegrations]
required
List of integrations that are associated with the Groq model account
typing.Optional[typing.List[Collaborator]]
🔗 CollaboratorList of users who have access to this model 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]