Skip to content

OpenApiConnectorVersion

One version of an HTTP (OpenAPI) connector.

Kind: an object, used in responses.

Every field is present in a response; empty ones are null.

FieldTypeDescription
httpMethodstringThe HTTP method, such as GET or POST.
pathParametersOpenApiParameter[]The parameters in the URL’s path, one for each {name} in url.
queryParametersOpenApiParameter[]The query-string parameters.
urlstringThe endpoint’s URL. For an HTTP connector, {name} in it marks a path parameter; for an MCP connector, it is the MCP server’s URL.
descriptionstringWhat the endpoint does, in a sentence.
requestSchemastring | nullThe JSON Schema of the request body, as text. The model’s arguments are checked against it before a call is made. Null: no body is sent.
responseSchemastring | nullThe JSON Schema the endpoint’s response must match, as text; null when the response is not checked.
postProcessResponseUnicodeCharactersbooleanWhether typographic characters in the response (curly quotes, dashes, bullets, the ellipsis) are replaced with plain ones before the response is read.
authenticationTypeConnectorAuthenticationTypeThe kind of credential the endpoint needs. The credential itself is given where a tool uses the connector.
versionintegerThe version number, from 1. Every change to a definition adds a new version with the next number.
datedatetimeWhen this version was created, in UTC.
isDisabledbooleanWhether this version is disabled. A disabled version is never used: new links and runs take the latest enabled version, and anything pinned to this one fails until it is re-enabled.
{
"httpMethod": "...",
"pathParameters": [
{
"description": "...",
"name": "...",
"dataType": "String",
"isRequired": false
}
],
"queryParameters": [
{
"description": "...",
"name": "...",
"dataType": "String",
"isRequired": false
}
],
"url": "...",
"description": "...",
"requestSchema": "...",
"responseSchema": "...",
"postProcessResponseUnicodeCharacters": false,
"authenticationType": "None",
"version": 0,
"date": "2026-10-26T12:00:00.0000000Z",
"isDisabled": false
}