Services

List Services

get

Gets a page of service objects.

Args: filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: Page of service objects.

Authorizations

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

scope_userany ofOptional

string · uuidOptional

or

nullOptional

userany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

projectany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

typeany ofOptional

stringOptional

or

nullOptional

flavorany ofOptional

stringOptional

or

nullOptional

configany ofOptional

string · binaryOptional

or

nullOptional

pipeline_nameany ofOptional

stringOptional

or

nullOptional

pipeline_step_nameany ofOptional

stringOptional

or

nullOptional

runningany ofOptional

booleanOptional

or

nullOptional

model_version_idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

pipeline_run_idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/services HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "service_type": {
          "type": "text",
          "flavor": "text",
          "name": "text",
          "description": "text",
          "logo_url": "text"
        },
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "state": "inactive"
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "service_source": "text",
        "admin_state": "inactive",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "status": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "endpoint": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "prediction_url": "text",
        "health_check_url": "text"
      },
      "resources": {
        "pipeline_run": "[Circular Reference]",
        "model_version": "[Circular Reference]",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Create Service

post

Creates a new service.

Args: service: The service to create. project_name_or_id: Optional name or ID of the project.

Returns: The created service.

Authorizations

Query parameters

project_name_or_idany ofOptional

stringOptional

or

string · uuidOptional

or

nullOptional

Body

Request model for services.

userany ofOptional

string · uuidOptional

or

nullOptional

projectstring · uuidRequired

namestring · max: 255Required

service_sourceany ofOptional

The fully qualified class name of the service implementation.

stringOptional

or

nullOptional

admin_stateany ofOptional

The administrative state of the service, e.g., ACTIVE, INACTIVE.

string · enumOptional

Possible states for the service and service endpoint.

Possible values:

or

nullOptional

labelsany ofOptional

or

nullOptional

statusany ofOptional

or

nullOptional

endpointany ofOptional

or

nullOptional

prediction_urlany ofOptional

stringOptional

or

nullOptional

health_check_urlany ofOptional

stringOptional

or

nullOptional

model_version_idany ofOptional

string · uuidOptional

or

nullOptional

pipeline_run_idany ofOptional

string · uuidOptional

or

nullOptional

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/services HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 614

{
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "project": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "service_type": {
    "type": "text",
    "flavor": "text",
    "name": "text",
    "description": "text",
    "logo_url": "text"
  },
  "service_source": "text",
  "admin_state": "inactive",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "endpoint": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "prediction_url": "text",
  "health_check_url": "text",
  "model_version_id": "123e4567-e89b-12d3-a456-426614174000",
  "pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "service_type": {
      "type": "text",
      "flavor": "text",
      "name": "text",
      "description": "text",
      "logo_url": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "state": "inactive"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "service_source": "text",
    "admin_state": "inactive",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "endpoint": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "prediction_url": "text",
    "health_check_url": "text"
  },
  "resources": {
    "pipeline_run": {
      "body": "[Circular Reference]",
      "metadata": "[Circular Reference]",
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "model_version": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "stage": "text",
        "number": 1,
        "model": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "user": {
              "body": {
                "created": "2025-04-26T17:46:46.324Z",
                "updated": "2025-04-26T17:46:46.324Z",
                "active": true,
                "activation_token": "text",
                "full_name": "text",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "metadata": {
                "email": "text",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "tags": [
              {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "user": {
                    "body": {
                      "created": "2025-04-26T17:46:46.324Z",
                      "updated": "2025-04-26T17:46:46.324Z",
                      "active": true,
                      "activation_token": "text",
                      "full_name": "text",
                      "email_opted_in": true,
                      "is_service_account": true,
                      "is_admin": true,
                      "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                    },
                    "metadata": {
                      "email": "text",
                      "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                      "user_metadata": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      }
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  },
                  "color": "grey",
                  "exclusive": true,
                  "tagged_count": 1
                },
                "metadata": {},
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              }
            ],
            "latest_version_name": "text",
            "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "project": {
              "body": {
                "created": "2025-04-26T17:46:46.324Z",
                "updated": "2025-04-26T17:46:46.324Z",
                "display_name": "text"
              },
              "metadata": {
                "description": "text"
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "save_models_to_registry": true
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "model_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "data_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "deployment_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "pipeline_run_ids": {
          "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
        },
        "tags": [
          {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "user": {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "email": "text",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "color": "grey",
              "exclusive": true,
              "tagged_count": 1
            },
            "metadata": {},
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          }
        ]
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "description": "text",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Get Service

get

Gets a specific service using its unique ID.

Args: service_id: The ID of the service to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: A specific service object.

Authorizations

Path parameters

service_idstring · uuidRequired

Query parameters

hydratebooleanOptionalDefault: true

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/services/{service_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "service_type": {
      "type": "text",
      "flavor": "text",
      "name": "text",
      "description": "text",
      "logo_url": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "state": "inactive"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "service_source": "text",
    "admin_state": "inactive",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "endpoint": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "prediction_url": "text",
    "health_check_url": "text"
  },
  "resources": {
    "pipeline_run": {
      "body": "[Circular Reference]",
      "metadata": "[Circular Reference]",
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "model_version": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "stage": "text",
        "number": 1,
        "model": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "user": {
              "body": {
                "created": "2025-04-26T17:46:46.324Z",
                "updated": "2025-04-26T17:46:46.324Z",
                "active": true,
                "activation_token": "text",
                "full_name": "text",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "metadata": {
                "email": "text",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "tags": [
              {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "user": {
                    "body": {
                      "created": "2025-04-26T17:46:46.324Z",
                      "updated": "2025-04-26T17:46:46.324Z",
                      "active": true,
                      "activation_token": "text",
                      "full_name": "text",
                      "email_opted_in": true,
                      "is_service_account": true,
                      "is_admin": true,
                      "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                    },
                    "metadata": {
                      "email": "text",
                      "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                      "user_metadata": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      }
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  },
                  "color": "grey",
                  "exclusive": true,
                  "tagged_count": 1
                },
                "metadata": {},
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              }
            ],
            "latest_version_name": "text",
            "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "project": {
              "body": {
                "created": "2025-04-26T17:46:46.324Z",
                "updated": "2025-04-26T17:46:46.324Z",
                "display_name": "text"
              },
              "metadata": {
                "description": "text"
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "save_models_to_registry": true
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "model_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "data_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "deployment_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "pipeline_run_ids": {
          "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
        },
        "tags": [
          {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "user": {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "email": "text",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "color": "grey",
              "exclusive": true,
              "tagged_count": 1
            },
            "metadata": {},
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          }
        ]
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "description": "text",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Update Service

put

Updates a service.

Args: service_id: The ID of the service to update. update: The model containing the attributes to update.

Returns: The updated service object.

Authorizations

Path parameters

service_idstring · uuidRequired

Body

Update model for stack components.

nameany ofOptional

string · max: 255Optional

or

nullOptional

admin_stateany ofOptional

The administrative state of the service, e.g., ACTIVE, INACTIVE.

string · enumOptional

Possible states for the service and service endpoint.

Possible values:

or

nullOptional

service_sourceany ofOptional

The fully qualified class name of the service implementation.

stringOptional

or

nullOptional

statusany ofOptional

or

nullOptional

endpointany ofOptional

or

nullOptional

prediction_urlany ofOptional

stringOptional

or

nullOptional

health_check_urlany ofOptional

stringOptional

or

nullOptional

labelsany ofOptional

or

nullOptional

model_version_idany ofOptional

string · uuidOptional

or

nullOptional

Responses

put

HTTPcURLJavaScriptPython

PUT /api/v1/services/{service_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "name": "text",
  "admin_state": "inactive",
  "service_source": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "endpoint": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "prediction_url": "text",
  "health_check_url": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "model_version_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "service_type": {
      "type": "text",
      "flavor": "text",
      "name": "text",
      "description": "text",
      "logo_url": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "state": "inactive"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "service_source": "text",
    "admin_state": "inactive",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "endpoint": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "prediction_url": "text",
    "health_check_url": "text"
  },
  "resources": {
    "pipeline_run": {
      "body": "[Circular Reference]",
      "metadata": "[Circular Reference]",
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "model_version": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "stage": "text",
        "number": 1,
        "model": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "user": {
              "body": {
                "created": "2025-04-26T17:46:46.324Z",
                "updated": "2025-04-26T17:46:46.324Z",
                "active": true,
                "activation_token": "text",
                "full_name": "text",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "metadata": {
                "email": "text",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "tags": [
              {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "user": {
                    "body": {
                      "created": "2025-04-26T17:46:46.324Z",
                      "updated": "2025-04-26T17:46:46.324Z",
                      "active": true,
                      "activation_token": "text",
                      "full_name": "text",
                      "email_opted_in": true,
                      "is_service_account": true,
                      "is_admin": true,
                      "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                    },
                    "metadata": {
                      "email": "text",
                      "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                      "user_metadata": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      }
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  },
                  "color": "grey",
                  "exclusive": true,
                  "tagged_count": 1
                },
                "metadata": {},
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              }
            ],
            "latest_version_name": "text",
            "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "project": {
              "body": {
                "created": "2025-04-26T17:46:46.324Z",
                "updated": "2025-04-26T17:46:46.324Z",
                "display_name": "text"
              },
              "metadata": {
                "description": "text"
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "save_models_to_registry": true
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "model_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "data_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "deployment_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "pipeline_run_ids": {
          "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
        },
        "tags": [
          {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "user": {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "email": "text",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "color": "grey",
              "exclusive": true,
              "tagged_count": 1
            },
            "metadata": {},
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          }
        ]
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "description": "text",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Service

delete

Deletes a specific service.

Args: service_id: The ID of the service to delete.

Authorizations

Path parameters

service_idstring · uuidRequired

Responses

Responseany

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/services/{service_id} HTTP/1.1
Host: 
Accept: */*

No content