Update Runnable - re-factor.ai

Update a runnable

curl --request PUT \
  --url https://api.example.com/v1/runnable/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "<string>",
  "name": "<string>",
  "config_content": "<string>",
  "config_content_parsed": {
    "name": "<string>",
    "type": "prompt",
    "prompt": {
      "system": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    },
    "description": "<string>",
    "llms": [
      {
        "name": "<string>",
        "provider": "openai",
        "model": "<string>",
        "is_default": true,
        "params": {}
      }
    ],
    "inputs": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "text",
        "mime_types": [
          "*/*"
        ],
        "transforms": [],
        "required": true,
        "metadata": {
          "schema": {},
          "required": false
        }
      }
    ],
    "schemas": {}
  },
  "config_content_type": "prompt",
  "config_content_sha256": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_by": "<string>",
  "tags": [
    "<string>"
  ]
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "<string>",
  "name": "<string>",
  "config_content": "<string>",
  "config_content_parsed": {
    "name": "<string>",
    "type": "prompt",
    "prompt": {
      "system": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    },
    "description": "<string>",
    "llms": [
      {
        "name": "<string>",
        "provider": "openai",
        "model": "<string>",
        "is_default": true,
        "params": {}
      }
    ],
    "inputs": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "text",
        "mime_types": [
          "*/*"
        ],
        "transforms": [],
        "required": true,
        "metadata": {
          "schema": {},
          "required": false
        }
      }
    ],
    "schemas": {}
  },
  "config_content_type": "prompt",
  "config_content_sha256": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_by": "<string>",
  "tags": [
    "<string>"
  ]
}

PUT

runnable

{id}

Update a runnable

curl --request PUT \
  --url https://api.example.com/v1/runnable/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "<string>",
  "name": "<string>",
  "config_content": "<string>",
  "config_content_parsed": {
    "name": "<string>",
    "type": "prompt",
    "prompt": {
      "system": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    },
    "description": "<string>",
    "llms": [
      {
        "name": "<string>",
        "provider": "openai",
        "model": "<string>",
        "is_default": true,
        "params": {}
      }
    ],
    "inputs": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "text",
        "mime_types": [
          "*/*"
        ],
        "transforms": [],
        "required": true,
        "metadata": {
          "schema": {},
          "required": false
        }
      }
    ],
    "schemas": {}
  },
  "config_content_type": "prompt",
  "config_content_sha256": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_by": "<string>",
  "tags": [
    "<string>"
  ]
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "<string>",
  "name": "<string>",
  "config_content": "<string>",
  "config_content_parsed": {
    "name": "<string>",
    "type": "prompt",
    "prompt": {
      "system": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    },
    "description": "<string>",
    "llms": [
      {
        "name": "<string>",
        "provider": "openai",
        "model": "<string>",
        "is_default": true,
        "params": {}
      }
    ],
    "inputs": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "text",
        "mime_types": [
          "*/*"
        ],
        "transforms": [],
        "required": true,
        "metadata": {
          "schema": {},
          "required": false
        }
      }
    ],
    "schemas": {}
  },
  "config_content_type": "prompt",
  "config_content_sha256": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_by": "<string>",
  "tags": [
    "<string>"
  ]
}

Update an existing runnable by its ID. You can update any field except id and account_id. When updating the configuration:

Update the config_content field with the new configuration
Update config_content_parsed to match the new configuration
Calculate and update the config_content_sha256 field
Ensure the config_content_type matches the type of configuration being provided

The runnable type (prompt, flow, or agent) cannot be changed after creation.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Body

application/json

string<uuid>

required

The unique identifier for the runnable

account_id

string

required

The account ID that owns this runnable

name

string

required

The name of the runnable

config_content

string

required

The raw configuration content

config_content_parsed

object

required

The parsed configuration content

Option 1
Option 2
Option 3

Show child attributes

config_content_type

enum<string>

required

The type of runnable configuration

Available options:

prompt,

flow,

agent

config_content_sha256

string

required

SHA256 hash of the configuration content

created_at

string<date-time>

required

When the runnable was created

updated_at

string<date-time>

required

When the runnable was last updated

description

string

Optional description of the runnable

created_by

string

The ID of the user who created this runnable

Response

200 - application/json

Updated runnable

string<uuid>

required

The unique identifier for the runnable

account_id

string

required

The account ID that owns this runnable

name

string

required

The name of the runnable

config_content

string

required

The raw configuration content

config_content_parsed

object

required

The parsed configuration content

Option 1
Option 2
Option 3

Show child attributes

config_content_type

enum<string>

required

The type of runnable configuration

Available options:

prompt,

flow,

agent

config_content_sha256

string

required

SHA256 hash of the configuration content

created_at

string<date-time>

required

When the runnable was created

updated_at

string<date-time>

required

When the runnable was last updated

description

string

Optional description of the runnable

created_by

string

The ID of the user who created this runnable

API Endpoints

Authorizations

Path Parameters

Body

Response