11822 lines
320 KiB
JSON
11822 lines
320 KiB
JSON
{
|
|
"components": {
|
|
"schemas": {
|
|
"AdminUserOut": {
|
|
"properties": {
|
|
"displayName": {
|
|
"title": "Displayname",
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"title": "Username",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"displayName",
|
|
"role"
|
|
],
|
|
"title": "AdminUserOut",
|
|
"type": "object"
|
|
},
|
|
"AnalysisConfig": {
|
|
"properties": {
|
|
"enabled": {
|
|
"default": false,
|
|
"title": "Enabled",
|
|
"type": "boolean"
|
|
},
|
|
"fields": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/AnalysisField"
|
|
},
|
|
"maxItems": 20,
|
|
"title": "Fields",
|
|
"type": "array"
|
|
},
|
|
"modelResourceId": {
|
|
"default": "",
|
|
"title": "Modelresourceid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "AnalysisConfig",
|
|
"type": "object"
|
|
},
|
|
"AnalysisField": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 500,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"enumValues": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 30,
|
|
"title": "Enumvalues",
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"maxLength": 64,
|
|
"minLength": 1,
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"default": "string",
|
|
"enum": [
|
|
"string",
|
|
"boolean",
|
|
"integer",
|
|
"number",
|
|
"enum"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"title": "AnalysisField",
|
|
"type": "object"
|
|
},
|
|
"AnalysisWebhookSettingOut": {
|
|
"properties": {
|
|
"enabled": {
|
|
"default": false,
|
|
"title": "Enabled",
|
|
"type": "boolean"
|
|
},
|
|
"secretConfigured": {
|
|
"default": false,
|
|
"title": "Secretconfigured",
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Updatedat"
|
|
},
|
|
"url": {
|
|
"default": "",
|
|
"title": "Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "AnalysisWebhookSettingOut",
|
|
"type": "object"
|
|
},
|
|
"AnalysisWebhookSettingUpdate": {
|
|
"properties": {
|
|
"clearSecret": {
|
|
"default": false,
|
|
"title": "Clearsecret",
|
|
"type": "boolean"
|
|
},
|
|
"enabled": {
|
|
"default": false,
|
|
"title": "Enabled",
|
|
"type": "boolean"
|
|
},
|
|
"secret": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 512,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Secret"
|
|
},
|
|
"url": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "AnalysisWebhookSettingUpdate",
|
|
"type": "object"
|
|
},
|
|
"AnalysisWebhookTestIn": {
|
|
"properties": {
|
|
"secret": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 512,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Secret"
|
|
},
|
|
"url": {
|
|
"maxLength": 2048,
|
|
"minLength": 1,
|
|
"title": "Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"url"
|
|
],
|
|
"title": "AnalysisWebhookTestIn",
|
|
"type": "object"
|
|
},
|
|
"AnalysisWebhookTestOut": {
|
|
"properties": {
|
|
"latencyMs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Latencyms"
|
|
},
|
|
"message": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"ok": {
|
|
"title": "Ok",
|
|
"type": "boolean"
|
|
},
|
|
"payload": {
|
|
"additionalProperties": true,
|
|
"title": "Payload",
|
|
"type": "object"
|
|
},
|
|
"statusCode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Statuscode"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"message",
|
|
"payload"
|
|
],
|
|
"title": "AnalysisWebhookTestOut",
|
|
"type": "object"
|
|
},
|
|
"AnyToolSimulationScope": {
|
|
"properties": {
|
|
"phase": {
|
|
"const": "any",
|
|
"default": "any",
|
|
"title": "Phase",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "AnyToolSimulationScope",
|
|
"type": "object"
|
|
},
|
|
"AssistantOut": {
|
|
"properties": {
|
|
"analysisConfig": {
|
|
"$ref": "#/components/schemas/AnalysisConfig"
|
|
},
|
|
"apiKey": {
|
|
"default": "",
|
|
"title": "Apikey",
|
|
"type": "string"
|
|
},
|
|
"apiUrl": {
|
|
"default": "",
|
|
"title": "Apiurl",
|
|
"type": "string"
|
|
},
|
|
"appId": {
|
|
"default": "",
|
|
"title": "Appid",
|
|
"type": "string"
|
|
},
|
|
"builtInTools": {
|
|
"$ref": "#/components/schemas/BuiltInTools-Output"
|
|
},
|
|
"dynamicVariableDefinitions": {
|
|
"additionalProperties": {
|
|
"$ref": "#/components/schemas/DynamicVariableDefinition"
|
|
},
|
|
"title": "Dynamicvariabledefinitions",
|
|
"type": "object"
|
|
},
|
|
"enableInterrupt": {
|
|
"default": true,
|
|
"title": "Enableinterrupt",
|
|
"type": "boolean"
|
|
},
|
|
"graph": {
|
|
"additionalProperties": true,
|
|
"title": "Graph",
|
|
"type": "object"
|
|
},
|
|
"greeting": {
|
|
"default": "",
|
|
"title": "Greeting",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"knowledgeBaseId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Knowledgebaseid"
|
|
},
|
|
"knowledgeRetrievalConfig": {
|
|
"$ref": "#/components/schemas/KnowledgeRetrievalConfig"
|
|
},
|
|
"modelResourceIds": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"propertyNames": {
|
|
"enum": [
|
|
"LLM",
|
|
"ASR",
|
|
"TTS",
|
|
"Realtime",
|
|
"Embedding",
|
|
"Agent"
|
|
]
|
|
},
|
|
"title": "Modelresourceids",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"default": "",
|
|
"title": "Prompt",
|
|
"type": "string"
|
|
},
|
|
"runtimeMode": {
|
|
"default": "pipeline",
|
|
"enum": [
|
|
"pipeline",
|
|
"realtime"
|
|
],
|
|
"title": "Runtimemode",
|
|
"type": "string"
|
|
},
|
|
"startup": {
|
|
"$ref": "#/components/schemas/StartupConfig"
|
|
},
|
|
"toolBindings": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolBinding"
|
|
},
|
|
"title": "Toolbindings",
|
|
"type": "array"
|
|
},
|
|
"turnConfig": {
|
|
"$ref": "#/components/schemas/TurnConfig"
|
|
},
|
|
"type": {
|
|
"default": "prompt",
|
|
"enum": [
|
|
"prompt",
|
|
"workflow",
|
|
"dify",
|
|
"fastgpt"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Updatedat"
|
|
},
|
|
"visionEnabled": {
|
|
"default": false,
|
|
"title": "Visionenabled",
|
|
"type": "boolean"
|
|
},
|
|
"visionModelResourceId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Visionmodelresourceid"
|
|
},
|
|
"visionPrompt": {
|
|
"default": "",
|
|
"maxLength": 4000,
|
|
"title": "Visionprompt",
|
|
"type": "string"
|
|
},
|
|
"visionPromptMode": {
|
|
"default": "runtime",
|
|
"enum": [
|
|
"fixed",
|
|
"runtime",
|
|
"guided"
|
|
],
|
|
"title": "Visionpromptmode",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"id"
|
|
],
|
|
"title": "AssistantOut",
|
|
"type": "object"
|
|
},
|
|
"AssistantUpsert": {
|
|
"properties": {
|
|
"analysisConfig": {
|
|
"$ref": "#/components/schemas/AnalysisConfig"
|
|
},
|
|
"apiKey": {
|
|
"default": "",
|
|
"title": "Apikey",
|
|
"type": "string"
|
|
},
|
|
"apiUrl": {
|
|
"default": "",
|
|
"title": "Apiurl",
|
|
"type": "string"
|
|
},
|
|
"appId": {
|
|
"default": "",
|
|
"title": "Appid",
|
|
"type": "string"
|
|
},
|
|
"builtInTools": {
|
|
"$ref": "#/components/schemas/BuiltInTools-Input"
|
|
},
|
|
"dynamicVariableDefinitions": {
|
|
"additionalProperties": {
|
|
"$ref": "#/components/schemas/DynamicVariableDefinition"
|
|
},
|
|
"title": "Dynamicvariabledefinitions",
|
|
"type": "object"
|
|
},
|
|
"enableInterrupt": {
|
|
"default": true,
|
|
"title": "Enableinterrupt",
|
|
"type": "boolean"
|
|
},
|
|
"graph": {
|
|
"additionalProperties": true,
|
|
"title": "Graph",
|
|
"type": "object"
|
|
},
|
|
"greeting": {
|
|
"default": "",
|
|
"title": "Greeting",
|
|
"type": "string"
|
|
},
|
|
"knowledgeBaseId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Knowledgebaseid"
|
|
},
|
|
"knowledgeRetrievalConfig": {
|
|
"$ref": "#/components/schemas/KnowledgeRetrievalConfig"
|
|
},
|
|
"modelResourceIds": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"propertyNames": {
|
|
"enum": [
|
|
"LLM",
|
|
"ASR",
|
|
"TTS",
|
|
"Realtime",
|
|
"Embedding",
|
|
"Agent"
|
|
]
|
|
},
|
|
"title": "Modelresourceids",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"default": "",
|
|
"title": "Prompt",
|
|
"type": "string"
|
|
},
|
|
"runtimeMode": {
|
|
"default": "pipeline",
|
|
"enum": [
|
|
"pipeline",
|
|
"realtime"
|
|
],
|
|
"title": "Runtimemode",
|
|
"type": "string"
|
|
},
|
|
"startup": {
|
|
"$ref": "#/components/schemas/StartupConfig"
|
|
},
|
|
"toolBindings": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolBinding"
|
|
},
|
|
"title": "Toolbindings",
|
|
"type": "array"
|
|
},
|
|
"turnConfig": {
|
|
"$ref": "#/components/schemas/TurnConfig"
|
|
},
|
|
"type": {
|
|
"default": "prompt",
|
|
"enum": [
|
|
"prompt",
|
|
"workflow",
|
|
"dify",
|
|
"fastgpt"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"visionEnabled": {
|
|
"default": false,
|
|
"title": "Visionenabled",
|
|
"type": "boolean"
|
|
},
|
|
"visionModelResourceId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Visionmodelresourceid"
|
|
},
|
|
"visionPrompt": {
|
|
"default": "",
|
|
"maxLength": 4000,
|
|
"title": "Visionprompt",
|
|
"type": "string"
|
|
},
|
|
"visionPromptMode": {
|
|
"default": "runtime",
|
|
"enum": [
|
|
"fixed",
|
|
"runtime",
|
|
"guided"
|
|
],
|
|
"title": "Visionpromptmode",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "AssistantUpsert",
|
|
"type": "object"
|
|
},
|
|
"BargeInConfig": {
|
|
"properties": {
|
|
"strategy": {
|
|
"default": "vad",
|
|
"enum": [
|
|
"vad",
|
|
"transcription"
|
|
],
|
|
"title": "Strategy",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "BargeInConfig",
|
|
"type": "object"
|
|
},
|
|
"BatchEvaluationResult": {
|
|
"properties": {
|
|
"actual": {
|
|
"title": "Actual",
|
|
"type": "string"
|
|
},
|
|
"expected": {
|
|
"title": "Expected",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"enum": [
|
|
"reply",
|
|
"tool_call",
|
|
"overall"
|
|
],
|
|
"title": "Kind",
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"title": "Label",
|
|
"type": "string"
|
|
},
|
|
"reason": {
|
|
"default": "",
|
|
"title": "Reason",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"pass",
|
|
"fail"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"label",
|
|
"kind",
|
|
"status",
|
|
"expected",
|
|
"actual"
|
|
],
|
|
"title": "BatchEvaluationResult",
|
|
"type": "object"
|
|
},
|
|
"BatchExecutionError": {
|
|
"properties": {
|
|
"code": {
|
|
"title": "Code",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"retryable": {
|
|
"title": "Retryable",
|
|
"type": "boolean"
|
|
},
|
|
"stage": {
|
|
"enum": [
|
|
"pipeline",
|
|
"model",
|
|
"tool",
|
|
"evaluation"
|
|
],
|
|
"title": "Stage",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"stage",
|
|
"retryable"
|
|
],
|
|
"title": "BatchExecutionError",
|
|
"type": "object"
|
|
},
|
|
"BatchRunCaseOut": {
|
|
"properties": {
|
|
"attemptCount": {
|
|
"title": "Attemptcount",
|
|
"type": "integer"
|
|
},
|
|
"executionError": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BatchExecutionError"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"maxAttempts": {
|
|
"title": "Maxattempts",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"overallCriteria": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatchEvaluationResult"
|
|
},
|
|
"title": "Overallcriteria",
|
|
"type": "array"
|
|
},
|
|
"startup": {
|
|
"$ref": "#/components/schemas/BatchStartupResult"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"waiting",
|
|
"running",
|
|
"pass",
|
|
"fail",
|
|
"error",
|
|
"skipped"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"turns": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatchTurnResult"
|
|
},
|
|
"title": "Turns",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"status",
|
|
"attemptCount",
|
|
"maxAttempts"
|
|
],
|
|
"title": "BatchRunCaseOut",
|
|
"type": "object"
|
|
},
|
|
"BatchRunConfig": {
|
|
"properties": {
|
|
"concurrency": {
|
|
"default": 3,
|
|
"maximum": 20.0,
|
|
"minimum": 1.0,
|
|
"title": "Concurrency",
|
|
"type": "integer"
|
|
},
|
|
"errorRetryCount": {
|
|
"default": 0,
|
|
"maximum": 3.0,
|
|
"minimum": 0.0,
|
|
"title": "Errorretrycount",
|
|
"type": "integer"
|
|
},
|
|
"errorStrategy": {
|
|
"default": "continue",
|
|
"enum": [
|
|
"continue",
|
|
"stop_on_error"
|
|
],
|
|
"title": "Errorstrategy",
|
|
"type": "string"
|
|
},
|
|
"failureStrategy": {
|
|
"default": "continue",
|
|
"enum": [
|
|
"continue",
|
|
"stop_on_fail"
|
|
],
|
|
"title": "Failurestrategy",
|
|
"type": "string"
|
|
},
|
|
"timeoutSecs": {
|
|
"default": 60,
|
|
"maximum": 600.0,
|
|
"minimum": 1.0,
|
|
"title": "Timeoutsecs",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "BatchRunConfig",
|
|
"type": "object"
|
|
},
|
|
"BatchRunCreate": {
|
|
"properties": {
|
|
"assistantId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Assistantid",
|
|
"type": "string"
|
|
},
|
|
"caseIds": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 1000,
|
|
"minItems": 1,
|
|
"title": "Caseids",
|
|
"type": "array"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/BatchRunConfig"
|
|
},
|
|
"dynamicVariables": {
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
}
|
|
]
|
|
},
|
|
"maxProperties": 50,
|
|
"title": "Dynamicvariables",
|
|
"type": "object"
|
|
},
|
|
"evaluatorModelResourceId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Evaluatormodelresourceid",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 256,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title"
|
|
}
|
|
},
|
|
"required": [
|
|
"assistantId",
|
|
"evaluatorModelResourceId",
|
|
"caseIds"
|
|
],
|
|
"title": "BatchRunCreate",
|
|
"type": "object"
|
|
},
|
|
"BatchRunSnapshotOut": {
|
|
"properties": {
|
|
"assistantName": {
|
|
"title": "Assistantname",
|
|
"type": "string"
|
|
},
|
|
"cases": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatchRunCaseOut"
|
|
},
|
|
"title": "Cases",
|
|
"type": "array"
|
|
},
|
|
"config": {
|
|
"additionalProperties": true,
|
|
"title": "Config",
|
|
"type": "object"
|
|
},
|
|
"finishedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Finishedat"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"format": "date-time",
|
|
"title": "Startedat",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"queued",
|
|
"running",
|
|
"completed",
|
|
"cancelled"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"stopReason": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"manual",
|
|
"assertion_failure",
|
|
"execution_error"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Stopreason"
|
|
},
|
|
"title": {
|
|
"title": "Title",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"status",
|
|
"title",
|
|
"assistantName",
|
|
"config",
|
|
"cases",
|
|
"startedAt",
|
|
"finishedAt",
|
|
"stopReason"
|
|
],
|
|
"title": "BatchRunSnapshotOut",
|
|
"type": "object"
|
|
},
|
|
"BatchStartupResult": {
|
|
"properties": {
|
|
"assistantOutputs": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Assistantoutputs",
|
|
"type": "array"
|
|
},
|
|
"autoConfirmedMessages": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Autoconfirmedmessages",
|
|
"type": "array"
|
|
},
|
|
"completed": {
|
|
"default": false,
|
|
"title": "Completed",
|
|
"type": "boolean"
|
|
},
|
|
"greeting": {
|
|
"default": "",
|
|
"title": "Greeting",
|
|
"type": "string"
|
|
},
|
|
"runtimeRecords": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Runtimerecords",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "BatchStartupResult",
|
|
"type": "object"
|
|
},
|
|
"BatchToolCallRecord": {
|
|
"properties": {
|
|
"argumentsJson": {
|
|
"title": "Argumentsjson",
|
|
"type": "string"
|
|
},
|
|
"durationMs": {
|
|
"default": 0,
|
|
"title": "Durationms",
|
|
"type": "integer"
|
|
},
|
|
"functionName": {
|
|
"title": "Functionname",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"outcome": {
|
|
"enum": [
|
|
"success",
|
|
"error"
|
|
],
|
|
"title": "Outcome",
|
|
"type": "string"
|
|
},
|
|
"resultJson": {
|
|
"title": "Resultjson",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"functionName",
|
|
"argumentsJson",
|
|
"resultJson",
|
|
"outcome"
|
|
],
|
|
"title": "BatchToolCallRecord",
|
|
"type": "object"
|
|
},
|
|
"BatchTurnResult": {
|
|
"properties": {
|
|
"assistantReply": {
|
|
"title": "Assistantreply",
|
|
"type": "string"
|
|
},
|
|
"evaluations": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatchEvaluationResult"
|
|
},
|
|
"title": "Evaluations",
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TestImageRef"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"index": {
|
|
"title": "Index",
|
|
"type": "integer"
|
|
},
|
|
"runtimeRecords": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Runtimerecords",
|
|
"type": "array"
|
|
},
|
|
"toolCalls": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatchToolCallRecord"
|
|
},
|
|
"title": "Toolcalls",
|
|
"type": "array"
|
|
},
|
|
"userInput": {
|
|
"title": "Userinput",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"index",
|
|
"userInput",
|
|
"assistantReply"
|
|
],
|
|
"title": "BatchTurnResult",
|
|
"type": "object"
|
|
},
|
|
"Body_add_file_api_knowledge_bases__kb_id__documents_file_post": {
|
|
"properties": {
|
|
"file": {
|
|
"contentMediaType": "application/octet-stream",
|
|
"title": "File",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"default": "",
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"file"
|
|
],
|
|
"title": "Body_add_file_api_knowledge_bases__kb_id__documents_file_post",
|
|
"type": "object"
|
|
},
|
|
"Body_upload_input_image_api_input_assets_image_post": {
|
|
"properties": {
|
|
"file": {
|
|
"contentMediaType": "application/octet-stream",
|
|
"title": "File",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"file"
|
|
],
|
|
"title": "Body_upload_input_image_api_input_assets_image_post",
|
|
"type": "object"
|
|
},
|
|
"Body_upload_test_image_api_test_assets_images_post": {
|
|
"properties": {
|
|
"file": {
|
|
"contentMediaType": "application/octet-stream",
|
|
"title": "File",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"file"
|
|
],
|
|
"title": "Body_upload_test_image_api_test_assets_images_post",
|
|
"type": "object"
|
|
},
|
|
"BuiltInToolBase": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "BuiltInToolBase",
|
|
"type": "object"
|
|
},
|
|
"BuiltInTools-Input": {
|
|
"properties": {
|
|
"endConversation": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EndConversationTool"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"requestHumanHandoff": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltInToolBase"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"skipTurn": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltInToolBase"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"updateState": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateStateTool-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"title": "BuiltInTools",
|
|
"type": "object"
|
|
},
|
|
"BuiltInTools-Output": {
|
|
"properties": {
|
|
"endConversation": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EndConversationTool"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"requestHumanHandoff": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltInToolBase"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"skipTurn": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltInToolBase"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"updateState": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateStateTool-Output"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"title": "BuiltInTools",
|
|
"type": "object"
|
|
},
|
|
"ClientToolConfig": {
|
|
"properties": {
|
|
"allowInterruptions": {
|
|
"default": true,
|
|
"title": "Allowinterruptions",
|
|
"type": "boolean"
|
|
},
|
|
"executionMode": {
|
|
"default": "async",
|
|
"enum": [
|
|
"immediate",
|
|
"async"
|
|
],
|
|
"title": "Executionmode",
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolParameter"
|
|
},
|
|
"title": "Parameters",
|
|
"type": "array"
|
|
},
|
|
"responseWaitMode": {
|
|
"default": "timeout",
|
|
"enum": [
|
|
"timeout",
|
|
"session"
|
|
],
|
|
"title": "Responsewaitmode",
|
|
"type": "string"
|
|
},
|
|
"timeoutSeconds": {
|
|
"default": 3,
|
|
"maximum": 30.0,
|
|
"minimum": 1.0,
|
|
"title": "Timeoutseconds",
|
|
"type": "integer"
|
|
},
|
|
"waitForResponse": {
|
|
"default": true,
|
|
"title": "Waitforresponse",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"title": "ClientToolConfig",
|
|
"type": "object"
|
|
},
|
|
"ClientToolDefinition": {
|
|
"properties": {
|
|
"config": {
|
|
"$ref": "#/components/schemas/ClientToolConfig"
|
|
},
|
|
"schemaVersion": {
|
|
"default": 2,
|
|
"title": "Schemaversion",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "client",
|
|
"default": "client",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "ClientToolDefinition",
|
|
"type": "object"
|
|
},
|
|
"ConditionalStateExpression-Input": {
|
|
"properties": {
|
|
"condition": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Input",
|
|
"and": "#/components/schemas/OperationStateExpression-Input",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Input",
|
|
"eq": "#/components/schemas/OperationStateExpression-Input",
|
|
"gt": "#/components/schemas/OperationStateExpression-Input",
|
|
"gte": "#/components/schemas/OperationStateExpression-Input",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Input",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Input",
|
|
"lte": "#/components/schemas/OperationStateExpression-Input",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Input",
|
|
"neq": "#/components/schemas/OperationStateExpression-Input",
|
|
"or": "#/components/schemas/OperationStateExpression-Input",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Input",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Input"
|
|
}
|
|
],
|
|
"title": "Condition"
|
|
},
|
|
"otherwise": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Input",
|
|
"and": "#/components/schemas/OperationStateExpression-Input",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Input",
|
|
"eq": "#/components/schemas/OperationStateExpression-Input",
|
|
"gt": "#/components/schemas/OperationStateExpression-Input",
|
|
"gte": "#/components/schemas/OperationStateExpression-Input",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Input",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Input",
|
|
"lte": "#/components/schemas/OperationStateExpression-Input",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Input",
|
|
"neq": "#/components/schemas/OperationStateExpression-Input",
|
|
"or": "#/components/schemas/OperationStateExpression-Input",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Input",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Input"
|
|
}
|
|
],
|
|
"title": "Otherwise"
|
|
},
|
|
"then": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Input",
|
|
"and": "#/components/schemas/OperationStateExpression-Input",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Input",
|
|
"eq": "#/components/schemas/OperationStateExpression-Input",
|
|
"gt": "#/components/schemas/OperationStateExpression-Input",
|
|
"gte": "#/components/schemas/OperationStateExpression-Input",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Input",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Input",
|
|
"lte": "#/components/schemas/OperationStateExpression-Input",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Input",
|
|
"neq": "#/components/schemas/OperationStateExpression-Input",
|
|
"or": "#/components/schemas/OperationStateExpression-Input",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Input",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Input"
|
|
}
|
|
],
|
|
"title": "Then"
|
|
},
|
|
"type": {
|
|
"const": "if",
|
|
"default": "if",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"condition",
|
|
"then",
|
|
"otherwise"
|
|
],
|
|
"title": "ConditionalStateExpression",
|
|
"type": "object"
|
|
},
|
|
"ConditionalStateExpression-Output": {
|
|
"properties": {
|
|
"condition": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Output",
|
|
"and": "#/components/schemas/OperationStateExpression-Output",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Output",
|
|
"eq": "#/components/schemas/OperationStateExpression-Output",
|
|
"gt": "#/components/schemas/OperationStateExpression-Output",
|
|
"gte": "#/components/schemas/OperationStateExpression-Output",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Output",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Output",
|
|
"lte": "#/components/schemas/OperationStateExpression-Output",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Output",
|
|
"neq": "#/components/schemas/OperationStateExpression-Output",
|
|
"or": "#/components/schemas/OperationStateExpression-Output",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Output",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Output"
|
|
}
|
|
],
|
|
"title": "Condition"
|
|
},
|
|
"otherwise": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Output",
|
|
"and": "#/components/schemas/OperationStateExpression-Output",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Output",
|
|
"eq": "#/components/schemas/OperationStateExpression-Output",
|
|
"gt": "#/components/schemas/OperationStateExpression-Output",
|
|
"gte": "#/components/schemas/OperationStateExpression-Output",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Output",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Output",
|
|
"lte": "#/components/schemas/OperationStateExpression-Output",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Output",
|
|
"neq": "#/components/schemas/OperationStateExpression-Output",
|
|
"or": "#/components/schemas/OperationStateExpression-Output",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Output",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Output"
|
|
}
|
|
],
|
|
"title": "Otherwise"
|
|
},
|
|
"then": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Output",
|
|
"and": "#/components/schemas/OperationStateExpression-Output",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Output",
|
|
"eq": "#/components/schemas/OperationStateExpression-Output",
|
|
"gt": "#/components/schemas/OperationStateExpression-Output",
|
|
"gte": "#/components/schemas/OperationStateExpression-Output",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Output",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Output",
|
|
"lte": "#/components/schemas/OperationStateExpression-Output",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Output",
|
|
"neq": "#/components/schemas/OperationStateExpression-Output",
|
|
"or": "#/components/schemas/OperationStateExpression-Output",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Output",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Output"
|
|
}
|
|
],
|
|
"title": "Then"
|
|
},
|
|
"type": {
|
|
"const": "if",
|
|
"default": "if",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"condition",
|
|
"then",
|
|
"otherwise"
|
|
],
|
|
"title": "ConditionalStateExpression",
|
|
"type": "object"
|
|
},
|
|
"ConstantStateExpression": {
|
|
"properties": {
|
|
"type": {
|
|
"const": "constant",
|
|
"default": "constant",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
],
|
|
"title": "ConstantStateExpression",
|
|
"type": "object"
|
|
},
|
|
"ContextTurn": {
|
|
"properties": {
|
|
"content": {
|
|
"maxLength": 20000,
|
|
"title": "Content",
|
|
"type": "string"
|
|
},
|
|
"isError": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Iserror"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"agent",
|
|
"user",
|
|
"tool_call",
|
|
"tool_result"
|
|
],
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"toolCallId": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 128,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Toolcallid"
|
|
},
|
|
"toolName": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 128,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Toolname"
|
|
}
|
|
},
|
|
"required": [
|
|
"role",
|
|
"content"
|
|
],
|
|
"title": "ContextTurn",
|
|
"type": "object"
|
|
},
|
|
"ConversationAnalysisFieldOut": {
|
|
"properties": {
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"type"
|
|
],
|
|
"title": "ConversationAnalysisFieldOut",
|
|
"type": "object"
|
|
},
|
|
"ConversationAnalysisOut": {
|
|
"properties": {
|
|
"completedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Completedat"
|
|
},
|
|
"error": {
|
|
"default": "",
|
|
"title": "Error",
|
|
"type": "string"
|
|
},
|
|
"fields": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ConversationAnalysisFieldOut"
|
|
},
|
|
"title": "Fields",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"pending",
|
|
"processing",
|
|
"completed",
|
|
"failed"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "ConversationAnalysisOut",
|
|
"type": "object"
|
|
},
|
|
"ConversationArtifactOut": {
|
|
"properties": {
|
|
"contentUrl": {
|
|
"title": "Contenturl",
|
|
"type": "string"
|
|
},
|
|
"durationMs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Durationms"
|
|
},
|
|
"extra": {
|
|
"additionalProperties": true,
|
|
"title": "Extra",
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"title": "Kind",
|
|
"type": "string"
|
|
},
|
|
"mimeType": {
|
|
"title": "Mimetype",
|
|
"type": "string"
|
|
},
|
|
"sizeBytes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sizebytes"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"kind",
|
|
"contentUrl",
|
|
"mimeType"
|
|
],
|
|
"title": "ConversationArtifactOut",
|
|
"type": "object"
|
|
},
|
|
"ConversationDetailOut": {
|
|
"properties": {
|
|
"analysis": {
|
|
"$ref": "#/components/schemas/ConversationAnalysisOut"
|
|
},
|
|
"assistantId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Assistantid"
|
|
},
|
|
"assistantName": {
|
|
"title": "Assistantname",
|
|
"type": "string"
|
|
},
|
|
"channel": {
|
|
"title": "Channel",
|
|
"type": "string"
|
|
},
|
|
"endedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Endedat"
|
|
},
|
|
"extra": {
|
|
"additionalProperties": true,
|
|
"title": "Extra",
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"messageCount": {
|
|
"title": "Messagecount",
|
|
"type": "integer"
|
|
},
|
|
"messages": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ConversationMessageOut"
|
|
},
|
|
"title": "Messages",
|
|
"type": "array"
|
|
},
|
|
"runtimeMode": {
|
|
"title": "Runtimemode",
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"format": "date-time",
|
|
"title": "Startedat",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"assistantId",
|
|
"assistantName",
|
|
"channel",
|
|
"runtimeMode",
|
|
"status",
|
|
"messageCount",
|
|
"startedAt",
|
|
"endedAt"
|
|
],
|
|
"title": "ConversationDetailOut",
|
|
"type": "object"
|
|
},
|
|
"ConversationListOut": {
|
|
"properties": {
|
|
"items": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ConversationOut"
|
|
},
|
|
"title": "Items",
|
|
"type": "array"
|
|
},
|
|
"page": {
|
|
"title": "Page",
|
|
"type": "integer"
|
|
},
|
|
"pageSize": {
|
|
"title": "Pagesize",
|
|
"type": "integer"
|
|
},
|
|
"total": {
|
|
"title": "Total",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"items",
|
|
"total",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"title": "ConversationListOut",
|
|
"type": "object"
|
|
},
|
|
"ConversationMessageOut": {
|
|
"properties": {
|
|
"artifacts": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ConversationArtifactOut"
|
|
},
|
|
"title": "Artifacts",
|
|
"type": "array"
|
|
},
|
|
"content": {
|
|
"title": "Content",
|
|
"type": "string"
|
|
},
|
|
"contentType": {
|
|
"title": "Contenttype",
|
|
"type": "string"
|
|
},
|
|
"extra": {
|
|
"additionalProperties": true,
|
|
"title": "Extra",
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"occurredAt": {
|
|
"format": "date-time",
|
|
"title": "Occurredat",
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
],
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"sequence": {
|
|
"title": "Sequence",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"sequence",
|
|
"role",
|
|
"contentType",
|
|
"content",
|
|
"occurredAt"
|
|
],
|
|
"title": "ConversationMessageOut",
|
|
"type": "object"
|
|
},
|
|
"ConversationOut": {
|
|
"properties": {
|
|
"assistantId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Assistantid"
|
|
},
|
|
"assistantName": {
|
|
"title": "Assistantname",
|
|
"type": "string"
|
|
},
|
|
"channel": {
|
|
"title": "Channel",
|
|
"type": "string"
|
|
},
|
|
"endedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Endedat"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"messageCount": {
|
|
"title": "Messagecount",
|
|
"type": "integer"
|
|
},
|
|
"runtimeMode": {
|
|
"title": "Runtimemode",
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"format": "date-time",
|
|
"title": "Startedat",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"assistantId",
|
|
"assistantName",
|
|
"channel",
|
|
"runtimeMode",
|
|
"status",
|
|
"messageCount",
|
|
"startedAt",
|
|
"endedAt"
|
|
],
|
|
"title": "ConversationOut",
|
|
"type": "object"
|
|
},
|
|
"DeletedResource": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"deleted": {
|
|
"const": true,
|
|
"default": true,
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "response",
|
|
"default": "response",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "DeletedResource",
|
|
"type": "object"
|
|
},
|
|
"DynamicVariableDefinition": {
|
|
"properties": {
|
|
"default": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Default"
|
|
},
|
|
"required": {
|
|
"default": false,
|
|
"title": "Required",
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"default": "string",
|
|
"enum": [
|
|
"string",
|
|
"number",
|
|
"boolean"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "DynamicVariableDefinition",
|
|
"type": "object"
|
|
},
|
|
"EndConversationTool": {
|
|
"properties": {
|
|
"allowEndInterruption": {
|
|
"default": false,
|
|
"title": "Allowendinterruption",
|
|
"type": "boolean"
|
|
},
|
|
"captureReason": {
|
|
"default": true,
|
|
"title": "Capturereason",
|
|
"type": "boolean"
|
|
},
|
|
"customMessage": {
|
|
"default": "",
|
|
"maxLength": 2000,
|
|
"title": "Custommessage",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"messageType": {
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"custom"
|
|
],
|
|
"title": "Messagetype",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "EndConversationTool",
|
|
"type": "object"
|
|
},
|
|
"FixedInputTurn": {
|
|
"properties": {
|
|
"behaviors": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"reply": "#/components/schemas/ReplyExpectedBehavior",
|
|
"tool_call": "#/components/schemas/ToolCallExpectedBehavior"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReplyExpectedBehavior"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolCallExpectedBehavior"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 100,
|
|
"title": "Behaviors",
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TestImageRef"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"userInput": {
|
|
"default": "",
|
|
"maxLength": 20000,
|
|
"title": "Userinput",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "FixedInputTurn",
|
|
"type": "object"
|
|
},
|
|
"FixedToolSimulation": {
|
|
"properties": {
|
|
"functionName": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Functionname",
|
|
"type": "string"
|
|
},
|
|
"mode": {
|
|
"const": "fixed",
|
|
"default": "fixed",
|
|
"title": "Mode",
|
|
"type": "string"
|
|
},
|
|
"response": {
|
|
"$ref": "#/components/schemas/ToolSimulationResponse"
|
|
},
|
|
"toolId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Toolid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"toolId",
|
|
"functionName"
|
|
],
|
|
"title": "FixedToolSimulation",
|
|
"type": "object"
|
|
},
|
|
"HTTPValidationError": {
|
|
"properties": {
|
|
"detail": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ValidationError"
|
|
},
|
|
"title": "Detail",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "HTTPValidationError",
|
|
"type": "object"
|
|
},
|
|
"HttpToolConfig": {
|
|
"properties": {
|
|
"allowInterruptions": {
|
|
"default": true,
|
|
"title": "Allowinterruptions",
|
|
"type": "boolean"
|
|
},
|
|
"body": {
|
|
"additionalProperties": true,
|
|
"title": "Body",
|
|
"type": "object"
|
|
},
|
|
"executionMode": {
|
|
"default": "immediate",
|
|
"enum": [
|
|
"immediate",
|
|
"async"
|
|
],
|
|
"title": "Executionmode",
|
|
"type": "string"
|
|
},
|
|
"headers": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Headers",
|
|
"type": "object"
|
|
},
|
|
"method": {
|
|
"default": "GET",
|
|
"enum": [
|
|
"GET",
|
|
"POST",
|
|
"PUT",
|
|
"PATCH",
|
|
"DELETE"
|
|
],
|
|
"title": "Method",
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolParameter"
|
|
},
|
|
"title": "Parameters",
|
|
"type": "array"
|
|
},
|
|
"templateInputs": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolParameter"
|
|
},
|
|
"title": "Templateinputs",
|
|
"type": "array"
|
|
},
|
|
"timeoutSeconds": {
|
|
"default": 15,
|
|
"maximum": 120.0,
|
|
"minimum": 1.0,
|
|
"title": "Timeoutseconds",
|
|
"type": "integer"
|
|
},
|
|
"url": {
|
|
"title": "Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"url"
|
|
],
|
|
"title": "HttpToolConfig",
|
|
"type": "object"
|
|
},
|
|
"HttpToolDefinition": {
|
|
"properties": {
|
|
"config": {
|
|
"$ref": "#/components/schemas/HttpToolConfig"
|
|
},
|
|
"schemaVersion": {
|
|
"default": 2,
|
|
"title": "Schemaversion",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "http",
|
|
"default": "http",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"config"
|
|
],
|
|
"title": "HttpToolDefinition",
|
|
"type": "object"
|
|
},
|
|
"InputImageAssetOut": {
|
|
"properties": {
|
|
"assetToken": {
|
|
"title": "Assettoken",
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"title": "Height",
|
|
"type": "integer"
|
|
},
|
|
"sizeBytes": {
|
|
"title": "Sizebytes",
|
|
"type": "integer"
|
|
},
|
|
"width": {
|
|
"title": "Width",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"assetToken",
|
|
"width",
|
|
"height",
|
|
"sizeBytes"
|
|
],
|
|
"title": "InputImageAssetOut",
|
|
"type": "object"
|
|
},
|
|
"InputText": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "input_text",
|
|
"default": "input_text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "InputText",
|
|
"type": "object"
|
|
},
|
|
"InteractiveMediaRequestExtension": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"variables": {
|
|
"additionalProperties": true,
|
|
"title": "Variables",
|
|
"type": "object"
|
|
},
|
|
"version": {
|
|
"anyOf": [
|
|
{
|
|
"const": "1",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Interactive Media extension version. Omit or use `1`.",
|
|
"title": "Version"
|
|
}
|
|
},
|
|
"title": "InteractiveMediaRequestExtension",
|
|
"type": "object"
|
|
},
|
|
"InterfaceDefinitionOut": {
|
|
"properties": {
|
|
"capability": {
|
|
"enum": [
|
|
"LLM",
|
|
"ASR",
|
|
"TTS",
|
|
"Realtime",
|
|
"Embedding",
|
|
"Agent"
|
|
],
|
|
"title": "Capability",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"title": "Enabled",
|
|
"type": "boolean"
|
|
},
|
|
"fieldSchema": {
|
|
"additionalProperties": true,
|
|
"title": "Fieldschema",
|
|
"type": "object"
|
|
},
|
|
"interfaceType": {
|
|
"title": "Interfacetype",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"title": "Version",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"interfaceType",
|
|
"name",
|
|
"capability",
|
|
"fieldSchema",
|
|
"enabled",
|
|
"version"
|
|
],
|
|
"title": "InterfaceDefinitionOut",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeBaseOut": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"embeddingModelResourceId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Embeddingmodelresourceid"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"default": "active",
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Updatedat"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"id"
|
|
],
|
|
"title": "KnowledgeBaseOut",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeBaseUpsert": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"embeddingModelResourceId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Embeddingmodelresourceid"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "KnowledgeBaseUpsert",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeChunkOut": {
|
|
"properties": {
|
|
"chunkIndex": {
|
|
"title": "Chunkindex",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"title": "Content",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"chunkIndex",
|
|
"content"
|
|
],
|
|
"title": "KnowledgeChunkOut",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeDocumentOut": {
|
|
"properties": {
|
|
"chunkCount": {
|
|
"title": "Chunkcount",
|
|
"type": "integer"
|
|
},
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Createdat"
|
|
},
|
|
"errorMessage": {
|
|
"default": "",
|
|
"title": "Errormessage",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"knowledgeBaseId": {
|
|
"title": "Knowledgebaseid",
|
|
"type": "string"
|
|
},
|
|
"mimeType": {
|
|
"title": "Mimetype",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"sizeBytes": {
|
|
"title": "Sizebytes",
|
|
"type": "integer"
|
|
},
|
|
"sourceType": {
|
|
"title": "Sourcetype",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"knowledgeBaseId",
|
|
"name",
|
|
"sourceType",
|
|
"mimeType",
|
|
"sizeBytes",
|
|
"status",
|
|
"chunkCount"
|
|
],
|
|
"title": "KnowledgeDocumentOut",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeRetrievalConfig": {
|
|
"properties": {
|
|
"mode": {
|
|
"default": "automatic",
|
|
"enum": [
|
|
"automatic",
|
|
"on_demand"
|
|
],
|
|
"title": "Mode",
|
|
"type": "string"
|
|
},
|
|
"scoreThreshold": {
|
|
"default": 0.0,
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Scorethreshold",
|
|
"type": "number"
|
|
},
|
|
"topN": {
|
|
"default": 5,
|
|
"minimum": -1.0,
|
|
"title": "Topn",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "KnowledgeRetrievalConfig",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeSearchIn": {
|
|
"properties": {
|
|
"query": {
|
|
"minLength": 1,
|
|
"title": "Query",
|
|
"type": "string"
|
|
},
|
|
"topK": {
|
|
"default": 5,
|
|
"maximum": 20.0,
|
|
"minimum": 1.0,
|
|
"title": "Topk",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"query"
|
|
],
|
|
"title": "KnowledgeSearchIn",
|
|
"type": "object"
|
|
},
|
|
"KnowledgeTextIn": {
|
|
"properties": {
|
|
"content": {
|
|
"minLength": 1,
|
|
"title": "Content",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"content"
|
|
],
|
|
"title": "KnowledgeTextIn",
|
|
"type": "object"
|
|
},
|
|
"LiteralValueSource": {
|
|
"properties": {
|
|
"source": {
|
|
"const": "literal",
|
|
"default": "literal",
|
|
"title": "Source",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"title": "LiteralValueSource",
|
|
"type": "object"
|
|
},
|
|
"LlmStateExpression": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"minLength": 1,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"parameterName": {
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
|
|
"title": "Parametername",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "llm",
|
|
"default": "llm",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"valueType": {
|
|
"default": "string",
|
|
"enum": [
|
|
"string",
|
|
"number",
|
|
"boolean"
|
|
],
|
|
"title": "Valuetype",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"parameterName",
|
|
"description"
|
|
],
|
|
"title": "LlmStateExpression",
|
|
"type": "object"
|
|
},
|
|
"LoginIn": {
|
|
"properties": {
|
|
"password": {
|
|
"title": "Password",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"title": "Username",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password"
|
|
],
|
|
"title": "LoginIn",
|
|
"type": "object"
|
|
},
|
|
"McpServerOut": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"headers": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Headers",
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"lastSyncedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Lastsyncedat"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"secretHeaders": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Secretheaders",
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"default": "active",
|
|
"enum": [
|
|
"active",
|
|
"archived",
|
|
"draft"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"timeoutSeconds": {
|
|
"default": 30,
|
|
"maximum": 120.0,
|
|
"minimum": 1.0,
|
|
"title": "Timeoutseconds",
|
|
"type": "integer"
|
|
},
|
|
"toolCount": {
|
|
"default": 0,
|
|
"title": "Toolcount",
|
|
"type": "integer"
|
|
},
|
|
"transport": {
|
|
"default": "streamable_http",
|
|
"enum": [
|
|
"streamable_http",
|
|
"sse"
|
|
],
|
|
"title": "Transport",
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Updatedat"
|
|
},
|
|
"url": {
|
|
"maxLength": 2048,
|
|
"minLength": 1,
|
|
"title": "Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"url",
|
|
"id"
|
|
],
|
|
"title": "McpServerOut",
|
|
"type": "object"
|
|
},
|
|
"McpServerUpsert": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"headers": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Headers",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"secretHeaders": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Secretheaders",
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"default": "active",
|
|
"enum": [
|
|
"active",
|
|
"archived",
|
|
"draft"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"timeoutSeconds": {
|
|
"default": 30,
|
|
"maximum": 120.0,
|
|
"minimum": 1.0,
|
|
"title": "Timeoutseconds",
|
|
"type": "integer"
|
|
},
|
|
"transport": {
|
|
"default": "streamable_http",
|
|
"enum": [
|
|
"streamable_http",
|
|
"sse"
|
|
],
|
|
"title": "Transport",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"maxLength": 2048,
|
|
"minLength": 1,
|
|
"title": "Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"url"
|
|
],
|
|
"title": "McpServerUpsert",
|
|
"type": "object"
|
|
},
|
|
"McpSyncResult": {
|
|
"properties": {
|
|
"created": {
|
|
"title": "Created",
|
|
"type": "integer"
|
|
},
|
|
"server": {
|
|
"$ref": "#/components/schemas/McpServerOut"
|
|
},
|
|
"tools": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
},
|
|
"title": "Tools",
|
|
"type": "array"
|
|
},
|
|
"updated": {
|
|
"title": "Updated",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"server",
|
|
"created",
|
|
"updated",
|
|
"tools"
|
|
],
|
|
"title": "McpSyncResult",
|
|
"type": "object"
|
|
},
|
|
"McpToolConfig": {
|
|
"properties": {
|
|
"allowInterruptions": {
|
|
"default": true,
|
|
"title": "Allowinterruptions",
|
|
"type": "boolean"
|
|
},
|
|
"executionMode": {
|
|
"default": "immediate",
|
|
"enum": [
|
|
"immediate",
|
|
"async"
|
|
],
|
|
"title": "Executionmode",
|
|
"type": "string"
|
|
},
|
|
"inputSchema": {
|
|
"additionalProperties": true,
|
|
"title": "Inputschema",
|
|
"type": "object"
|
|
},
|
|
"remoteToolName": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"title": "Remotetoolname",
|
|
"type": "string"
|
|
},
|
|
"schemaHash": {
|
|
"default": "",
|
|
"title": "Schemahash",
|
|
"type": "string"
|
|
},
|
|
"templateInputs": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolParameter"
|
|
},
|
|
"title": "Templateinputs",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"remoteToolName"
|
|
],
|
|
"title": "McpToolConfig",
|
|
"type": "object"
|
|
},
|
|
"McpToolDefinition": {
|
|
"properties": {
|
|
"config": {
|
|
"$ref": "#/components/schemas/McpToolConfig"
|
|
},
|
|
"schemaVersion": {
|
|
"default": 2,
|
|
"title": "Schemaversion",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "mcp",
|
|
"default": "mcp",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"config"
|
|
],
|
|
"title": "McpToolDefinition",
|
|
"type": "object"
|
|
},
|
|
"ModelList": {
|
|
"additionalProperties": false,
|
|
"examples": [
|
|
{
|
|
"data": [
|
|
{
|
|
"assistant_id": "asst_xxx",
|
|
"assistant_type": "prompt",
|
|
"capabilities": [
|
|
"responses",
|
|
"realtime"
|
|
],
|
|
"created": 1788739200,
|
|
"id": "assistant:asst_xxx",
|
|
"name": "产品顾问",
|
|
"object": "model",
|
|
"owned_by": "interactive-media",
|
|
"runtime_mode": "pipeline"
|
|
}
|
|
],
|
|
"object": "list"
|
|
}
|
|
],
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ModelObject"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ModelList",
|
|
"type": "object"
|
|
},
|
|
"ModelObject": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"assistant_id": {
|
|
"title": "Assistant Id",
|
|
"type": "string"
|
|
},
|
|
"assistant_type": {
|
|
"title": "Assistant Type",
|
|
"type": "string"
|
|
},
|
|
"capabilities": {
|
|
"items": {
|
|
"enum": [
|
|
"responses",
|
|
"realtime"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"title": "Capabilities",
|
|
"type": "array"
|
|
},
|
|
"created": {
|
|
"title": "Created",
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "model",
|
|
"default": "model",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"owned_by": {
|
|
"default": "interactive-media",
|
|
"title": "Owned By",
|
|
"type": "string"
|
|
},
|
|
"runtime_mode": {
|
|
"title": "Runtime Mode",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"name",
|
|
"capabilities",
|
|
"assistant_id",
|
|
"assistant_type",
|
|
"runtime_mode"
|
|
],
|
|
"title": "ModelObject",
|
|
"type": "object"
|
|
},
|
|
"ModelResourceOut": {
|
|
"properties": {
|
|
"capability": {
|
|
"enum": [
|
|
"LLM",
|
|
"ASR",
|
|
"TTS",
|
|
"Realtime",
|
|
"Embedding",
|
|
"Agent"
|
|
],
|
|
"title": "Capability",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"default": true,
|
|
"title": "Enabled",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"interfaceType": {
|
|
"title": "Interfacetype",
|
|
"type": "string"
|
|
},
|
|
"isDefault": {
|
|
"default": false,
|
|
"title": "Isdefault",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"secrets": {
|
|
"additionalProperties": true,
|
|
"title": "Secrets",
|
|
"type": "object"
|
|
},
|
|
"supportImageInput": {
|
|
"default": false,
|
|
"title": "Supportimageinput",
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Updatedat"
|
|
},
|
|
"values": {
|
|
"additionalProperties": true,
|
|
"title": "Values",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"interfaceType",
|
|
"id",
|
|
"capability"
|
|
],
|
|
"title": "ModelResourceOut",
|
|
"type": "object"
|
|
},
|
|
"ModelResourceTestResult": {
|
|
"properties": {
|
|
"detail": {
|
|
"default": "",
|
|
"title": "Detail",
|
|
"type": "string"
|
|
},
|
|
"latencyMs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Latencyms"
|
|
},
|
|
"message": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"ok": {
|
|
"title": "Ok",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"message"
|
|
],
|
|
"title": "ModelResourceTestResult",
|
|
"type": "object"
|
|
},
|
|
"ModelResourceUpsert": {
|
|
"properties": {
|
|
"enabled": {
|
|
"default": true,
|
|
"title": "Enabled",
|
|
"type": "boolean"
|
|
},
|
|
"interfaceType": {
|
|
"title": "Interfacetype",
|
|
"type": "string"
|
|
},
|
|
"isDefault": {
|
|
"default": false,
|
|
"title": "Isdefault",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"secrets": {
|
|
"additionalProperties": true,
|
|
"title": "Secrets",
|
|
"type": "object"
|
|
},
|
|
"supportImageInput": {
|
|
"default": false,
|
|
"title": "Supportimageinput",
|
|
"type": "boolean"
|
|
},
|
|
"values": {
|
|
"additionalProperties": true,
|
|
"title": "Values",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"interfaceType"
|
|
],
|
|
"title": "ModelResourceUpsert",
|
|
"type": "object"
|
|
},
|
|
"ModelValueSource": {
|
|
"properties": {
|
|
"source": {
|
|
"const": "model",
|
|
"default": "model",
|
|
"title": "Source",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "ModelValueSource",
|
|
"type": "object"
|
|
},
|
|
"OpenAIErrorDetail": {
|
|
"additionalProperties": false,
|
|
"description": "Error shape consumed by official OpenAI SDKs.",
|
|
"properties": {
|
|
"code": {
|
|
"title": "Code",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"param": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Param"
|
|
},
|
|
"type": {
|
|
"default": "invalid_request_error",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"title": "OpenAIErrorDetail",
|
|
"type": "object"
|
|
},
|
|
"OpenAIErrorResponse": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"error": {
|
|
"$ref": "#/components/schemas/OpenAIErrorDetail"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"title": "OpenAIErrorResponse",
|
|
"type": "object"
|
|
},
|
|
"OpeningMessageConfig": {
|
|
"description": "Built-in Prompt opening interaction; it is not a reusable LLM tool.",
|
|
"properties": {
|
|
"confirmLabel": {
|
|
"default": "确认",
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Confirmlabel",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"maxLength": 2000,
|
|
"minLength": 1,
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"default": "重要提示",
|
|
"maxLength": 120,
|
|
"minLength": 1,
|
|
"title": "Title",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
],
|
|
"title": "OpeningMessageConfig",
|
|
"type": "object"
|
|
},
|
|
"OperationStateExpression-Input": {
|
|
"properties": {
|
|
"operands": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Input",
|
|
"and": "#/components/schemas/OperationStateExpression-Input",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Input",
|
|
"eq": "#/components/schemas/OperationStateExpression-Input",
|
|
"gt": "#/components/schemas/OperationStateExpression-Input",
|
|
"gte": "#/components/schemas/OperationStateExpression-Input",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Input",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Input",
|
|
"lte": "#/components/schemas/OperationStateExpression-Input",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Input",
|
|
"neq": "#/components/schemas/OperationStateExpression-Input",
|
|
"or": "#/components/schemas/OperationStateExpression-Input",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Input",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Input"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 10,
|
|
"minItems": 2,
|
|
"title": "Operands",
|
|
"type": "array"
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"and",
|
|
"or",
|
|
"eq",
|
|
"neq",
|
|
"gt",
|
|
"gte",
|
|
"lt",
|
|
"lte",
|
|
"add",
|
|
"subtract",
|
|
"multiply",
|
|
"divide"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"operands"
|
|
],
|
|
"title": "OperationStateExpression",
|
|
"type": "object"
|
|
},
|
|
"OperationStateExpression-Output": {
|
|
"properties": {
|
|
"operands": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Output",
|
|
"and": "#/components/schemas/OperationStateExpression-Output",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Output",
|
|
"eq": "#/components/schemas/OperationStateExpression-Output",
|
|
"gt": "#/components/schemas/OperationStateExpression-Output",
|
|
"gte": "#/components/schemas/OperationStateExpression-Output",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Output",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Output",
|
|
"lte": "#/components/schemas/OperationStateExpression-Output",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Output",
|
|
"neq": "#/components/schemas/OperationStateExpression-Output",
|
|
"or": "#/components/schemas/OperationStateExpression-Output",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Output",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Output"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 10,
|
|
"minItems": 2,
|
|
"title": "Operands",
|
|
"type": "array"
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"and",
|
|
"or",
|
|
"eq",
|
|
"neq",
|
|
"gt",
|
|
"gte",
|
|
"lt",
|
|
"lte",
|
|
"add",
|
|
"subtract",
|
|
"multiply",
|
|
"divide"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"operands"
|
|
],
|
|
"title": "OperationStateExpression",
|
|
"type": "object"
|
|
},
|
|
"OutputTextInput": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"annotations": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Annotations",
|
|
"type": "array"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "output_text",
|
|
"default": "output_text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "OutputTextInput",
|
|
"type": "object"
|
|
},
|
|
"OverallCriterion": {
|
|
"properties": {
|
|
"criteria": {
|
|
"maxLength": 2000,
|
|
"minLength": 1,
|
|
"title": "Criteria",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 80,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "llm",
|
|
"default": "llm",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"criteria"
|
|
],
|
|
"title": "OverallCriterion",
|
|
"type": "object"
|
|
},
|
|
"PromptImprovementChange": {
|
|
"properties": {
|
|
"after": {
|
|
"maxLength": 100000,
|
|
"minLength": 1,
|
|
"title": "After",
|
|
"type": "string"
|
|
},
|
|
"before": {
|
|
"maxLength": 100000,
|
|
"title": "Before",
|
|
"type": "string"
|
|
},
|
|
"evidence": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 8,
|
|
"title": "Evidence",
|
|
"type": "array"
|
|
},
|
|
"reason": {
|
|
"maxLength": 4000,
|
|
"minLength": 1,
|
|
"title": "Reason",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"before",
|
|
"after",
|
|
"reason"
|
|
],
|
|
"title": "PromptImprovementChange",
|
|
"type": "object"
|
|
},
|
|
"PromptImprovementManualRecommendation": {
|
|
"properties": {
|
|
"category": {
|
|
"enum": [
|
|
"tool",
|
|
"test_case",
|
|
"other"
|
|
],
|
|
"title": "Category",
|
|
"type": "string"
|
|
},
|
|
"detail": {
|
|
"maxLength": 4000,
|
|
"minLength": 1,
|
|
"title": "Detail",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"maxLength": 200,
|
|
"minLength": 1,
|
|
"title": "Title",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"category",
|
|
"title",
|
|
"detail"
|
|
],
|
|
"title": "PromptImprovementManualRecommendation",
|
|
"type": "object"
|
|
},
|
|
"PromptImprovementOut": {
|
|
"properties": {
|
|
"diagnosis": {
|
|
"maxLength": 4000,
|
|
"minLength": 1,
|
|
"title": "Diagnosis",
|
|
"type": "string"
|
|
},
|
|
"evaluatorName": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Evaluatorname",
|
|
"type": "string"
|
|
},
|
|
"manualRecommendations": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PromptImprovementManualRecommendation"
|
|
},
|
|
"maxItems": 20,
|
|
"title": "Manualrecommendations",
|
|
"type": "array"
|
|
},
|
|
"promptChange": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PromptImprovementChange"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"diagnosis",
|
|
"evaluatorName"
|
|
],
|
|
"title": "PromptImprovementOut",
|
|
"type": "object"
|
|
},
|
|
"RealtimeApiKeyCreate": {
|
|
"properties": {
|
|
"expiresAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Expiresat"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "RealtimeApiKeyCreate",
|
|
"type": "object"
|
|
},
|
|
"RealtimeApiKeyCreated": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"title": "Createdat",
|
|
"type": "string"
|
|
},
|
|
"expiresAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Expiresat"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"title": "Key",
|
|
"type": "string"
|
|
},
|
|
"keyPrefix": {
|
|
"title": "Keyprefix",
|
|
"type": "string"
|
|
},
|
|
"lastUsedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Lastusedat"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"revokedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Revokedat"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"active",
|
|
"expired",
|
|
"revoked"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"keyPrefix",
|
|
"status",
|
|
"createdAt",
|
|
"key"
|
|
],
|
|
"title": "RealtimeApiKeyCreated",
|
|
"type": "object"
|
|
},
|
|
"RealtimeApiKeyOut": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"title": "Createdat",
|
|
"type": "string"
|
|
},
|
|
"expiresAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Expiresat"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"keyPrefix": {
|
|
"title": "Keyprefix",
|
|
"type": "string"
|
|
},
|
|
"lastUsedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Lastusedat"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"revokedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Revokedat"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"active",
|
|
"expired",
|
|
"revoked"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"keyPrefix",
|
|
"status",
|
|
"createdAt"
|
|
],
|
|
"title": "RealtimeApiKeyOut",
|
|
"type": "object"
|
|
},
|
|
"RealtimeClientSecretRequest": {
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"session": {
|
|
"$ref": "#/components/schemas/RealtimeSessionRequest"
|
|
}
|
|
},
|
|
"required": [
|
|
"session"
|
|
],
|
|
"title": "RealtimeClientSecretRequest",
|
|
"type": "object"
|
|
},
|
|
"RealtimeClientSecretResponse": {
|
|
"additionalProperties": false,
|
|
"examples": [
|
|
{
|
|
"expires_at": 1788739260,
|
|
"session": {
|
|
"model": "assistant:asst_xxx",
|
|
"output_modalities": [
|
|
"audio"
|
|
],
|
|
"type": "realtime"
|
|
},
|
|
"value": "ek-rt-..."
|
|
}
|
|
],
|
|
"properties": {
|
|
"expires_at": {
|
|
"title": "Expires At",
|
|
"type": "integer"
|
|
},
|
|
"session": {
|
|
"additionalProperties": true,
|
|
"title": "Session",
|
|
"type": "object"
|
|
},
|
|
"value": {
|
|
"title": "Value",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"value",
|
|
"expires_at",
|
|
"session"
|
|
],
|
|
"title": "RealtimeClientSecretResponse",
|
|
"type": "object"
|
|
},
|
|
"RealtimeSessionRequest": {
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"audio": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Audio"
|
|
},
|
|
"instructions": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Platform-owned in subset v1; requests containing it are rejected.",
|
|
"title": "Instructions"
|
|
},
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string"
|
|
},
|
|
"output_modalities": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"enum": [
|
|
"audio",
|
|
"text"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Output Modalities"
|
|
},
|
|
"tool_choice": {
|
|
"anyOf": [
|
|
{},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Platform-owned in subset v1; requests containing it are rejected.",
|
|
"title": "Tool Choice"
|
|
},
|
|
"tools": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Platform-owned in subset v1; requests containing it are rejected.",
|
|
"title": "Tools"
|
|
},
|
|
"turn_detection": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Turn Detection"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"const": "realtime",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Type"
|
|
},
|
|
"voice": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Platform-owned in subset v1; requests containing it are rejected.",
|
|
"title": "Voice"
|
|
}
|
|
},
|
|
"required": [
|
|
"model"
|
|
],
|
|
"title": "RealtimeSessionRequest",
|
|
"type": "object"
|
|
},
|
|
"ReplyExpectedBehavior": {
|
|
"properties": {
|
|
"assertionType": {
|
|
"enum": [
|
|
"keyword",
|
|
"llm"
|
|
],
|
|
"title": "Assertiontype",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"keywordMatchMode": {
|
|
"default": "any",
|
|
"enum": [
|
|
"any",
|
|
"all"
|
|
],
|
|
"title": "Keywordmatchmode",
|
|
"type": "string"
|
|
},
|
|
"keywords": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 50,
|
|
"title": "Keywords",
|
|
"type": "array"
|
|
},
|
|
"llmCriteria": {
|
|
"default": "",
|
|
"maxLength": 4000,
|
|
"title": "Llmcriteria",
|
|
"type": "string"
|
|
},
|
|
"negateKeywords": {
|
|
"default": false,
|
|
"title": "Negatekeywords",
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"const": "reply",
|
|
"default": "reply",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"assertionType"
|
|
],
|
|
"title": "ReplyExpectedBehavior",
|
|
"type": "object"
|
|
},
|
|
"ResponseCreateRequest": {
|
|
"additionalProperties": true,
|
|
"description": "Supported request fields; extras are preserved for semantic rejection.",
|
|
"examples": [
|
|
{
|
|
"input": "请介绍一下这个产品",
|
|
"model": "assistant:asst_xxx",
|
|
"store": true
|
|
},
|
|
{
|
|
"input": "继续说明",
|
|
"previous_response_id": "resp_xxx",
|
|
"stream": true
|
|
}
|
|
],
|
|
"properties": {
|
|
"input": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"function_call_output": "#/components/schemas/ResponseFunctionCallOutputInput",
|
|
"message": "#/components/schemas/ResponseInputMessage"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResponseInputMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ResponseFunctionCallOutputInput"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Input"
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Required on the first turn; inherited on later turns.",
|
|
"examples": [
|
|
"assistant:asst_xxx"
|
|
],
|
|
"title": "Model"
|
|
},
|
|
"previous_response_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Previous Response Id"
|
|
},
|
|
"store": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Stateful subset: omit this field or set it to true.",
|
|
"title": "Store"
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
},
|
|
"x_interactive_media": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InteractiveMediaRequestExtension"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"input"
|
|
],
|
|
"title": "ResponseCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"ResponseError": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"code": {
|
|
"title": "Code",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"title": "ResponseError",
|
|
"type": "object"
|
|
},
|
|
"ResponseFunctionCall": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"arguments": {
|
|
"title": "Arguments",
|
|
"type": "string"
|
|
},
|
|
"call_id": {
|
|
"title": "Call Id",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"in_progress",
|
|
"completed",
|
|
"incomplete"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "function_call",
|
|
"default": "function_call",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"status",
|
|
"call_id",
|
|
"name",
|
|
"arguments"
|
|
],
|
|
"title": "ResponseFunctionCall",
|
|
"type": "object"
|
|
},
|
|
"ResponseFunctionCallOutputInput": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"call_id": {
|
|
"title": "Call Id",
|
|
"type": "string"
|
|
},
|
|
"output": {
|
|
"title": "Output"
|
|
},
|
|
"type": {
|
|
"const": "function_call_output",
|
|
"default": "function_call_output",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"call_id",
|
|
"output"
|
|
],
|
|
"title": "ResponseFunctionCallOutputInput",
|
|
"type": "object"
|
|
},
|
|
"ResponseFunctionCallOutputItem": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"call_id": {
|
|
"title": "Call Id",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"output": {
|
|
"title": "Output",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"default": "completed",
|
|
"enum": [
|
|
"in_progress",
|
|
"completed",
|
|
"incomplete"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "function_call_output",
|
|
"default": "function_call_output",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"call_id",
|
|
"output"
|
|
],
|
|
"title": "ResponseFunctionCallOutputItem",
|
|
"type": "object"
|
|
},
|
|
"ResponseInputItemList": {
|
|
"additionalProperties": false,
|
|
"examples": [
|
|
{
|
|
"data": [
|
|
{
|
|
"content": [
|
|
{
|
|
"text": "你好",
|
|
"type": "input_text"
|
|
}
|
|
],
|
|
"id": "msg_input_xxx",
|
|
"role": "user",
|
|
"status": "completed",
|
|
"type": "message"
|
|
}
|
|
],
|
|
"first_id": "msg_input_xxx",
|
|
"has_more": false,
|
|
"last_id": "msg_input_xxx",
|
|
"object": "list"
|
|
}
|
|
],
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"function_call_output": "#/components/schemas/ResponseFunctionCallOutputItem",
|
|
"message": "#/components/schemas/ResponseInputMessageItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResponseInputMessageItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ResponseFunctionCallOutputItem"
|
|
}
|
|
]
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"first_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "First Id"
|
|
},
|
|
"has_more": {
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
},
|
|
"last_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Last Id"
|
|
},
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"has_more"
|
|
],
|
|
"title": "ResponseInputItemList",
|
|
"type": "object"
|
|
},
|
|
"ResponseInputMessage": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"input_text": "#/components/schemas/InputText",
|
|
"output_text": "#/components/schemas/OutputTextInput"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InputText"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OutputTextInput"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"role": {
|
|
"default": "user",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
],
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "message",
|
|
"default": "message",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "ResponseInputMessage",
|
|
"type": "object"
|
|
},
|
|
"ResponseInputMessageItem": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"content": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"input_text": "#/components/schemas/InputText",
|
|
"output_text": "#/components/schemas/OutputTextInput"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InputText"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OutputTextInput"
|
|
}
|
|
]
|
|
},
|
|
"title": "Content",
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
],
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"default": "completed",
|
|
"enum": [
|
|
"in_progress",
|
|
"completed",
|
|
"incomplete"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "message",
|
|
"default": "message",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role",
|
|
"content"
|
|
],
|
|
"title": "ResponseInputMessageItem",
|
|
"type": "object"
|
|
},
|
|
"ResponseObject": {
|
|
"additionalProperties": false,
|
|
"examples": [
|
|
{
|
|
"completed_at": 1788739201,
|
|
"created_at": 1788739200,
|
|
"id": "resp_xxx",
|
|
"metadata": {},
|
|
"model": "assistant:asst_xxx",
|
|
"object": "response",
|
|
"output": [
|
|
{
|
|
"content": [
|
|
{
|
|
"annotations": [],
|
|
"text": "这是一个实时对话助手。",
|
|
"type": "output_text"
|
|
}
|
|
],
|
|
"id": "msg_xxx",
|
|
"role": "assistant",
|
|
"status": "completed",
|
|
"type": "message"
|
|
}
|
|
],
|
|
"parallel_tool_calls": false,
|
|
"status": "completed",
|
|
"store": true,
|
|
"tool_choice": "auto",
|
|
"tools": []
|
|
}
|
|
],
|
|
"properties": {
|
|
"completed_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Completed At"
|
|
},
|
|
"created_at": {
|
|
"title": "Created At",
|
|
"type": "integer"
|
|
},
|
|
"error": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResponseError"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"incomplete_details": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Incomplete Details"
|
|
},
|
|
"instructions": {
|
|
"title": "Instructions",
|
|
"type": "null"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Metadata",
|
|
"type": "object"
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model"
|
|
},
|
|
"object": {
|
|
"const": "response",
|
|
"default": "response",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"output": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"function_call": "#/components/schemas/ResponseFunctionCall",
|
|
"message": "#/components/schemas/ResponseOutputMessage"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResponseOutputMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ResponseFunctionCall"
|
|
}
|
|
]
|
|
},
|
|
"title": "Output",
|
|
"type": "array"
|
|
},
|
|
"parallel_tool_calls": {
|
|
"const": false,
|
|
"default": false,
|
|
"title": "Parallel Tool Calls",
|
|
"type": "boolean"
|
|
},
|
|
"previous_response_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Previous Response Id"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"in_progress",
|
|
"completed",
|
|
"failed",
|
|
"cancelled",
|
|
"incomplete"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"store": {
|
|
"const": true,
|
|
"default": true,
|
|
"title": "Store",
|
|
"type": "boolean"
|
|
},
|
|
"tool_choice": {
|
|
"const": "auto",
|
|
"default": "auto",
|
|
"title": "Tool Choice",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"items": {},
|
|
"title": "Tools",
|
|
"type": "array"
|
|
},
|
|
"usage": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResponseUsage"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created_at",
|
|
"status",
|
|
"model",
|
|
"output"
|
|
],
|
|
"title": "ResponseObject",
|
|
"type": "object"
|
|
},
|
|
"ResponseOutputMessage": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"content": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ResponseOutputText"
|
|
},
|
|
"title": "Content",
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"const": "assistant",
|
|
"default": "assistant",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"in_progress",
|
|
"completed",
|
|
"incomplete"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "message",
|
|
"default": "message",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"status",
|
|
"content"
|
|
],
|
|
"title": "ResponseOutputMessage",
|
|
"type": "object"
|
|
},
|
|
"ResponseOutputText": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"annotations": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Annotations",
|
|
"type": "array"
|
|
},
|
|
"logprobs": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Logprobs"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "output_text",
|
|
"default": "output_text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "ResponseOutputText",
|
|
"type": "object"
|
|
},
|
|
"ResponseUsage": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"input_tokens": {
|
|
"title": "Input Tokens",
|
|
"type": "integer"
|
|
},
|
|
"input_tokens_details": {
|
|
"additionalProperties": true,
|
|
"title": "Input Tokens Details",
|
|
"type": "object"
|
|
},
|
|
"output_tokens": {
|
|
"title": "Output Tokens",
|
|
"type": "integer"
|
|
},
|
|
"output_tokens_details": {
|
|
"additionalProperties": true,
|
|
"title": "Output Tokens Details",
|
|
"type": "object"
|
|
},
|
|
"total_tokens": {
|
|
"title": "Total Tokens",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"input_tokens",
|
|
"output_tokens",
|
|
"total_tokens"
|
|
],
|
|
"title": "ResponseUsage",
|
|
"type": "object"
|
|
},
|
|
"SequenceToolSimulation": {
|
|
"properties": {
|
|
"functionName": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Functionname",
|
|
"type": "string"
|
|
},
|
|
"mode": {
|
|
"const": "sequence",
|
|
"default": "sequence",
|
|
"title": "Mode",
|
|
"type": "string"
|
|
},
|
|
"steps": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolSimulationStep"
|
|
},
|
|
"maxItems": 10000,
|
|
"minItems": 1,
|
|
"title": "Steps",
|
|
"type": "array"
|
|
},
|
|
"toolId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Toolid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"toolId",
|
|
"functionName",
|
|
"steps"
|
|
],
|
|
"title": "SequenceToolSimulation",
|
|
"type": "object"
|
|
},
|
|
"StartupAction": {
|
|
"properties": {
|
|
"id": {
|
|
"maxLength": 64,
|
|
"minLength": 1,
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_-]*$",
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"phase": {
|
|
"default": "opening",
|
|
"enum": [
|
|
"preflight",
|
|
"opening"
|
|
],
|
|
"title": "Phase",
|
|
"type": "string"
|
|
},
|
|
"required": {
|
|
"default": true,
|
|
"title": "Required",
|
|
"type": "boolean"
|
|
},
|
|
"toolBinding": {
|
|
"$ref": "#/components/schemas/ToolBinding"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"toolBinding"
|
|
],
|
|
"title": "StartupAction",
|
|
"type": "object"
|
|
},
|
|
"StartupConfig": {
|
|
"properties": {
|
|
"actions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/StartupAction"
|
|
},
|
|
"maxItems": 5,
|
|
"title": "Actions",
|
|
"type": "array"
|
|
},
|
|
"entryMode": {
|
|
"default": "wait_user",
|
|
"enum": [
|
|
"wait_user",
|
|
"generate"
|
|
],
|
|
"title": "Entrymode",
|
|
"type": "string"
|
|
},
|
|
"executionMode": {
|
|
"const": "sequential",
|
|
"default": "sequential",
|
|
"title": "Executionmode",
|
|
"type": "string"
|
|
},
|
|
"openingMessage": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpeningMessageConfig"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"openingMode": {
|
|
"default": "interruptible",
|
|
"enum": [
|
|
"interruptible",
|
|
"playback",
|
|
"confirmation"
|
|
],
|
|
"title": "Openingmode",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "StartupConfig",
|
|
"type": "object"
|
|
},
|
|
"StartupToolSimulationScope": {
|
|
"properties": {
|
|
"phase": {
|
|
"const": "startup",
|
|
"default": "startup",
|
|
"title": "Phase",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "StartupToolSimulationScope",
|
|
"type": "object"
|
|
},
|
|
"StateUpdateRule-Input": {
|
|
"properties": {
|
|
"expression": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Input",
|
|
"and": "#/components/schemas/OperationStateExpression-Input",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Input",
|
|
"eq": "#/components/schemas/OperationStateExpression-Input",
|
|
"gt": "#/components/schemas/OperationStateExpression-Input",
|
|
"gte": "#/components/schemas/OperationStateExpression-Input",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Input",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Input",
|
|
"lte": "#/components/schemas/OperationStateExpression-Input",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Input",
|
|
"neq": "#/components/schemas/OperationStateExpression-Input",
|
|
"or": "#/components/schemas/OperationStateExpression-Input",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Input",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Input"
|
|
}
|
|
],
|
|
"title": "Expression"
|
|
},
|
|
"variableName": {
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
|
|
"title": "Variablename",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"variableName",
|
|
"expression"
|
|
],
|
|
"title": "StateUpdateRule",
|
|
"type": "object"
|
|
},
|
|
"StateUpdateRule-Output": {
|
|
"properties": {
|
|
"expression": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"add": "#/components/schemas/OperationStateExpression-Output",
|
|
"and": "#/components/schemas/OperationStateExpression-Output",
|
|
"constant": "#/components/schemas/ConstantStateExpression",
|
|
"divide": "#/components/schemas/OperationStateExpression-Output",
|
|
"eq": "#/components/schemas/OperationStateExpression-Output",
|
|
"gt": "#/components/schemas/OperationStateExpression-Output",
|
|
"gte": "#/components/schemas/OperationStateExpression-Output",
|
|
"if": "#/components/schemas/ConditionalStateExpression-Output",
|
|
"llm": "#/components/schemas/LlmStateExpression",
|
|
"lt": "#/components/schemas/OperationStateExpression-Output",
|
|
"lte": "#/components/schemas/OperationStateExpression-Output",
|
|
"multiply": "#/components/schemas/OperationStateExpression-Output",
|
|
"neq": "#/components/schemas/OperationStateExpression-Output",
|
|
"or": "#/components/schemas/OperationStateExpression-Output",
|
|
"subtract": "#/components/schemas/OperationStateExpression-Output",
|
|
"variable": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConstantStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LlmStateExpression"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OperationStateExpression-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalStateExpression-Output"
|
|
}
|
|
],
|
|
"title": "Expression"
|
|
},
|
|
"variableName": {
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
|
|
"title": "Variablename",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"variableName",
|
|
"expression"
|
|
],
|
|
"title": "StateUpdateRule",
|
|
"type": "object"
|
|
},
|
|
"TemplateValueSource": {
|
|
"properties": {
|
|
"source": {
|
|
"const": "template",
|
|
"default": "template",
|
|
"title": "Source",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
],
|
|
"title": "TemplateValueSource",
|
|
"type": "object"
|
|
},
|
|
"TestCaseBulkDeleteIn": {
|
|
"properties": {
|
|
"caseIds": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 1000,
|
|
"minItems": 1,
|
|
"title": "Caseids",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"caseIds"
|
|
],
|
|
"title": "TestCaseBulkDeleteIn",
|
|
"type": "object"
|
|
},
|
|
"TestCaseOrderIn": {
|
|
"properties": {
|
|
"caseIds": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 1000,
|
|
"minItems": 1,
|
|
"title": "Caseids",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"caseIds"
|
|
],
|
|
"title": "TestCaseOrderIn",
|
|
"type": "object"
|
|
},
|
|
"TestCaseOut": {
|
|
"properties": {
|
|
"contextTurns": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ContextTurn"
|
|
},
|
|
"maxItems": 100,
|
|
"title": "Contextturns",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"inputMode": {
|
|
"default": "fixed_script_text",
|
|
"enum": [
|
|
"fixed_script_text",
|
|
"fixed_script_turn_voice",
|
|
"fixed_script_continuous_voice",
|
|
"user_sim_text",
|
|
"user_sim_voice"
|
|
],
|
|
"title": "Inputmode",
|
|
"type": "string"
|
|
},
|
|
"lastResult": {
|
|
"enum": [
|
|
"pass",
|
|
"fail",
|
|
"not_run"
|
|
],
|
|
"title": "Lastresult",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"overallCriteria": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OverallCriterion"
|
|
},
|
|
"maxItems": 50,
|
|
"title": "Overallcriteria",
|
|
"type": "array"
|
|
},
|
|
"sortOrder": {
|
|
"title": "Sortorder",
|
|
"type": "integer"
|
|
},
|
|
"suiteId": {
|
|
"title": "Suiteid",
|
|
"type": "string"
|
|
},
|
|
"toolSimulations": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"fixed": "#/components/schemas/FixedToolSimulation",
|
|
"sequence": "#/components/schemas/SequenceToolSimulation"
|
|
},
|
|
"propertyName": "mode"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FixedToolSimulation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SequenceToolSimulation"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 100,
|
|
"title": "Toolsimulations",
|
|
"type": "array"
|
|
},
|
|
"turns": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/FixedInputTurn"
|
|
},
|
|
"maxItems": 100,
|
|
"minItems": 1,
|
|
"title": "Turns",
|
|
"type": "array"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"title": "Updatedat",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"turns",
|
|
"id",
|
|
"suiteId",
|
|
"lastResult",
|
|
"sortOrder",
|
|
"updatedAt"
|
|
],
|
|
"title": "TestCaseOut",
|
|
"type": "object"
|
|
},
|
|
"TestCaseWrite": {
|
|
"properties": {
|
|
"contextTurns": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ContextTurn"
|
|
},
|
|
"maxItems": 100,
|
|
"title": "Contextturns",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"inputMode": {
|
|
"default": "fixed_script_text",
|
|
"enum": [
|
|
"fixed_script_text",
|
|
"fixed_script_turn_voice",
|
|
"fixed_script_continuous_voice",
|
|
"user_sim_text",
|
|
"user_sim_voice"
|
|
],
|
|
"title": "Inputmode",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"overallCriteria": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OverallCriterion"
|
|
},
|
|
"maxItems": 50,
|
|
"title": "Overallcriteria",
|
|
"type": "array"
|
|
},
|
|
"toolSimulations": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"fixed": "#/components/schemas/FixedToolSimulation",
|
|
"sequence": "#/components/schemas/SequenceToolSimulation"
|
|
},
|
|
"propertyName": "mode"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FixedToolSimulation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SequenceToolSimulation"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 100,
|
|
"title": "Toolsimulations",
|
|
"type": "array"
|
|
},
|
|
"turns": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/FixedInputTurn"
|
|
},
|
|
"maxItems": 100,
|
|
"minItems": 1,
|
|
"title": "Turns",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"turns"
|
|
],
|
|
"title": "TestCaseWrite",
|
|
"type": "object"
|
|
},
|
|
"TestImageAssetOut": {
|
|
"properties": {
|
|
"contentUrl": {
|
|
"title": "Contenturl",
|
|
"type": "string"
|
|
},
|
|
"filename": {
|
|
"title": "Filename",
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"title": "Height",
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"sizeBytes": {
|
|
"title": "Sizebytes",
|
|
"type": "integer"
|
|
},
|
|
"width": {
|
|
"title": "Width",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"filename",
|
|
"width",
|
|
"height",
|
|
"sizeBytes",
|
|
"contentUrl"
|
|
],
|
|
"title": "TestImageAssetOut",
|
|
"type": "object"
|
|
},
|
|
"TestImageRef": {
|
|
"properties": {
|
|
"assetId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Assetid",
|
|
"type": "string"
|
|
},
|
|
"filename": {
|
|
"default": "image.jpg",
|
|
"maxLength": 255,
|
|
"title": "Filename",
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"minimum": 1.0,
|
|
"title": "Height",
|
|
"type": "integer"
|
|
},
|
|
"sizeBytes": {
|
|
"default": 0,
|
|
"minimum": 0.0,
|
|
"title": "Sizebytes",
|
|
"type": "integer"
|
|
},
|
|
"width": {
|
|
"minimum": 1.0,
|
|
"title": "Width",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"assetId",
|
|
"width",
|
|
"height"
|
|
],
|
|
"title": "TestImageRef",
|
|
"type": "object"
|
|
},
|
|
"TestSuiteCreate": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "TestSuiteCreate",
|
|
"type": "object"
|
|
},
|
|
"TestSuiteOut": {
|
|
"properties": {
|
|
"caseCount": {
|
|
"default": 0,
|
|
"title": "Casecount",
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"passedCount": {
|
|
"default": 0,
|
|
"title": "Passedcount",
|
|
"type": "integer"
|
|
},
|
|
"runCount": {
|
|
"default": 0,
|
|
"title": "Runcount",
|
|
"type": "integer"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"title": "Updatedat",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"description",
|
|
"updatedAt"
|
|
],
|
|
"title": "TestSuiteOut",
|
|
"type": "object"
|
|
},
|
|
"TestSuiteUpdate": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "TestSuiteUpdate",
|
|
"type": "object"
|
|
},
|
|
"ToolBinding": {
|
|
"description": "One assistant/stage-specific use of a reusable external tool.",
|
|
"properties": {
|
|
"argumentBindings": {
|
|
"additionalProperties": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"literal": "#/components/schemas/LiteralValueSource",
|
|
"model": "#/components/schemas/ModelValueSource",
|
|
"template": "#/components/schemas/TemplateValueSource",
|
|
"variable": "#/components/schemas/VariableValueSource"
|
|
},
|
|
"propertyName": "source"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ModelValueSource"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VariableValueSource"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LiteralValueSource"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TemplateValueSource"
|
|
}
|
|
]
|
|
},
|
|
"title": "Argumentbindings",
|
|
"type": "object"
|
|
},
|
|
"resultAssignments": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Resultassignments",
|
|
"type": "object"
|
|
},
|
|
"templateBindings": {
|
|
"additionalProperties": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"literal": "#/components/schemas/LiteralValueSource",
|
|
"template": "#/components/schemas/TemplateValueSource",
|
|
"variable": "#/components/schemas/VariableValueSource"
|
|
},
|
|
"propertyName": "source"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VariableValueSource"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LiteralValueSource"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TemplateValueSource"
|
|
}
|
|
]
|
|
},
|
|
"title": "Templatebindings",
|
|
"type": "object"
|
|
},
|
|
"toolId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Toolid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"toolId"
|
|
],
|
|
"title": "ToolBinding",
|
|
"type": "object"
|
|
},
|
|
"ToolCallExpectedBehavior": {
|
|
"properties": {
|
|
"expectation": {
|
|
"enum": [
|
|
"called",
|
|
"not_called"
|
|
],
|
|
"title": "Expectation",
|
|
"type": "string"
|
|
},
|
|
"functionName": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Functionname",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"maxCalls": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 100.0,
|
|
"minimum": 0.0,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Maxcalls"
|
|
},
|
|
"minCalls": {
|
|
"default": 1,
|
|
"maximum": 100.0,
|
|
"minimum": 0.0,
|
|
"title": "Mincalls",
|
|
"type": "integer"
|
|
},
|
|
"paramAssertions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolParamAssertion"
|
|
},
|
|
"maxItems": 50,
|
|
"title": "Paramassertions",
|
|
"type": "array"
|
|
},
|
|
"toolId": {
|
|
"maxLength": 40,
|
|
"minLength": 1,
|
|
"title": "Toolid",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "tool_call",
|
|
"default": "tool_call",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"toolId",
|
|
"functionName",
|
|
"expectation"
|
|
],
|
|
"title": "ToolCallExpectedBehavior",
|
|
"type": "object"
|
|
},
|
|
"ToolOut": {
|
|
"properties": {
|
|
"definition": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"client": "#/components/schemas/ClientToolDefinition",
|
|
"http": "#/components/schemas/HttpToolDefinition",
|
|
"mcp": "#/components/schemas/McpToolDefinition"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HttpToolDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ClientToolDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/McpToolDefinition"
|
|
}
|
|
],
|
|
"title": "Definition"
|
|
},
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"functionName": {
|
|
"pattern": "^[a-z][a-z0-9_]{0,63}$",
|
|
"title": "Functionname",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"mcpServerId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Mcpserverid"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"remoteToolName": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Remotetoolname"
|
|
},
|
|
"secrets": {
|
|
"additionalProperties": true,
|
|
"title": "Secrets",
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"default": "active",
|
|
"enum": [
|
|
"active",
|
|
"archived",
|
|
"draft"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"http",
|
|
"mcp",
|
|
"client"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Updatedat"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"functionName",
|
|
"definition",
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "ToolOut",
|
|
"type": "object"
|
|
},
|
|
"ToolParamAssertion": {
|
|
"properties": {
|
|
"matchMode": {
|
|
"enum": [
|
|
"exact",
|
|
"regex",
|
|
"llm"
|
|
],
|
|
"title": "Matchmode",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"maxLength": 4000,
|
|
"minLength": 1,
|
|
"title": "Value",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"matchMode",
|
|
"value"
|
|
],
|
|
"title": "ToolParamAssertion",
|
|
"type": "object"
|
|
},
|
|
"ToolParameter": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"location": {
|
|
"default": "body",
|
|
"enum": [
|
|
"path",
|
|
"query",
|
|
"body",
|
|
"header"
|
|
],
|
|
"title": "Location",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"required": {
|
|
"default": true,
|
|
"title": "Required",
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"default": "string",
|
|
"enum": [
|
|
"string",
|
|
"number",
|
|
"integer",
|
|
"boolean",
|
|
"object",
|
|
"array"
|
|
],
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "ToolParameter",
|
|
"type": "object"
|
|
},
|
|
"ToolSimulationResponse": {
|
|
"properties": {
|
|
"body": {
|
|
"default": "{\"status\":\"ok\"}",
|
|
"maxLength": 100000,
|
|
"title": "Body",
|
|
"type": "string"
|
|
},
|
|
"delayMs": {
|
|
"default": 0,
|
|
"maximum": 60000.0,
|
|
"minimum": 0.0,
|
|
"title": "Delayms",
|
|
"type": "integer"
|
|
},
|
|
"outcome": {
|
|
"default": "success",
|
|
"enum": [
|
|
"success",
|
|
"error"
|
|
],
|
|
"title": "Outcome",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "ToolSimulationResponse",
|
|
"type": "object"
|
|
},
|
|
"ToolSimulationStep": {
|
|
"properties": {
|
|
"body": {
|
|
"default": "{\"status\":\"ok\"}",
|
|
"maxLength": 100000,
|
|
"title": "Body",
|
|
"type": "string"
|
|
},
|
|
"delayMs": {
|
|
"default": 0,
|
|
"maximum": 60000.0,
|
|
"minimum": 0.0,
|
|
"title": "Delayms",
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"outcome": {
|
|
"default": "success",
|
|
"enum": [
|
|
"success",
|
|
"error"
|
|
],
|
|
"title": "Outcome",
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"any": "#/components/schemas/AnyToolSimulationScope",
|
|
"startup": "#/components/schemas/StartupToolSimulationScope",
|
|
"turn": "#/components/schemas/TurnToolSimulationScope"
|
|
},
|
|
"propertyName": "phase"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AnyToolSimulationScope"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/StartupToolSimulationScope"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TurnToolSimulationScope"
|
|
}
|
|
],
|
|
"title": "Scope"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "ToolSimulationStep",
|
|
"type": "object"
|
|
},
|
|
"ToolUpsert": {
|
|
"properties": {
|
|
"definition": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"client": "#/components/schemas/ClientToolDefinition",
|
|
"http": "#/components/schemas/HttpToolDefinition",
|
|
"mcp": "#/components/schemas/McpToolDefinition"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HttpToolDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ClientToolDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/McpToolDefinition"
|
|
}
|
|
],
|
|
"title": "Definition"
|
|
},
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"functionName": {
|
|
"pattern": "^[a-z][a-z0-9_]{0,63}$",
|
|
"title": "Functionname",
|
|
"type": "string"
|
|
},
|
|
"mcpServerId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Mcpserverid"
|
|
},
|
|
"name": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"secrets": {
|
|
"additionalProperties": true,
|
|
"title": "Secrets",
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"default": "active",
|
|
"enum": [
|
|
"active",
|
|
"archived",
|
|
"draft"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"functionName",
|
|
"definition"
|
|
],
|
|
"title": "ToolUpsert",
|
|
"type": "object"
|
|
},
|
|
"TurnConfig": {
|
|
"properties": {
|
|
"bargeIn": {
|
|
"$ref": "#/components/schemas/BargeInConfig"
|
|
},
|
|
"turnDetection": {
|
|
"$ref": "#/components/schemas/TurnDetectionConfig"
|
|
},
|
|
"vad": {
|
|
"$ref": "#/components/schemas/VadConfig"
|
|
}
|
|
},
|
|
"title": "TurnConfig",
|
|
"type": "object"
|
|
},
|
|
"TurnDetectionConfig": {
|
|
"properties": {
|
|
"silenceTimeoutSecs": {
|
|
"default": 0.6,
|
|
"maximum": 5.0,
|
|
"minimum": 0.2,
|
|
"title": "Silencetimeoutsecs",
|
|
"type": "number"
|
|
},
|
|
"strategy": {
|
|
"default": "silence",
|
|
"enum": [
|
|
"silence",
|
|
"smart_turn"
|
|
],
|
|
"title": "Strategy",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "TurnDetectionConfig",
|
|
"type": "object"
|
|
},
|
|
"TurnToolSimulationScope": {
|
|
"properties": {
|
|
"phase": {
|
|
"const": "turn",
|
|
"default": "turn",
|
|
"title": "Phase",
|
|
"type": "string"
|
|
},
|
|
"turnId": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"title": "Turnid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"turnId"
|
|
],
|
|
"title": "TurnToolSimulationScope",
|
|
"type": "object"
|
|
},
|
|
"UpdateStateTool-Input": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"updates": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/StateUpdateRule-Input"
|
|
},
|
|
"maxItems": 10,
|
|
"title": "Updates",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "UpdateStateTool",
|
|
"type": "object"
|
|
},
|
|
"UpdateStateTool-Output": {
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"maxLength": 2048,
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"updates": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/StateUpdateRule-Output"
|
|
},
|
|
"maxItems": 10,
|
|
"title": "Updates",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "UpdateStateTool",
|
|
"type": "object"
|
|
},
|
|
"VadConfig": {
|
|
"properties": {
|
|
"confidence": {
|
|
"default": 0.7,
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Confidence",
|
|
"type": "number"
|
|
},
|
|
"minVolume": {
|
|
"default": 0.6,
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Minvolume",
|
|
"type": "number"
|
|
},
|
|
"startSecs": {
|
|
"default": 0.2,
|
|
"maximum": 2.0,
|
|
"minimum": 0.05,
|
|
"title": "Startsecs",
|
|
"type": "number"
|
|
},
|
|
"stopSecs": {
|
|
"default": 0.2,
|
|
"maximum": 3.0,
|
|
"minimum": 0.05,
|
|
"title": "Stopsecs",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"title": "VadConfig",
|
|
"type": "object"
|
|
},
|
|
"ValidationError": {
|
|
"properties": {
|
|
"ctx": {
|
|
"title": "Context",
|
|
"type": "object"
|
|
},
|
|
"input": {
|
|
"title": "Input"
|
|
},
|
|
"loc": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
}
|
|
]
|
|
},
|
|
"title": "Location",
|
|
"type": "array"
|
|
},
|
|
"msg": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"title": "Error Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"loc",
|
|
"msg",
|
|
"type"
|
|
],
|
|
"title": "ValidationError",
|
|
"type": "object"
|
|
},
|
|
"VariableStateExpression": {
|
|
"properties": {
|
|
"type": {
|
|
"const": "variable",
|
|
"default": "variable",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"variableName": {
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
|
|
"title": "Variablename",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"variableName"
|
|
],
|
|
"title": "VariableStateExpression",
|
|
"type": "object"
|
|
},
|
|
"VariableValueSource": {
|
|
"properties": {
|
|
"source": {
|
|
"const": "variable",
|
|
"default": "variable",
|
|
"title": "Source",
|
|
"type": "string"
|
|
},
|
|
"variableName": {
|
|
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
|
|
"title": "Variablename",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"variableName"
|
|
],
|
|
"title": "VariableValueSource",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"PublicAPIKey": {
|
|
"description": "Long-lived sk-rt-... API key or an endpoint-approved client secret.",
|
|
"scheme": "bearer",
|
|
"type": "http"
|
|
}
|
|
}
|
|
},
|
|
"info": {
|
|
"description": "Public protocol: OpenAI-compatible subset v1.",
|
|
"title": "AI Video Assistant 平台 - 后端",
|
|
"version": "1.0.0"
|
|
},
|
|
"openapi": "3.1.0",
|
|
"paths": {
|
|
"/api/assistants": {
|
|
"get": {
|
|
"operationId": "list_assistants_api_assistants_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/AssistantOut"
|
|
},
|
|
"title": "Response List Assistants Api Assistants Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Assistants",
|
|
"tags": [
|
|
"assistants"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_assistant_api_assistants_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AssistantUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AssistantOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Assistant",
|
|
"tags": [
|
|
"assistants"
|
|
]
|
|
}
|
|
},
|
|
"/api/assistants/{assistant_id}": {
|
|
"delete": {
|
|
"operationId": "delete_assistant_api_assistants__assistant_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "assistant_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Assistant Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Assistant",
|
|
"tags": [
|
|
"assistants"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_assistant_api_assistants__assistant_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "assistant_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Assistant Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AssistantOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Assistant",
|
|
"tags": [
|
|
"assistants"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_assistant_api_assistants__assistant_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "assistant_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Assistant Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AssistantUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AssistantOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Assistant",
|
|
"tags": [
|
|
"assistants"
|
|
]
|
|
}
|
|
},
|
|
"/api/assistants/{assistant_id}/duplicate": {
|
|
"post": {
|
|
"operationId": "duplicate_assistant_api_assistants__assistant_id__duplicate_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "assistant_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Assistant Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AssistantOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Duplicate Assistant",
|
|
"tags": [
|
|
"assistants"
|
|
]
|
|
}
|
|
},
|
|
"/api/auth/login": {
|
|
"post": {
|
|
"operationId": "login_api_auth_login_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/LoginIn"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AdminUserOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Login",
|
|
"tags": [
|
|
"auth"
|
|
]
|
|
}
|
|
},
|
|
"/api/auth/logout": {
|
|
"post": {
|
|
"operationId": "logout_api_auth_logout_post",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "Logout",
|
|
"tags": [
|
|
"auth"
|
|
]
|
|
}
|
|
},
|
|
"/api/auth/me": {
|
|
"get": {
|
|
"operationId": "me_api_auth_me_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AdminUserOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "Me",
|
|
"tags": [
|
|
"auth"
|
|
]
|
|
}
|
|
},
|
|
"/api/conversations": {
|
|
"get": {
|
|
"operationId": "list_conversations_api_conversations_get",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"default": 1,
|
|
"minimum": 1,
|
|
"title": "Page",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page_size",
|
|
"required": false,
|
|
"schema": {
|
|
"default": 20,
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Page Size",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "assistant_id",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Assistant Id"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 128,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Search"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "channel",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Channel"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Status"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sort_order",
|
|
"required": false,
|
|
"schema": {
|
|
"default": "newest",
|
|
"pattern": "^(newest|oldest)$",
|
|
"title": "Sort Order",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConversationListOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "List Conversations",
|
|
"tags": [
|
|
"conversations"
|
|
]
|
|
}
|
|
},
|
|
"/api/conversations/{conversation_id}": {
|
|
"delete": {
|
|
"operationId": "delete_conversation_api_conversations__conversation_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "conversation_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Conversation Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Conversation",
|
|
"tags": [
|
|
"conversations"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_conversation_api_conversations__conversation_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "conversation_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Conversation Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConversationDetailOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Conversation",
|
|
"tags": [
|
|
"conversations"
|
|
]
|
|
}
|
|
},
|
|
"/api/conversations/{conversation_id}/artifacts/{artifact_id}/content": {
|
|
"get": {
|
|
"operationId": "get_conversation_artifact_api_conversations__conversation_id__artifacts__artifact_id__content_get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "conversation_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Conversation Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "artifact_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Artifact Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Conversation Artifact",
|
|
"tags": [
|
|
"conversations"
|
|
]
|
|
}
|
|
},
|
|
"/api/input-assets/image": {
|
|
"post": {
|
|
"operationId": "upload_input_image_api_input_assets_image_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Body_upload_input_image_api_input_assets_image_post"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/InputImageAssetOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Upload Input Image",
|
|
"tags": [
|
|
"input-assets"
|
|
]
|
|
}
|
|
},
|
|
"/api/input-assets/{asset_token}": {
|
|
"delete": {
|
|
"operationId": "delete_input_image_api_input_assets__asset_token__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "asset_token",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Asset Token",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Input Image",
|
|
"tags": [
|
|
"input-assets"
|
|
]
|
|
}
|
|
},
|
|
"/api/interface-definitions": {
|
|
"get": {
|
|
"operationId": "list_interface_definitions_api_interface_definitions_get",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "capability",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Capability"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/InterfaceDefinitionOut"
|
|
},
|
|
"title": "Response List Interface Definitions Api Interface Definitions Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "List Interface Definitions",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases": {
|
|
"get": {
|
|
"operationId": "list_knowledge_bases_api_knowledge_bases_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/KnowledgeBaseOut"
|
|
},
|
|
"title": "Response List Knowledge Bases Api Knowledge Bases Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Knowledge Bases",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_knowledge_base_api_knowledge_bases_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeBaseUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeBaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Knowledge Base",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}": {
|
|
"delete": {
|
|
"operationId": "delete_knowledge_base_api_knowledge_bases__kb_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Knowledge Base",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_knowledge_base_api_knowledge_bases__kb_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeBaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Knowledge Base",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_knowledge_base_api_knowledge_bases__kb_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeBaseUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeBaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Knowledge Base",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/documents": {
|
|
"get": {
|
|
"operationId": "list_documents_api_knowledge_bases__kb_id__documents_get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/KnowledgeDocumentOut"
|
|
},
|
|
"title": "Response List Documents Api Knowledge Bases Kb Id Documents Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "List Documents",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/documents/file": {
|
|
"post": {
|
|
"operationId": "add_file_api_knowledge_bases__kb_id__documents_file_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Body_add_file_api_knowledge_bases__kb_id__documents_file_post"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"202": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeDocumentOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Add File",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/documents/text": {
|
|
"post": {
|
|
"operationId": "add_text_api_knowledge_bases__kb_id__documents_text_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeTextIn"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"202": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeDocumentOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Add Text",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/documents/{document_id}": {
|
|
"delete": {
|
|
"operationId": "delete_document_api_knowledge_bases__kb_id__documents__document_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "document_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Document Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Document",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/documents/{document_id}/chunks": {
|
|
"get": {
|
|
"operationId": "list_document_chunks_api_knowledge_bases__kb_id__documents__document_id__chunks_get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "document_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Document Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/KnowledgeChunkOut"
|
|
},
|
|
"title": "Response List Document Chunks Api Knowledge Bases Kb Id Documents Document Id Chunks Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "List Document Chunks",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/documents/{document_id}/retry": {
|
|
"post": {
|
|
"operationId": "retry_document_api_knowledge_bases__kb_id__documents__document_id__retry_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "document_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Document Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"202": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeDocumentOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Retry Document",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/knowledge-bases/{kb_id}/search": {
|
|
"post": {
|
|
"operationId": "search_knowledge_base_api_knowledge_bases__kb_id__search_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "kb_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kb Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KnowledgeSearchIn"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Search Knowledge Base",
|
|
"tags": [
|
|
"knowledge-bases"
|
|
]
|
|
}
|
|
},
|
|
"/api/mcp-servers": {
|
|
"get": {
|
|
"operationId": "list_mcp_servers_api_mcp_servers_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/McpServerOut"
|
|
},
|
|
"title": "Response List Mcp Servers Api Mcp Servers Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Mcp Servers",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_mcp_server_api_mcp_servers_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Mcp Server",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
}
|
|
},
|
|
"/api/mcp-servers/{server_id}": {
|
|
"delete": {
|
|
"operationId": "delete_mcp_server_api_mcp_servers__server_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "server_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Server Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Mcp Server",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_mcp_server_api_mcp_servers__server_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "server_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Server Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Mcp Server",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_mcp_server_api_mcp_servers__server_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "server_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Server Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Mcp Server",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
}
|
|
},
|
|
"/api/mcp-servers/{server_id}/sync": {
|
|
"post": {
|
|
"operationId": "sync_mcp_tools_api_mcp_servers__server_id__sync_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "server_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Server Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpSyncResult"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Sync Mcp Tools",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
}
|
|
},
|
|
"/api/mcp-servers/{server_id}/tools": {
|
|
"get": {
|
|
"operationId": "list_mcp_tools_api_mcp_servers__server_id__tools_get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "server_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Server Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
},
|
|
"title": "Response List Mcp Tools Api Mcp Servers Server Id Tools Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "List Mcp Tools",
|
|
"tags": [
|
|
"mcp-servers"
|
|
]
|
|
}
|
|
},
|
|
"/api/model-resources": {
|
|
"get": {
|
|
"operationId": "list_model_resources_api_model_resources_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ModelResourceOut"
|
|
},
|
|
"title": "Response List Model Resources Api Model Resources Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Model Resources",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_model_resource_api_model_resources_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Model Resource",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
}
|
|
},
|
|
"/api/model-resources/test": {
|
|
"post": {
|
|
"operationId": "test_new_model_resource_api_model_resources_test_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceTestResult"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Test New Model Resource",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
}
|
|
},
|
|
"/api/model-resources/{resource_id}": {
|
|
"delete": {
|
|
"operationId": "delete_model_resource_api_model_resources__resource_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "resource_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Resource Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Model Resource",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_model_resource_api_model_resources__resource_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "resource_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Resource Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Model Resource",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
}
|
|
},
|
|
"/api/model-resources/{resource_id}/duplicate": {
|
|
"post": {
|
|
"operationId": "duplicate_model_resource_api_model_resources__resource_id__duplicate_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "resource_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Resource Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Duplicate Model Resource",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
}
|
|
},
|
|
"/api/model-resources/{resource_id}/test": {
|
|
"post": {
|
|
"operationId": "test_saved_model_resource_api_model_resources__resource_id__test_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "resource_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Resource Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelResourceTestResult"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Test Saved Model Resource",
|
|
"tags": [
|
|
"model-registry"
|
|
]
|
|
}
|
|
},
|
|
"/api/node-types": {
|
|
"get": {
|
|
"operationId": "list_node_types_api_node_types_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Node Types",
|
|
"tags": [
|
|
"workflow"
|
|
]
|
|
}
|
|
},
|
|
"/api/realtime/api-keys": {
|
|
"get": {
|
|
"operationId": "list_realtime_api_keys_api_realtime_api_keys_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/RealtimeApiKeyOut"
|
|
},
|
|
"title": "Response List Realtime Api Keys Api Realtime Api Keys Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Realtime Api Keys",
|
|
"tags": [
|
|
"realtime-api-keys"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_realtime_api_key_api_realtime_api_keys_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RealtimeApiKeyCreate"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RealtimeApiKeyCreated"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Realtime Api Key",
|
|
"tags": [
|
|
"realtime-api-keys"
|
|
]
|
|
}
|
|
},
|
|
"/api/realtime/api-keys/{key_id}": {
|
|
"delete": {
|
|
"operationId": "revoke_realtime_api_key_api_realtime_api_keys__key_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "key_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Key Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Revoke Realtime Api Key",
|
|
"tags": [
|
|
"realtime-api-keys"
|
|
]
|
|
}
|
|
},
|
|
"/api/settings/analysis-webhook": {
|
|
"get": {
|
|
"operationId": "get_analysis_webhook_api_settings_analysis_webhook_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AnalysisWebhookSettingOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "Get Analysis Webhook",
|
|
"tags": [
|
|
"site-settings"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_analysis_webhook_api_settings_analysis_webhook_put",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AnalysisWebhookSettingUpdate"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AnalysisWebhookSettingOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Analysis Webhook",
|
|
"tags": [
|
|
"site-settings"
|
|
]
|
|
}
|
|
},
|
|
"/api/settings/analysis-webhook/test": {
|
|
"post": {
|
|
"operationId": "test_analysis_webhook_api_settings_analysis_webhook_test_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AnalysisWebhookTestIn"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AnalysisWebhookTestOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Test Analysis Webhook",
|
|
"tags": [
|
|
"site-settings"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-assets/images": {
|
|
"post": {
|
|
"operationId": "upload_test_image_api_test_assets_images_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Body_upload_test_image_api_test_assets_images_post"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestImageAssetOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Upload Test Image",
|
|
"tags": [
|
|
"test-assets"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-assets/{asset_id}": {
|
|
"delete": {
|
|
"operationId": "delete_test_asset_api_test_assets__asset_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "asset_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Asset Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Test Asset",
|
|
"tags": [
|
|
"test-assets"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_test_asset_api_test_assets__asset_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "asset_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Asset Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestImageAssetOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Test Asset",
|
|
"tags": [
|
|
"test-assets"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-assets/{asset_id}/content": {
|
|
"get": {
|
|
"operationId": "get_test_asset_content_api_test_assets__asset_id__content_get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "asset_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Asset Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Test Asset Content",
|
|
"tags": [
|
|
"test-assets"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-cases": {
|
|
"get": {
|
|
"operationId": "list_test_cases_api_test_cases_get",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "suiteId",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Suiteid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TestCaseOut"
|
|
},
|
|
"title": "Response List Test Cases Api Test Cases Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "List Test Cases",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-cases/bulk-delete": {
|
|
"post": {
|
|
"operationId": "bulk_delete_test_cases_api_test_cases_bulk_delete_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseBulkDeleteIn"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Bulk Delete Test Cases",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-cases/{case_id}": {
|
|
"delete": {
|
|
"operationId": "delete_test_case_api_test_cases__case_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "case_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Case Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Test Case",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_test_case_api_test_cases__case_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "case_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Case Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Test Case",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_test_case_api_test_cases__case_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "case_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Case Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseWrite"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Test Case",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-cases/{case_id}/duplicate": {
|
|
"post": {
|
|
"operationId": "duplicate_test_case_api_test_cases__case_id__duplicate_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "case_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Case Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Duplicate Test Case",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-runs": {
|
|
"post": {
|
|
"operationId": "create_test_run_api_test_runs_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BatchRunCreate"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BatchRunSnapshotOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Test Run",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-runs/{run_id}": {
|
|
"get": {
|
|
"operationId": "get_test_run_api_test_runs__run_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "run_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Run Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BatchRunSnapshotOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Test Run",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-runs/{run_id}/cancel": {
|
|
"post": {
|
|
"operationId": "cancel_test_run_api_test_runs__run_id__cancel_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "run_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Run Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BatchRunSnapshotOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Cancel Test Run",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-runs/{run_id}/prompt-improvement": {
|
|
"post": {
|
|
"operationId": "create_prompt_improvement_api_test_runs__run_id__prompt_improvement_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "run_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Run Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PromptImprovementOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Prompt Improvement",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-suites": {
|
|
"get": {
|
|
"operationId": "list_test_suites_api_test_suites_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TestSuiteOut"
|
|
},
|
|
"title": "Response List Test Suites Api Test Suites Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Test Suites",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_test_suite_api_test_suites_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestSuiteCreate"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestSuiteOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Test Suite",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-suites/{suite_id}": {
|
|
"delete": {
|
|
"operationId": "delete_test_suite_api_test_suites__suite_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "suite_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Suite Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Test Suite",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_test_suite_api_test_suites__suite_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "suite_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Suite Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestSuiteOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Test Suite",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_test_suite_api_test_suites__suite_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "suite_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Suite Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestSuiteUpdate"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestSuiteOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Test Suite",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-suites/{suite_id}/case-order": {
|
|
"put": {
|
|
"operationId": "reorder_test_cases_api_test_suites__suite_id__case_order_put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "suite_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Suite Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseOrderIn"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Reorder Test Cases",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-suites/{suite_id}/cases": {
|
|
"post": {
|
|
"operationId": "create_test_case_api_test_suites__suite_id__cases_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "suite_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Suite Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseWrite"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestCaseOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Test Case",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/test-suites/{suite_id}/duplicate": {
|
|
"post": {
|
|
"operationId": "duplicate_test_suite_api_test_suites__suite_id__duplicate_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "suite_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Suite Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestSuiteOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Duplicate Test Suite",
|
|
"tags": [
|
|
"tests"
|
|
]
|
|
}
|
|
},
|
|
"/api/tools": {
|
|
"get": {
|
|
"operationId": "list_tools_api_tools_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
},
|
|
"title": "Response List Tools Api Tools Get",
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "List Tools",
|
|
"tags": [
|
|
"tools"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "create_tool_api_tools_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ToolUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Create Tool",
|
|
"tags": [
|
|
"tools"
|
|
]
|
|
}
|
|
},
|
|
"/api/tools/{tool_id}": {
|
|
"delete": {
|
|
"operationId": "delete_tool_api_tools__tool_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "tool_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Tool Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Delete Tool",
|
|
"tags": [
|
|
"tools"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "get_tool_api_tools__tool_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "tool_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Tool Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Get Tool",
|
|
"tags": [
|
|
"tools"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "update_tool_api_tools__tool_id__put",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "tool_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Tool Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ToolUpsert"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Update Tool",
|
|
"tags": [
|
|
"tools"
|
|
]
|
|
}
|
|
},
|
|
"/api/tools/{tool_id}/duplicate": {
|
|
"post": {
|
|
"operationId": "duplicate_tool_api_tools__tool_id__duplicate_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "tool_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Tool Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ToolOut"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Duplicate Tool",
|
|
"tags": [
|
|
"tools"
|
|
]
|
|
}
|
|
},
|
|
"/api/webrtc/ice-servers": {
|
|
"get": {
|
|
"description": "Browser fetches STUN/TURN config (with ephemeral TURN creds when configured).",
|
|
"operationId": "ice_servers_api_webrtc_ice_servers_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "Ice Servers",
|
|
"tags": [
|
|
"voice"
|
|
]
|
|
}
|
|
},
|
|
"/api/webrtc/offer": {
|
|
"patch": {
|
|
"description": "Accept the batched trickle ICE format used by the official JS client.",
|
|
"operationId": "http_ice_candidates_api_webrtc_offer_patch",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"title": "Payload",
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Http Ice Candidates",
|
|
"tags": [
|
|
"voice"
|
|
]
|
|
},
|
|
"post": {
|
|
"description": "Official SmallWebRTC JS transport offer endpoint.",
|
|
"operationId": "http_offer_api_webrtc_offer_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"title": "Payload",
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Validation Error"
|
|
}
|
|
},
|
|
"summary": "Http Offer",
|
|
"tags": [
|
|
"voice"
|
|
]
|
|
}
|
|
},
|
|
"/health": {
|
|
"get": {
|
|
"operationId": "health_health_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful Response"
|
|
}
|
|
},
|
|
"summary": "Health"
|
|
}
|
|
},
|
|
"/v1/models": {
|
|
"get": {
|
|
"operationId": "list_models_v1_models_get",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelList"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "List assistants available through the public API",
|
|
"tags": [
|
|
"openai-models"
|
|
]
|
|
}
|
|
},
|
|
"/v1/realtime/calls": {
|
|
"post": {
|
|
"operationId": "create_realtime_call_v1_realtime_calls_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/sdp": {
|
|
"schema": {
|
|
"format": "sdp",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"properties": {
|
|
"sdp": {
|
|
"format": "sdp",
|
|
"type": "string"
|
|
},
|
|
"session": {
|
|
"description": "JSON-encoded Realtime session.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sdp",
|
|
"session"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/sdp": {
|
|
"example": "v=0\\r\\no=- ...",
|
|
"schema": {
|
|
"format": "sdp",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "WebRTC SDP answer.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "Relative URL of the created Realtime call.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "Create a Realtime WebRTC call",
|
|
"tags": [
|
|
"openai-realtime"
|
|
]
|
|
}
|
|
},
|
|
"/v1/realtime/client_secrets": {
|
|
"post": {
|
|
"operationId": "create_realtime_client_secret_v1_realtime_client_secrets_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RealtimeClientSecretRequest"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/RealtimeSessionRequest"
|
|
}
|
|
],
|
|
"title": "Body"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RealtimeClientSecretResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "Create a short-lived Realtime client secret",
|
|
"tags": [
|
|
"openai-realtime"
|
|
]
|
|
}
|
|
},
|
|
"/v1/responses": {
|
|
"post": {
|
|
"operationId": "create_response_v1_responses_post",
|
|
"parameters": [
|
|
{
|
|
"description": "Retry key scoped to the authenticated API key.",
|
|
"in": "header",
|
|
"name": "Idempotency-Key",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Retry key scoped to the authenticated API key.",
|
|
"title": "Idempotency-Key"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResponseCreateRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResponseObject"
|
|
}
|
|
},
|
|
"text/event-stream": {
|
|
"example": "event: response.created\\ndata: {\"type\":\"response.created\",...}\\n\\n",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "A completed Response or a stream of Responses events.",
|
|
"headers": {
|
|
"X-Idempotent-Replayed": {
|
|
"description": "Present and true when a stored result is replayed.",
|
|
"schema": {
|
|
"enum": [
|
|
"true"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "Create a stateful model response",
|
|
"tags": [
|
|
"openai-responses"
|
|
]
|
|
}
|
|
},
|
|
"/v1/responses/{response_id}": {
|
|
"delete": {
|
|
"operationId": "remove_response_v1_responses__response_id__delete",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "response_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DeletedResource"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "Delete a stored response",
|
|
"tags": [
|
|
"openai-responses"
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "retrieve_response_v1_responses__response_id__get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "response_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResponseObject"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "Retrieve a stored response",
|
|
"tags": [
|
|
"openai-responses"
|
|
]
|
|
}
|
|
},
|
|
"/v1/responses/{response_id}/cancel": {
|
|
"post": {
|
|
"operationId": "reject_response_cancellation_v1_responses__response_id__cancel_post",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "response_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "Reject background cancellation in subset v1",
|
|
"tags": [
|
|
"openai-responses"
|
|
]
|
|
}
|
|
},
|
|
"/v1/responses/{response_id}/input_items": {
|
|
"get": {
|
|
"operationId": "list_response_input_items_v1_responses__response_id__input_items_get",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "response_id",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false,
|
|
"schema": {
|
|
"default": 20,
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Limit",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"default": "desc",
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
],
|
|
"title": "Order",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Include"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ResponseInputItemList"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful Response",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unsupported_parameter",
|
|
"message": "The requested parameter is not supported.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The request is unsupported or semantically invalid.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_api_key",
|
|
"message": "Invalid or expired API key.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The API credential is missing, invalid, or expired.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_found",
|
|
"message": "Response not found.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The resource does not exist or belongs to another API key.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_not_ready",
|
|
"message": "The requested state transition conflicts.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The requested state transition conflicts with current state.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "invalid_request_error",
|
|
"message": "Request does not match the API schema.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The JSON body or query parameters do not match the schema.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "rate_limit_exceeded",
|
|
"message": "The request limit was exceeded.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "A request or concurrency limit was exceeded.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "internal_error",
|
|
"message": "The response failed unexpectedly.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response failed because of an internal error.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service_unavailable",
|
|
"message": "The service is temporarily unavailable.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is temporarily unavailable.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"504": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "response_timeout",
|
|
"message": "Response timed out.",
|
|
"type": "invalid_request_error"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "The response exceeded its generation timeout.",
|
|
"headers": {
|
|
"X-Request-ID": {
|
|
"description": "Request identifier generated by the server or supplied by the caller.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"PublicAPIKey": []
|
|
}
|
|
],
|
|
"summary": "List input items for a stored response",
|
|
"tags": [
|
|
"openai-responses"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|