Skip to main content

Manage engines via CLI

In the previous guides we've discussed different ways to create engines and connect data to them. To help you monitor and manage these engines, Shaped also provides the following endpoints:

Each endpoint has a corresponding CLI command.

In this guide we'll go through each of these endpoints, explain how they can be used and what information you can find in the response.

List Engines​

List engines is used to view all the engines you've created and a brief explanation of their status. It can be used with the following CLI command:

shaped list-engines

Example response:

engines:
- engine_name: basic_engine
  engine_uri: https://api.shaped.ai/v2/engines/basic_engine
  created_at: 2026-02-09T22:46:21 UTC
  status: ACTIVE
  version: v2
- engine_name: basic_engine_with_embedding_models
  engine_uri: https://api.shaped.ai/v2/engines/basic_engine_with_embedding_models
  created_at: 2026-02-09T22:46:20 UTC
  status: ACTIVE
  version: v2
- engine_name: hybrid_search_engine
  engine_uri: https://api.shaped.ai/v2/engines/hybrid_search_engine
  created_at: 2026-02-09T23:04:52 UTC
  status: ACTIVE
  version: v2
- engine_name: lightgbm_engine
  engine_uri: https://api.shaped.ai/v2/engines/lightgbm_engine
  created_at: 2026-02-09T23:08:03 UTC
  status: ACTIVE
  version: v2

As you can see, the response returns a list of all the engines you've created. Each engine object has the following information:

  1. engine_name: the unique engine identifier.
  2. engine_uri: your engine's unique endpoint URI, which you use to make engine-specific requests.
  3. created_at: when the engine was initially created.
  4. status: your engine's current status.
  5. version: the engine API version (for example, v2).

View Engine​

View engine is used to retrieve a detailed view about a specific engine. As well as the data from list engines, it also returns the engine configuration and schema.

shaped view-engine --engine-name basic_engine

Example response:

engine_uri: https://api.shaped.ai/v2/engines/basic_engine
created_at: 2026-02-09T22:46:21 UTC
status: ACTIVE
config:
    version: v2
    name: basic_engine
    data:
    item_table:
        name: movielens_items # change this to your table name
        type: table
    index:
    embeddings:
        - name: content_embedding # enables vector search
        encoder:
            type: hugging_face
            model_name: sentence-transformers/all-MiniLM-L6-v2
            item_fields: # update these to your table's text columns
            - movie_title
            - description

This response includes:

  1. engine_uri, created_at, status: high-level metadata about the engine.
  2. config: the full engine configuration, including model, training, deployment, and inference settings.
  3. engine_schema: the derived schema that Shaped infers from your data.
  4. error_message: if present, any error associated with the engine.
  5. input_yaml: the original YAML used to define the engine.

Delete Engine​

The final endpoint you'll want to know is Delete Engine. This endpoint allows you to delete any of your unneeded or failing engines.

shaped delete-engine --engine-name basic_engine

Example response:

message: Engine with name 'basic_engine' is deleting...