Update Workbench Setup
curl --request PATCH \
--url https://api.bland.ai/v1/evals/workbench-setups/{setup_id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"name": "<string>",
"description": {},
"active_version_id": {},
"metadata": {}
}
'{
"errors": null,
"data": {
"setup": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"org_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"key": "onboarding-quality-check",
"name": "Onboarding Quality Check v2",
"description": "Updated evaluation suite for Q2 onboarding calls.",
"current_version_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"active_version_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"metadata": {
"team": "cx"
},
"created_at": "2026-03-15T08:00:00.000Z",
"updated_at": "2026-05-27T11:30:00.000Z",
"deleted_at": null
},
"current_version": {
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"org_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"workbench_setup_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"version_number": 4,
"name": "Onboarding Quality Check v2",
"description": "Updated evaluation suite for Q2 onboarding calls.",
"state": "editable",
"attached_agents": [
{
"eval_agent_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
"eval_agent_version_id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
"weight": 50,
"target_level_keys": ["good", "excellent"]
}
],
"pass_threshold_pct": 80,
"run_mode": "audio",
"default_test_config_id": null,
"default_call_ids": [],
"created_from_version_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"created_by": "9a8b7c6d-5e4f-3210-9876-543210fedcba",
"created_at": "2026-05-20T14:00:00.000Z",
"updated_at": "2026-05-27T11:30:00.000Z"
}
}
}
Workbench Setups
Update Workbench Setup
Update a workbench setup’s metadata or repoint its active version.
PATCH
/
v1
/
evals
/
workbench-setups
/
{setup_id}
Update Workbench Setup
curl --request PATCH \
--url https://api.bland.ai/v1/evals/workbench-setups/{setup_id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"name": "<string>",
"description": {},
"active_version_id": {},
"metadata": {}
}
'{
"errors": null,
"data": {
"setup": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"org_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"key": "onboarding-quality-check",
"name": "Onboarding Quality Check v2",
"description": "Updated evaluation suite for Q2 onboarding calls.",
"current_version_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"active_version_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"metadata": {
"team": "cx"
},
"created_at": "2026-03-15T08:00:00.000Z",
"updated_at": "2026-05-27T11:30:00.000Z",
"deleted_at": null
},
"current_version": {
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"org_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"workbench_setup_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"version_number": 4,
"name": "Onboarding Quality Check v2",
"description": "Updated evaluation suite for Q2 onboarding calls.",
"state": "editable",
"attached_agents": [
{
"eval_agent_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
"eval_agent_version_id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
"weight": 50,
"target_level_keys": ["good", "excellent"]
}
],
"pass_threshold_pct": 80,
"run_mode": "audio",
"default_test_config_id": null,
"default_call_ids": [],
"created_from_version_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"created_by": "9a8b7c6d-5e4f-3210-9876-543210fedcba",
"created_at": "2026-05-20T14:00:00.000Z",
"updated_at": "2026-05-27T11:30:00.000Z"
}
}
}
Documentation Index
Fetch the complete documentation index at: https://docs.bland.ai/llms.txt
Use this file to discover all available pages before exploring further.
This endpoint updates setup-level fields only. To edit attached agents, the pass threshold, or run mode, update the setup’s draft version using the Update Workbench Setup Version endpoint.
Headers
Your API key for authentication.
Path Parameters
The ID of the workbench setup to update.
Body Parameters
All fields are optional. Only include fields you want to update.Updated display name for the setup. Between 1 and 200 characters.
Updated description, or
null to clear it.Repoint the published version to a different archived version ID. Set to
null to unpublish the setup.Key-value metadata to associate with the setup. Values must be strings.
Response
An object containing the updated setup and its current draft version.
Show setup
Show setup
Unique identifier for the workbench setup.
ID of the organization that owns this setup.
Stable slug key for the setup.
Display name of the setup.
Description of the setup, or
null if not set.ID of the current editable draft version.
ID of the published version, or
null if unpublished.Key-value metadata. Values are strings.
ISO 8601 timestamp for when the setup was created.
ISO 8601 timestamp for when the setup was last updated.
ISO 8601 timestamp for when the setup was deleted, or
null if not deleted.Show current_version
Show current_version
Unique identifier for this version.
ID of the organization that owns this version.
ID of the parent workbench setup.
Monotonically increasing version number.
Display name of this version.
Description of this version, or
null if not set."editable" for a draft, "archived" for a published snapshot.Eval agents attached to this version. Each item contains
eval_agent_id, eval_agent_version_id, weight (0-100), and target_level_keys (array of strings).Percentage of calls that must pass for a run to be considered passing (0-100), or
null if not set.How calls are evaluated. One of
text, audio, or full.ID of the default test configuration, or
null if not set.Default call IDs to evaluate against. Up to 5000 entries.
ID of the version this was forked from, or
null if it is the first version.Identifier of the user who created this version, or
null.ISO 8601 timestamp for when this version was created.
ISO 8601 timestamp for when this version was last updated.
null on success.{
"errors": null,
"data": {
"setup": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"org_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"key": "onboarding-quality-check",
"name": "Onboarding Quality Check v2",
"description": "Updated evaluation suite for Q2 onboarding calls.",
"current_version_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"active_version_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"metadata": {
"team": "cx"
},
"created_at": "2026-03-15T08:00:00.000Z",
"updated_at": "2026-05-27T11:30:00.000Z",
"deleted_at": null
},
"current_version": {
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"org_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"workbench_setup_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"version_number": 4,
"name": "Onboarding Quality Check v2",
"description": "Updated evaluation suite for Q2 onboarding calls.",
"state": "editable",
"attached_agents": [
{
"eval_agent_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
"eval_agent_version_id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
"weight": 50,
"target_level_keys": ["good", "excellent"]
}
],
"pass_threshold_pct": 80,
"run_mode": "audio",
"default_test_config_id": null,
"default_call_ids": [],
"created_from_version_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"created_by": "9a8b7c6d-5e4f-3210-9876-543210fedcba",
"created_at": "2026-05-20T14:00:00.000Z",
"updated_at": "2026-05-27T11:30:00.000Z"
}
}
}
Was this page helpful?
⌘I