Roark · Schema

ConfigBundle

CompanyVoice AITestingEvaluationBenchmarking

Properties

Name Type Description
resources array
prune boolean
View JSON Schema on GitHub

JSON Schema

roark-config-bundle-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/roark/json-schema/roark-config-bundle-schema.json",
  "title": "ConfigBundle",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/roark-config-api-openapi.yml#/components/schemas/ConfigBundle",
  "type": "object",
  "properties": {
    "resources": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "anyOf": [
              {
                "$ref": "#/$defs/AgentConfig"
              },
              {
                "$ref": "#/$defs/HttpRequestDefinitionConfig"
              },
              {
                "$ref": "#/$defs/PersonaConfig"
              },
              {
                "$ref": "#/$defs/ImprovFlowConfig"
              },
              {
                "$ref": "#/$defs/ScriptedFlowConfig"
              },
              {
                "$ref": "#/$defs/CollectorConfig"
              },
              {
                "$ref": "#/$defs/MetricConfig"
              },
              {
                "$ref": "#/$defs/ApiCheckMetricConfig"
              },
              {
                "$ref": "#/$defs/SimulationPlanConfig"
              },
              {
                "$ref": "#/$defs/QaSimulationPlanConfig"
              },
              {
                "$ref": "#/$defs/SimulationGroupConfig"
              },
              {
                "$ref": "#/$defs/AlertConfig"
              },
              {
                "$ref": "#/$defs/ToolConfig"
              },
              {
                "$ref": "#/$defs/DashboardConfig"
              }
            ]
          },
          {
            "$ref": "#/$defs/ProjectConfig"
          }
        ]
      }
    },
    "prune": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "resources"
  ],
  "$defs": {
    "AgentConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "agent"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "displayName": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "customId": {
          "type": [
            "string",
            "null"
          ]
        },
        "endpoints": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "minLength": 1
              },
              "type": {
                "type": "string",
                "enum": [
                  "PHONE",
                  "WEBSOCKET"
                ],
                "default": "PHONE"
              },
              "direction": {
                "type": "string",
                "enum": [
                  "INCOMING",
                  "OUTGOING",
                  "INCOMING_AND_OUTGOING"
                ],
                "default": "INCOMING"
              },
              "environment": {
                "type": "string"
              },
              "outboundDialType": {
                "type": "string",
                "enum": [
                  "NONE",
                  "HTTP_REQUEST"
                ],
                "default": "NONE"
              },
              "outboundDialHttpRequestDefinition": {
                "type": "string",
                "pattern": "^[a-z0-9][a-z0-9-_.]*$",
                "minLength": 1
              }
            },
            "required": [
              "value"
            ]
          }
        },
        "prompt": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "kind",
        "name"
      ]
    },
    "AlertActions": {
      "type": "object",
      "properties": {
        "slack": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AlertSlackChannel"
          }
        },
        "webhooks": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "AlertConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "alert"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "displayName": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "trigger": {
          "oneOf": [
            {
              "$ref": "#/$defs/AlertThresholdTrigger"
            },
            {
              "$ref": "#/$defs/AlertEventTrigger"
            },
            {
              "$ref": "#/$defs/AlertSimulationTrigger"
            }
          ]
        },
        "actions": {
          "$ref": "#/$defs/AlertActions"
        }
      },
      "required": [
        "kind",
        "name",
        "trigger"
      ]
    },
    "AlertEventTrigger": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "event"
        },
        "events": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "CALL_ANALYSIS_COMPLETED",
              "CALL_ANALYSIS_FAILED",
              "CALL_ANALYSIS_CANCELLED",
              "SIMULATION_RUN_PLAN_JOB_STARTED",
              "SIMULATION_RUN_PLAN_JOB_COMPLETED",
              "SIMULATION_RUN_PLAN_JOB_FAILED",
              "SIMULATION_RUN_PLAN_JOB_CANCELLED",
              "SIMULATION_JOB_STARTED",
              "SIMULATION_JOB_COMPLETED",
              "SIMULATION_JOB_FAILED",
              "SIMULATION_JOB_CANCELLED",
              "METRIC_COLLECTION_JOB_COMPLETED",
              "METRIC_COLLECTION_JOB_FAILED",
              "CHAT_ANALYSIS_COMPLETED",
              "CHAT_ANALYSIS_FAILED",
              "ISSUE_OPENED",
              "ISSUE_RESOLVED"
            ]
          },
          "minItems": 1
        }
      },
      "required": [
        "type",
        "events"
      ]
    },
    "AlertSimulationTrigger": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "simulation"
        },
        "conditions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "FAILURE",
              "THRESHOLD_FAILED"
            ]
          },
          "minItems": 1
        },
        "plan": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "deliveryFormat": {
          "type": "string",
          "enum": [
            "MESSAGE",
            "PDF"
          ],
          "default": "MESSAGE"
        }
      },
      "required": [
        "type",
        "conditions"
      ]
    },
    "AlertSlackChannel": {
      "type": "object",
      "properties": {
        "channelId": {
          "type": "string",
          "minLength": 1
        },
        "channelName": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "channelId",
        "channelName"
      ]
    },
    "AlertThresholdTrigger": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "threshold"
        },
        "metric": {
          "type": "string",
          "minLength": 1
        },
        "metricVariant": {
          "type": "string",
          "minLength": 1
        },
        "aggregation": {
          "type": "string",
          "enum": [
            "COUNT",
            "RATE_PER_MINUTE",
            "MEAN"
          ]
        },
        "windowMinutes": {
          "type": "integer",
          "exclusiveMinimum": 0
        },
        "operator": {
          "type": "string",
          "enum": [
            "GT",
            "GTE",
            "LT",
            "LTE"
          ]
        },
        "thresholdValue": {
          "type": "number"
        },
        "grouping": {
          "type": "string",
          "enum": [
            "NONE",
            "BY_AGENT"
          ],
          "default": "NONE"
        },
        "minSampleSize": {
          "type": "integer",
          "minimum": 1,
          "default": 1
        },
        "consecutiveOpen": {
          "type": "integer",
          "minimum": 1,
          "default": 2
        },
        "consecutiveResolve": {
          "type": "integer",
          "minimum": 1,
          "default": 3
        }
      },
      "required": [
        "type",
        "metric",
        "aggregation",
        "windowMinutes",
        "operator",
        "thresholdValue"
      ]
    },
    "ApiCheckMetricConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "metric"
        },
        "calculationType": {
          "type": "string",
          "const": "HTTP_REQUEST"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "httpRequest": {
          "$ref": "#/$defs/ApiCheckRequestConfig"
        },
        "trueLabel": {
          "type": "string"
        },
        "falseLabel": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "calculationType",
        "name",
        "httpRequest"
      ]
    },
    "ApiCheckRequestConfig": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "maxLength": 2048
        },
        "method": {
          "type": "string",
          "enum": [
            "GET",
            "POST"
          ],
          "default": "POST"
        },
        "headers": {
          "type": "object",
          "propertyNames": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "additionalProperties": {
            "type": "string",
            "maxLength": 4000
          }
        },
        "body": {
          "type": "string",
          "minLength": 1,
          "maxLength": 20000
        }
      },
      "required": [
        "url"
      ]
    },
    "CollectorConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "collector"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "displayName": {
          "type": "string"
        },
        "modality": {
          "type": "string",
          "enum": [
            "call",
            "chat"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "ACTIVE",
            "INACTIVE"
          ],
          "default": "ACTIVE"
        },
        "metrics": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "$ref": "#/$defs/CollectorMetricConfig"
              }
            ]
          },
          "minItems": 1
        },
        "filters": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "AGENT",
                        "CALL_SOURCE",
                        "CALL_PROPERTY",
                        "INTEGRATION"
                      ]
                    },
                    "key": {
                      "type": "string",
                      "minLength": 1
                    },
                    "operator": {
                      "type": "string",
                      "enum": [
                        "EQUALS",
                        "NOT_EQUALS",
                        "CONTAINS",
                        "STARTS_WITH",
                        "GREATER_THAN",
                        "LESS_THAN",
                        "GREATER_THAN_OR_EQUALS",
                        "LESS_THAN_OR_EQUALS"
                      ]
                    },
                    "value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "key"
                  ]
                },
                "minItems": 1
              }
            },
            "required": [
              "conditions"
            ]
          }
        }
      },
      "required": [
        "kind",
        "name",
        "modality",
        "metrics"
      ]
    },
    "CollectorMetricConfig": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string",
          "minLength": 1
        },
        "verifiedProperties": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 50
        },
        "excludedPhrases": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 50
        },
        "voicemailScript": {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        },
        "screeningBrief": {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        }
      },
      "required": [
        "metric"
      ],
      "additionalProperties": false
    },
    "ConfigFlowStep": {
      "type": "object",
      "properties": {
        "ref": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "type": {
          "type": "string",
          "enum": [
            "AGENT_TURN",
            "CUSTOMER_TURN",
            "CUSTOMER_FIRST_MESSAGE",
            "CUSTOMER_VERBATIM_TURN",
            "CUSTOMER_SILENCE",
            "CUSTOMER_DTMF",
            "AGENT_DTMF",
            "VOICEMAIL",
            "SCENARIO_LINK",
            "CUSTOMER_HANDOFF"
          ]
        },
        "content": {
          "type": "string"
        },
        "offScript": {
          "$ref": "#/$defs/ConfigOffScript"
        },
        "silenceDurationSeconds": {
          "type": "integer",
          "exclusiveMinimum": 0
        },
        "dtmfDigits": {
          "type": "string"
        },
        "flow": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "handoffPersona": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "stage": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "required": {
                  "type": "boolean"
                },
                "analyze": {
                  "type": "boolean"
                }
              },
              "required": [
                "name"
              ],
              "additionalProperties": false
            }
          ]
        },
        "requiredForValidRun": {
          "type": "boolean",
          "description": "Removed. Use `stage` with `required: true`."
        },
        "mergeInto": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "steps": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ConfigFlowStep"
          }
        }
      },
      "required": [
        "type"
      ]
    },
    "ConfigOffScript": {
      "type": "object",
      "properties": {
        "reaction": {
          "type": "string",
          "enum": [
            "STAY_SILENT",
            "REPEAT",
            "RESPOND",
            "SAY"
          ]
        },
        "sayLine": {
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        },
        "maxAttempts": {
          "type": "integer",
          "minimum": 1,
          "maximum": 20
        },
        "then": {
          "type": "string",
          "enum": [
            "HANG_UP",
            "MOVE_ON",
            "ADAPT",
            "HANG_UP_INVALIDATE"
          ]
        },
        "waitSeconds": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600
        }
      }
    },
    "DashboardConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "dashboard"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "type": "string",
          "maxLength": 2000
        },
        "isDefault": {
          "type": "boolean"
        },
        "timeRange": {
          "$ref": "#/$defs/DashboardTimeRangeConfig"
        },
        "filters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DashboardFilterConfig"
          },
          "maxItems": 20
        },
        "widgets": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DashboardWidgetConfig"
          },
          "maxItems": 50,
          "default": []
        }
      },
      "required": [
        "kind",
        "name"
      ]
    },
    "DashboardFilterConfig": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "METRIC_PROPERTY",
            "CALL_PROPERTY",
            "AGENT_PROPERTY",
            "CALL_ID",
            "MODALITY",
            "DATASET",
            "METRIC_VALUE"
          ]
        },
        "property": {
          "type": "string"
        },
        "operator": {
          "type": "string",
          "enum": [
            "EQUALS",
            "NOT_EQUALS",
            "GREATER_THAN",
            "GREATER_THAN_OR_EQUAL_TO",
            "LESS_THAN",
            "LESS_THAN_OR_EQUAL_TO",
            "CONTAINS",
            "STARTS_WITH",
            "IS_SET",
            "IS_NOT_SET"
          ]
        },
        "value": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ]
        }
      },
      "required": [
        "type"
      ]
    },
    "DashboardMeasureConfig": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "METRIC",
            "CONVERSATION",
            "UPTIME"
          ]
        },
        "metric": {
          "type": "string",
          "minLength": 1
        },
        "aggregation": {
          "type": "string",
          "enum": [
            "COUNT",
            "AVG",
            "MIN",
            "MAX",
            "SUM",
            "MEDIAN",
            "PERCENTILE",
            "PASS_RATE"
          ]
        },
        "percentile": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "distinctBy": {
          "type": "string",
          "enum": [
            "NONE",
            "CALL"
          ]
        },
        "nestedAggregation": {
          "type": "string",
          "enum": [
            "COUNT",
            "AVG",
            "MIN",
            "MAX",
            "SUM",
            "MEDIAN",
            "PERCENTILE",
            "PASS_RATE"
          ]
        },
        "nestedAggregationPercentile": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "passOperator": {
          "type": "string",
          "enum": [
            "EQUALS",
            "NOT_EQUALS",
            "GREATER_THAN",
            "GREATER_THAN_OR_EQUAL_TO",
            "LESS_THAN",
            "LESS_THAN_OR_EQUAL_TO",
            "CONTAINS",
            "STARTS_WITH"
          ]
        },
        "passValue": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ]
        },
        "breakdown": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "METRIC_PROPERTY",
                "CALL_PROPERTY",
                "AGENT_PROPERTY",
                "DATASET"
              ]
            },
            "property": {
              "type": "string"
            }
          },
          "required": [
            "type"
          ]
        },
        "filters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DashboardFilterConfig"
          },
          "maxItems": 20
        },
        "isBaseline": {
          "type": "boolean"
        },
        "color": {
          "type": "string",
          "enum": [
            "GREEN",
            "RED",
            "ORANGE",
            "PURPLE",
            "GREY",
            "BLUE",
            "PEACH",
            "TEAL",
            "INDIGO",
            "AMBER",
            "ROSE",
            "CYAN"
          ]
        }
      }
    },
    "DashboardTimeRangeConfig": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "LAST"
            },
            "value": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1000
            },
            "unit": {
              "type": "string",
              "enum": [
                "DAYS",
                "WEEKS",
                "MONTHS"
              ]
            }
          },
          "required": [
            "type",
            "value",
            "unit"
          ]
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "CALENDAR_ALIGNED"
            },
            "period": {
              "type": "string",
              "enum": [
                "TODAY",
                "YESTERDAY",
                "THIS_WEEK",
                "LAST_WEEK",
                "THIS_MONTH",
                "LAST_MONTH",
                "THIS_YEAR",
                "LAST_YEAR"
              ]
            }
          },
          "required": [
            "type",
            "period"
          ]
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "FIXED"
            },
            "from": {
              "type": "string",
              "format": "date-time"
            },
            "to": {
              "type": "string",
              "format": "date-time"
            }
          },
          "required": [
            "type",
            "from",
            "to"
          ]
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "SINCE"
            },
            "from": {
              "type": "string",
              "format": "date-time"
            }
          },
          "required": [
            "type",
            "from"
          ]
        }
      ]
    },
    "DashboardWidgetConfig": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "type": "string",
          "maxLength": 2000
        },
        "display": {
          "type": "string",
          "enum": [
            "LINE",
            "NUMBER",
            "RADAR",
            "STACKED_BAR",
            "TABLE"
          ]
        },
        "size": {
          "type": "string",
          "enum": [
            "SMALL",
            "MEDIUM",
            "LARGE",
            "EXTRA_LARGE"
          ]
        },
        "measures": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DashboardMeasureConfig"
          },
          "minItems": 1,
          "maxItems": 10
        },
        "filters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DashboardFilterConfig"
          },
          "maxItems": 20
        },
        "interval": {
          "type": "string",
          "enum": [
            "HOUR",
            "DAY",
            "WEEK",
            "MONTH"
          ]
        },
        "comparisonMode": {
          "type": "string",
          "enum": [
            "NONE",
            "PREVIOUS_PERIOD"
          ]
        },
        "comparisonGroups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "filters": {
                "type": "array",
                "items": {
                  "$ref": "#/$defs/DashboardFilterConfig"
                },
                "minItems": 1,
                "maxItems": 20
              },
              "color": {
                "type": "string",
                "enum": [
                  "GREEN",
                  "RED",
                  "ORANGE",
                  "PURPLE",
                  "GREY",
                  "BLUE",
                  "PEACH",
                  "TEAL",
                  "INDIGO",
                  "AMBER",
                  "ROSE",
                  "CYAN"
                ]
              }
            },
            "required": [
              "name",
              "filters"
            ]
          },
          "minItems": 2,
          "maxItems": 5
        }
      },
      "required": [
        "name",
        "measures"
      ]
    },
    "HttpRequestDefinitionConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "httpRequestDefinition"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "method": {
          "type": "string",
          "enum": [
            "POST",
            "PUT",
            "PATCH",
            "GET"
          ],
          "default": "POST"
        },
        "body": {
          "type": "string"
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "required": [
        "kind",
        "name",
        "url"
      ]
    },
    "ImprovFlowConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "flow"
        },
        "type": {
          "type": "string",
          "const": "improv"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "agents": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z0-9][a-z0-9-_.]*$",
            "minLength": 1
          },
          "minItems": 1
        },
        "expectations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "happyPath": {
          "type": "object",
          "properties": {
            "persona": {
              "type": "string",
              "pattern": "^[a-z0-9][a-z0-9-_.]*$",
              "minLength": 1
            },
            "environment": {
              "type": "string"
            },
            "prompt": {
              "type": "string"
            },
            "expectations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "title": {
              "type": "string"
            }
          },
          "required": [
            "persona",
            "environment"
          ]
        },
        "edgeCases": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "persona": {
                "type": "string",
                "pattern": "^[a-z0-9][a-z0-9-_.]*$",
                "minLength": 1
              },
              "environment": {
                "type": "string"
              },
              "prompt": {
                "type": "string"
              },
              "expectations": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "name": {
                "type": "string",
                "pattern": "^[a-z0-9][a-z0-9-_.]*$",
                "minLength": 1
              },
              "title": {
                "type": "string"
              },
              "includeFlowExpectations": {
                "type": "boolean"
              }
            },
            "required": [
              "name"
            ]
          }
        }
      },
      "required": [
        "kind",
        "type",
        "name",
        "agents",
        "happyPath"
      ]
    },
    "MetricConfig": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "metric"
        },
        "calculationType": {
          "type": "string",
          "const": "LLM_JUDGE"
        },
        "name": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-_.]*$",
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "type": {
          "type": "string",
          "enum": [
            "BOOLEAN",
            "SCALE",
            "NUMERIC",
            "TEXT",
            "CLASSIFICATION"
          ]
        },
        "prompt": {
          "type": "string",
          "minLength": 1
        },
        "scope": {
          "type": "string",
          "enum": [
            "GLOBAL",
            "PER_PARTICIPANT"
          ],
          "default": "GLOBAL"
        },
        "participantRole": {
          "type": "string",
          "enum": [
            "AGENT",
            "CUSTOMER"
          ]
        },
        "contexts": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "CALL",
              "SEGMENT",
              "TURN"
            ]
          },
          "minItems": 1,
          "default": [
            "CALL"
          ]
        },
        "trueLabel": {
          "type": "string"
        },
        "falseLabel": {
          "type": "string"
        },
        "scaleMin": {
          "type": "integer"
        },
        "scaleMax": {
          "type": "integer"
        },
        "scaleLabels": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "rangeMin": {
                "type": "number"

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://artifacts.apis.io/roark/json-schema/roark-config-bundle-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/roark-config-bundle"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.