---
title: "Run an Experiment Flow By Experiment Id."
method: POST
path: "/di/v1/experimentRun/{exp_id}"
tags: ["ExperimentRuns"]
---

# Run an Experiment Flow By Experiment Id.

`POST /di/v1/experimentRun/{exp_id}`

## Request

- Base URL: `https://di.prophecis.com`
- URL: `https://di.prophecis.com/di/v1/experimentRun/{exp_id}`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `X-Watson-Authorization-Token`
  - API key in query parameter `watson-token`
- TypeScript: <https://skmtc.dev/webankfintech/apis/prophecis-rest-service/docs/di/v1/experimentRun/:exp_id/post.ts> (a function with typed inputs; its response is checked against the schema)

Run an Experiment Flow By Experiment Id.

## Path parameters

- `exp_id` number, required

## Request body

- ProphecisExperimentRunRequest
  - `exp_exec_type` string, required: Experiment Run type, Include CLI/UI/DSS/Schedulis.
  - `flow_json` string: Experiment Run type, Include CLI/UI/DSS/Schedulis.
  - `run_date` string: Experiment Run run date.

## Response `200`

OK

- ProphecisExperimentRun
  - `id` number: Experiment Exec ID.
  - `exp_id` number, required: Experiment ID.
  - `dss_exec_id` string: linkis flow exec id.
  - `dss_flow_id` number: DSS Flow ID.
  - `dss_flow_last_version_id` number: DSS Flow Version ID.
  - `exp_exec_type` string, required: Experiment Exec Type, include CLI/UI/DSS/Schedulis.
  - `exp_exec_status` string: Experiment Exec Type, include RUNNING/SCHEDULED/FINISHED/FAILED/KILLED.
  - `exp_run_create_time` string, date-time: Created Timestamp of Experiment Exec.
  - `exp_run_end_time` string, date-time: Timestamp of Experiment finished.
  - `exp_run_create_user_id` number: User of experiment exec.
  - `exp_run_modify_user_id` number: User of modify experiment exec.
  - `experiment` ProphecisExperiment
    - `id` number: Experiment id.
    - `exp_name` string, required: Experiment Name.
    - `group_name` string: Experiment Name.
    - `mlflow_exp_id` string: MLFlow Experiment ID.
    - `exp_desc` string, required: Experiment Description.
    - `dss_project_id` number: DSS Project ID.
    - `dss_project_version_id` number: DSS Project Version.
    - `dss_bml_last_version` string: DSS Flow BML Version
    - `dss_workspace_id` number: DSS Workspace ID.
    - `dss_flow_id` number: DSS Flow ID.
    - `create_type` string: Create Type.
    - `dss_dss_project_id` number: DSS DSS Project Id
    - `dss_dss_project_name` string: DSS DSS Project Name
    - `dss_dss_flow_version` string: DSS DSS Flow Version
    - `dss_dss_flow_name` string: DSS DSS Flow Name
    - `dss_dss_flow_project_version_id` string: DSS DSS Flow Project Version Id
    - `exp_create_time` string, date-time: Timestamp of experiment create.
    - `exp_modify_time` string, date-time: Timestamp of experiment modify.
    - `exp_create_user_id` number: User of experiment creator.
    - `exp_modify_user_id` number: User of last experiment modifier.
    - `create_user` User
      - `id` number, required: Flag of Delete.
      - `Name` string: Flag of Delete.
      - `Remarks` string: Flag of Delete.
    - `modify_user` User
      - `id` number, required: Flag of Delete.
      - `Name` string: Flag of Delete.
      - `Remarks` string: Flag of Delete.
    - `tag_list` ProphecisExperimentTag[]
      - `id` number: Experiment Tag ID.
      - `exp_id` number: Experiment ID.
      - `exp_tag` string, required: Experiment Tag Name.
      - `exp_tag_create_time` string, date-time: Timestamp recorded when this Experiment Tag was created.
      - `exp_tag_create_user_id` integer: Creator recorded when this Experiment Tag was created.
      - `enable_flag` string: Flag of Delete.
    - `enable_flag` string: Flag of Delete.
  - `user` User
    - `id` number, required: Flag of Delete.
    - `Name` string: Flag of Delete.
    - `Remarks` string: Flag of Delete.
  - `enable_flag` string: Flag of Delete.

## Other responses

- `401`: Unauthorized
- `404`: The Models cannot be found

## Changes

- **2022-04-06** `8d1177afef44`: 1 info
  - endpoint added
- **2021-03-12** `c4815b4021b4`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/webankfintech/apis/prophecis-rest-service/changes/di/v1/experimentRun/:exp_id/post.md)

---

[API](https://skmtc.dev/webankfintech/apis/prophecis-rest-service.md) - [All operations](https://skmtc.dev/webankfintech/apis/prophecis-rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/webankfintech/apis/prophecis-rest-service/revisions/41a1038b5854?raw)