Skip to main content
POST
/
workflows
/
v1
/
workflows
/
{workflow_id}
/
versions
/
{version_number}
/
activate
Set Active Workflow Version
curl --request POST \
  --url https://api-qa.interactly.ai/workflows/v1/workflows/{workflow_id}/versions/{version_number}/activate \
  --header 'Authorization: Bearer <token>'
{
  "workflow": {
    "team_id": "<string>",
    "created_by": "<string>",
    "updated_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "workflow_config": {
      "logical_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "llms_config": {
        "logical_id": "llm_b964e4be-0097-472c-b7a8-337f6148e3cd",
        "provider": "default_provider",
        "streaming": false,
        "model_kwargs": {},
        "do_not_split_sentences": false,
        "type": "global_default_llm"
      },
      "main_response_config": {
        "prompt": "<string>"
      },
      "backchannel_response_config": {
        "prompt": "<string>"
      },
      "default_prompt_prefix": "<string>",
      "default_prompt_suffix": "<string>",
      "tools_config": {
        "tools": [
          {
            "logical_id": "<string>",
            "tool_id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "category": "<string>",
            "signature": "<string>",
            "args_schema": {},
            "static_messages_config": {
              "static_messages": [
                "<string>"
              ],
              "static_messages_selection_mode": "random"
            },
            "result_runtime_variable_name": "tool_result",
            "type": "inline_python",
            "code": "<string>"
          }
        ]
      },
      "nodes": [
        "<string>"
      ],
      "edges": [
        "<string>"
      ],
      "evaluation_config": {
        "evaluator_workflow_id": "<string>",
        "evaluator_workflow_version_number": 123,
        "enable_turn_by_turn_evaluation": false
      },
      "miscellaneous": {}
    },
    "active_version_number": 0
  }
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

workflow_id
string
required
Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

version_number
integer
required

Response

Successful Response

Response model for a single workflow. Contains a WorkflowsModel object.

workflow
WorkflowsModel · object
required

Single workflow object