TrueFoundry SDK
TrueFoundry ML Client
Apply API Guides
Applications
Artifacts
- GETGet Artifact
- DELDelete Artifact
- GETList Artifacts
- PUTApply Artifact Version Tags
- GETGet Artifact Version
- DELDelete Artifact Version
- GETList Artifact Versions
- PUTApply Artifact Version
- POSTDelete Artifact Version
- POSTGet Signed Urls For Artifact Version
- POSTCreate Multi Part Upload
- POSTStage Artifact Version
- POSTList Files For Artifact Version
- POSTMark Stage Failure
Audit Logs
Clusters
Model Deployments
Models
Personal Access Tokens
Prompts
Provider Integrations
Secret Groups
Users
Virtual Accounts
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "ml-repo",
"name": "<string>",
"storage_integration_fqn": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"description": "<string>",
"ownedBy": {
"account": "<string>"
}
},
"dryRun": true
}
'{
"existingManifest": {
"type": "ml-repo",
"name": "<string>",
"storage_integration_fqn": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"description": "<string>",
"ownedBy": {
"account": "<string>"
}
},
"action": "CREATE",
"data": {}
}Create or Update Resources
Applies a given manifest to create or update resources of specific types, such as provider-account, cluster, workspace, or ml-repo.
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "ml-repo",
"name": "<string>",
"storage_integration_fqn": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"description": "<string>",
"ownedBy": {
"account": "<string>"
}
},
"dryRun": true
}
'{
"existingManifest": {
"type": "ml-repo",
"name": "<string>",
"storage_integration_fqn": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"description": "<string>",
"ownedBy": {
"account": "<string>"
}
},
"action": "CREATE",
"data": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
manifest of the resource to be created or updated
Show child attributes
Show child attributes
+value=ml-repo
ml-repo +label=Name +icon=fa-desktop:#black +usage=Name of the ML Repo. +message=Alphanumeric word, may contain '-' with a maximum length of 100 characters +sort=1
+label=Storage Integration +icon=hard-drive +usage=Storage Integration to store artifacts and models. A storage integration represents a connected blob storage like AWS S3 / Azure Blob Storage / Google Cloud Storage. +message=Select the storage-integration where you want to save your artifacts and models View Docs +sort=4
+label=Collaborators +sort=5 +usage=Users and Teams that have access to MLRepo +uiType=Collaborators
+label=Description +icon=fa-desktop:#black +usage=Description for the ML Repo. +message=Description can be maximum 500 characters +sort=2 +placeholder=MLRepo to track text-classification experiments and models +uiProps={"descriptionInline":true}
+label=Owner +usage=Names of the owners that own this resource
Show child attributes
Show child attributes
+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=AccountSelect +uiProps={"maxAllowedAccounts": 1}
Dry run the apply operation without actually applying
Response
The resource has been successfully created or updated.
The existing manifest of the resource
Show child attributes
Show child attributes
+value=ml-repo
ml-repo +label=Name +icon=fa-desktop:#black +usage=Name of the ML Repo. +message=Alphanumeric word, may contain '-' with a maximum length of 100 characters +sort=1
+label=Storage Integration +icon=hard-drive +usage=Storage Integration to store artifacts and models. A storage integration represents a connected blob storage like AWS S3 / Azure Blob Storage / Google Cloud Storage. +message=Select the storage-integration where you want to save your artifacts and models View Docs +sort=4
+label=Collaborators +sort=5 +usage=Users and Teams that have access to MLRepo +uiType=Collaborators
+label=Description +icon=fa-desktop:#black +usage=Description for the ML Repo. +message=Description can be maximum 500 characters +sort=2 +placeholder=MLRepo to track text-classification experiments and models +uiProps={"descriptionInline":true}
+label=Owner +usage=Names of the owners that own this resource
Show child attributes
Show child attributes
+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=AccountSelect +uiProps={"maxAllowedAccounts": 1}
The action performed: CREATE or UPDATE
CREATE, UPDATE The created or updated resource
Was this page helpful?