> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# Get AutomationStep by ID

GET https://{tenant_name}.benchling.com/api/v3/automation-step/{automation_step_id}

Get a single AutomationStep by ID.

Reference: https://docs.benchling.com/docs/api/benchling-api/automation-step/get

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `automation_step_id` (string, required) — ID of the AutomationStep.

### Query parameters

- `returning` (string, optional) — Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
- `omit` (string, optional) — Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

### Headers

- `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3.

## Response

### 200

OK

- `__typename` (string, optional)
- `config` (map from string to any, optional, nullable)
- `createdAt` (string, optional)
- `id` (string, optional)
- `inputStepDatas` (string, optional)
- `modifiedAt` (string, optional)
- `outputStepDatas` (string, optional)
- `pipeline` (PipelineRef, optional)
- `statusCode` (enum, optional)
  - Allowed values: `AI_PROPOSED`, `BLOCKED`, `FAILED`, `HALTED`, `RUNNING`, `SUCCEEDED`, `WAITING`
- `statusMessage` (string, optional, nullable)
- `stepType` (enum, optional)
  - Allowed values: `AGGREGATE_DATASET`, `AUTOFILL_ANTIBODY_ELEMENT_SUBELEMENTS`, `ANNOTATE_ANTIBODY_INPUTS`, `ANOVA`, `APPLY_COLUMN_MAPPING`, `BIN_DATA`, `BOLTZ2`, `BOLTZGEN`, `BOLTZGEN_SUCCESS`, `BULK_IMPORT`, `CHAI1`, `CHART_VIEW`, `COMPUTED_COLUMN`, `CONCATENATE_ANTIBODY_COMPONENT_DOMAINS_TO_CHAINS`, `CONNECTION_DATA_DATASET`, `CONVERT_ASM_TO_CSV`, `CONVERT_FILE_TO_DATASET_WITH_DATA_ENTRY_ASSISTANT`, `CONVERT_JSON_TO_DATASET`, `CONVERT_OPENFOLD2_OUTPUT`, `CONVERT_OPENFOLD3_OUTPUT`, `CONVERT_TO_ASM`, `CREATE_DATASET_FROM_FILE`, `CREATE_ENTITIES`, `CREATE_METERING_USAGE_CHART`, `CREATE_PROCEDURE_DATASET`, `DATA_CATALOG_DATASET`, `DATA_CATALOG_FILE`, `DATA_CATALOG_FILES`, `DATASETS_TO_PLATES`, `DATASET_VIEW`, `DEFINE_TEMPLATE_VARIABLES`, `EXPERIMENT_OPTIMIZATION_BOOTSTRAP`, `EXPERIMENT_OPTIMIZATION_CLEAN_DATA`, `EXPERIMENT_OPTIMIZATION_EXPLANATION`, `EXPERIMENT_OPTIMIZATION_GENERATE_SEARCH_SPACE`, `EXPERIMENT_OPTIMIZATION_POSTERIOR_SUMMARY`, `EXPERIMENT_OPTIMIZATION_RECOMMENDATION`, `EXPERIMENT_OPTIMIZATION_TRAINING`, `EXPLORATORY_DATA_ANALYSIS`, `EXPORT_DATA_CATALOG_DATASET`, `EXPORT_DATA_CATALOG_FILE`, `EXTRACT_DATA_FRAME_VALUE`, `EXTRACT_OR_REMOVE_LINES`, `FILL_PLATE`, `FILTER_DATASET`, `FIND_AND_REPLACE`, `FLAG_ROWS`, `FORMAT_COLUMNS`, `GENERATE_ANALYSIS_VIEW_URL`, `GENERATE_BOLTZGEN_YAML`, `GENERATE_BOLTZ_YAML`, `GENERATE_FASTA`, `GENERATE_MODEL_RUN_INPUT`, `GENERATE_OPENFOLD2_JSON`, `GENERATE_OPENFOLD3_JSON`, `HIDE_COLUMNS`, `IMPORT_PLATES`, `IMPORT_SCRATCH_FILE`, `INITIALIZE_DATASET`, `INSERT_RESULT_URL_IN_DOCUMENT`, `INTERPOLATE_MARKDOWN`, `JOIN`, `LAYOUT`, `LEGACY_DATA_IMPORT_ENTRY_CREATION`, `LEGACY_DATA_IMPORT_INITIATION`, `LEGACY_DATA_IMPORT_TRANSCRIPTION`, `LOOK_UP`, `MAP_COLUMNS`, `MAP_JSON_TO_DATASETS_AND_FILES`, `MODEL_RUN_INFERENCE`, `MOVE_INVENTORY_PLATES`, `COMPUTE_NDC_ENTITY_MERGED_COLUMNS`, `NDC_CREATE_PROTEINS_FROM_DATASET`, `NDC_COMBINE_DOMAINS_TO_VARIABLE_PAIRS`, `NDC_EXPAND_VARIABLE_PAIRS_TO_DOMAINS`, `NDC_REFERENCE_EXISTING_COMPONENTS`, `NOTEBOOK_TABLE_DATASET`, `OPENFOLD2`, `OPENFOLD3`, `PARAMETER_OPTIMIZATION_CONFIGURATION`, `PARAMETER_OPTIMIZATION_DATASET_CONFIGURATION`, `PARAMETER_OPTIMIZATION_MODELING`, `PARAMETER_OPTIMIZATION_PREDICTION`, `PIVOT_DATASET`, `PLATE_SCHEMA_DATASET`, `PLATES_TO_DATASETS`, `POSTPROCESS_MODEL_RUN`, `PROCEDURE_RUN_DATA_FRAMES`, `PROMOTE_DATASET`, `REGISTRY_SCHEMA_DATASET`, `PUT_PLATES_IN_INVENTORY`, `REGRESSION`, `REGRESSION_INTERPOLATION`, `RENAME_COLUMNS`, `REORDER_COLUMNS`, `RETYPE_COLUMNS`, `RUN_BENCHLING_BOLTZGEN`, `RUN_HAMILTON_METHOD`, `RUN_HIGHRES_PROTOCOL`, `RUN_OPENTRONS_PROTOCOL`, `RUN_SCIENTIFIC_MODEL`, `RUN_TECAN_METHOD`, `SAVE_STRUCTURE_PREDICTION`, `SAVE_TO_RESULTS`, `SEND_TO_CONNECTION`, `SEND_TO_DOCUMENT`, `SEND_USER_NOTIFICATION`, `SORT_COLUMNS`, `STATIC_TEMPLATE_INPUT_TABLE`, `TABLE_VIEW`, `TEMPLATE_INPUT`, `TEST_ALL_CONFIGS`, `THIRD_PARTY`, `TRANSFER_PLATES`, `TRANSFORM_PROTEIN_BULK_INGEST_OUTPUT_TO_DATASET`, `TRANSLATE_ANTIBODY_COMPONENT_DNA_TO_AA`, `T_TEST`, `UNION_DATASETS`, `UNPIVOT_DATASET`, `UPDATE_ENTITIES`, `UPDATE_INVENTORY_PLATES`, `UPLOAD_CSV_DATASET`, `USER_DEFINED_FUNCTION`, `GENERATE_NDC_ERROR_CSV`, `VALIDATE_AND_TRANSFORM_ANTIBODY_INPUTS`, `VARIABLE_TEMPLATE_INPUT_TABLE`, `WAREHOUSE_SQL_DATASET`, `WINDOW_FUNCTIONS`
- `stepVersion` (integer, optional)

## Errors

### 400 Automation Step Get Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Automation Step Get Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Automation Step Get Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Automation Step Get Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 500 Automation Step Get Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### PipelineRef

- `__typename` (string, optional)
- `id` (string, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

## Examples

**Response**

```json
{
  "__typename": "__typename",
  "config": {
    "key": "value"
  },
  "createdAt": "createdAt",
  "id": "id",
  "inputStepDatas": "inputStepDatas",
  "modifiedAt": "modifiedAt",
  "outputStepDatas": "outputStepDatas",
  "pipeline": {
    "__typename": "__typename",
    "id": "id"
  },
  "statusCode": "AI_PROPOSED",
  "statusMessage": "statusMessage",
  "stepType": "AGGREGATE_DATASET",
  "stepVersion": 1
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/automation-step/automation_step_id"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/automation-step/automation_step_id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```