Skip to main content
PUT
/
v1
/
runnable
/
{id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "config_content": "<string>",
  "config_content_parsed": {
    "name": "<string>",
    "description": "<string>",
    "type": "prompt",
    "llms": [
      {
        "name": "<string>",
        "is_default": true,
        "provider": "openai",
        "model": "<string>",
        "params": {}
      }
    ],
    "inputs": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "text",
        "mime_types": [
          "<string>"
        ],
        "transforms": [
          {}
        ],
        "required": true,
        "metadata": {
          "schema": {},
          "required": true
        }
      }
    ],
    "schemas": {},
    "prompt": {
      "system": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    }
  },
  "config_content_type": "prompt",
  "config_content_sha256": "<string>",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ]
}
Update an existing runnable by its ID. You can update any field except id and account_id. When updating the configuration:
  1. Update the config_content field with the new configuration
  2. Update config_content_parsed to match the new configuration
  3. Calculate and update the config_content_sha256 field
  4. 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

id
string<uuid>
required

Body

application/json
id
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
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

tags
string[]

Optional tags for the runnable

Response

200 - application/json

Updated runnable

id
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
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

tags
string[]

Optional tags for the runnable

I