Product
Resources
GitHubStart free

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
hydrateboolean · default: falseoptional
sort_bystring · default: "created"optional
logical_operatorall of · default: "and"optional

Logical Ops to use to combine filters on list methods.

pageinteger · min: 1 · default: 1optional
sizeinteger · min: 1 · max: 10000 · default: 20optional
idany ofoptional

createdany ofoptional

updatedany ofoptional

scope_userany ofoptional

userany ofoptional

projectany ofoptional

nameany ofoptional

typeany ofoptional

flavorany ofoptional

configany ofoptional

pipeline_nameany ofoptional

pipeline_step_nameany ofoptional

runningany ofoptional

model_version_idany ofoptional

pipeline_run_idany ofoptional

Responses
curl -L \
  --url '/api/v1/services'
{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "user": {
          "body": {
            "created": "2025-03-28T18:36:17.232Z",
            "updated": "2025-03-28T18:36:17.232Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {}
          },
          "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-03-28T18:36:17.232Z",
            "updated": "2025-03-28T18:36:17.232Z",
            "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": {},
        "status": {},
        "endpoint": {},
        "prediction_url": "text",
        "health_check_url": "text"
      },
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Successful Response

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

Body
userany ofoptional

projectstring · uuidrequired
namestring · max: 255required
service_typeall ofrequired

Service type descriptor.

Attributes: type: service type flavor: service flavor name: name of the service type description: description of the service type logo_url: logo of the service type

service_sourceany ofoptional

The fully qualified class name of the service implementation.

admin_stateany ofoptional

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

Possible states for the service and service endpoint.

configobjectrequired

A dictionary containing configuration parameters for the service.

labelsany ofoptional

statusany ofoptional

endpointany ofoptional

prediction_urlany ofoptional

health_check_urlany ofoptional

model_version_idany ofoptional

pipeline_run_idany ofoptional

Responses
curl -L \
  --request POST \
  --url '/api/v1/services' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {},
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "status": {},
    "endpoint": {},
    "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-03-28T18:36:17.232Z",
    "updated": "2025-03-28T18:36:17.232Z",
    "user": {
      "body": {
        "created": "2025-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {}
      },
      "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-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "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": {},
    "status": {},
    "endpoint": {},
    "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"
}

Successful Response

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
hydrateboolean · default: trueoptional
Responses
curl -L \
  --url '/api/v1/services/{service_id}'
{
  "body": {
    "created": "2025-03-28T18:36:17.232Z",
    "updated": "2025-03-28T18:36:17.232Z",
    "user": {
      "body": {
        "created": "2025-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {}
      },
      "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-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "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": {},
    "status": {},
    "endpoint": {},
    "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"
}

Successful Response

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
nameany ofoptional

admin_stateany ofoptional

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

Possible states for the service and service endpoint.

service_sourceany ofoptional

The fully qualified class name of the service implementation.

statusany ofoptional

endpointany ofoptional

prediction_urlany ofoptional

health_check_urlany ofoptional

labelsany ofoptional

model_version_idany ofoptional

Responses
curl -L \
  --request PUT \
  --url '/api/v1/services/{service_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "admin_state": "inactive",
    "service_source": "text",
    "status": {},
    "endpoint": {},
    "prediction_url": "text",
    "health_check_url": "text",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "model_version_id": "123e4567-e89b-12d3-a456-426614174000"
  }'
{
  "body": {
    "created": "2025-03-28T18:36:17.232Z",
    "updated": "2025-03-28T18:36:17.232Z",
    "user": {
      "body": {
        "created": "2025-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {}
      },
      "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-03-28T18:36:17.232Z",
        "updated": "2025-03-28T18:36:17.232Z",
        "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": {},
    "status": {},
    "endpoint": {},
    "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"
}

Successful Response

Delete Service

delete

Deletes a specific service.

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

Authorizations
Path parameters
service_idstring · uuidrequired
Responses
curl -L \
  --request DELETE \
  --url '/api/v1/services/{service_id}'
No body

Successful Response

PreviousFull stack resourcesNextStacks

Last updated

Was this helpful?