Preview an OpenAPI document as a connector

POST/v1/mcp-integrations/spec-preview

Preview an OpenAPI document as a connector.

Reads an OpenAPI 3.0 or 3.1 document (from spec_url, or given in spec_content) and returns what an OPENAPI connector would make of it: its title, suggested base URLs, the tools, the operations that would be skipped and the security schemes with the auth type each suggests. Nothing is stored.

With workspace_id, requires a key of that workspace (any role) or an organization admin key; without, any organization member. Returns 400 when the document cannot be read or is not OpenAPI 3.0 or 3.1. Returns 402 when the organization's plan does not include the MCP Gateway.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Request body application/json

the document to read

organizationstringrequired
The organization's identifier (slug).
At least 1 characters
workspace_idstring<uuid>
The workspace the connector is for (UUID). Set: any member of that workspace may preview. Absent: any organization member may.
spec_urlstring
Where to fetch the OpenAPI document from, up to 2048 characters. Give this or spec_content.
At least 0 characters · At most 2048 characters
spec_contentstring
The OpenAPI 3.0 or 3.1 document itself. Takes precedence over spec_url.
spec_formatenum<string>
The format of spec_content: JSON or YAML.
One of "JSON", "YAML"

Responses

200application/json

openapi_versionstring
The document's OpenAPI version, for example 3.1.0.
titlestring
The document's info.title.
versionstring
The document's info.version.
descriptionstring
The document's info.description.
formatenum<string>
The format the document was read as, JSON or YAML.
One of "JSON", "YAML"
serversstring[]
The document's servers[].url, as written.
toolsobject[]
The tools the operations would become.
Child attributes
- namestring
  The tool's name (from the operationId, or derived from the method and path).
- methodstring
  The HTTP method.
- pathstring
  The operation's path.
- titlestring
  The tool's title (the operation's summary), when it has one.
- read_onlyboolean
  true for GET and HEAD. The others start privileged when imported.
skippedobject[]
Operations that would not become tools, and why.
Child attributes
- methodstring
  The HTTP method of the operation.
- pathstring
  The operation's path in the document.
- operation_idstring
  The operation's operationId, when it has one.
- reasonstring
  Why it was skipped, for example an unsupported request body type.
truncatedboolean
true when the document has more operations than a connector takes; the rest are left out.
security_schemesobject[]
The document's security schemes, with the auth type each suggests.
Child attributes
- namestring
  The scheme's name in the document.
- typestring
  The OpenAPI scheme type: apiKey, http, oauth2, openIdConnect or mutualTLS.
- instring
  apiKey: where the key goes, header, query or cookie.
- parameter_namestring
  apiKey: the header or query parameter name.
- schemestring
  http: bearer or basic.
- authorization_urlstring
  oauth2: the authorization URL.
- token_urlstring
  oauth2: the token URL.
- scopesstring[]
  oauth2: the scopes the document lists.
- suggested_auth_typeenum<string>
  The connector auth type to use. Absent when the gateway cannot use this scheme.
  One of "NONE", "HEADERS", "OAUTH_AUTO", "OAUTH_CLIENT_CREDENTIALS"

Request

curl -X POST "https://api.vectoraxis.ai/v1/mcp-integrations/spec-preview" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "organization": "string"
}'

VectorAxis is built by GK Labs, a member of NVIDIA Inception.