---
title: "POST /api/openapi/preview"
method: POST
path: "/api/openapi/preview"
tags: ["openapi"]
---

# POST /api/openapi/preview

`POST /api/openapi/preview`

## Request body

- object
  - `spec` string, required
  - `specFormat` string, nullable
  - `specOverrides` union[], nullable
    - union
      - object
        - `op` 'add', required
        - `path` string, required
        - `value` unknown, required
      - object
        - `op` 'remove', required
        - `path` string, required
      - object
        - `op` 'replace', required
        - `path` string, required
        - `value` unknown, required
      - object
        - `op` 'move', required
        - `path` string, required
        - `from` string, required
      - object
        - `op` 'copy', required
        - `path` string, required
        - `from` string, required
      - object
        - `op` 'test', required
        - `path` string, required
        - `value` unknown, required

## Response `200`

Success

- object
  - `title` string, nullable
  - `description` string, nullable
  - `version` string, nullable
  - `servers` object[], required
    - `url` string, required
    - `description` string, nullable
    - `variables` object, nullable
  - `operationCount` union, required
    - number
    - 'NaN'
    - 'Infinity'
    - '-Infinity'
    - 'Infinity' | '-Infinity' | 'NaN'
  - `tags` string[], required
  - `securitySchemes` object[], required
    - `name` string, required
    - `type` 'http' | 'apiKey' | 'oauth2' | 'openIdConnect', required
    - `scheme` string, nullable
    - `bearerFormat` string, nullable
    - `in` 'header' | 'query' | 'cookie', nullable
    - `headerName` string, nullable
    - `description` string, nullable
    - `flows` object, nullable
      - `authorizationCode` object, nullable
        - `authorizationUrl` string, required
        - `tokenUrl` string, required
        - `refreshUrl` string, nullable
        - `scopes` object, required
      - `clientCredentials` object, nullable
        - `tokenUrl` string, required
        - `refreshUrl` string, nullable
        - `scopes` object, required
    - `openIdConnectUrl` string, nullable
  - `authStrategies` object[], required
    - `schemes` string[], required
  - `headerPresets` object[], required
    - `label` string, required
    - `headers` object, required
    - `secretHeaders` string[], required
  - `oauth2Presets` object[], required
    - `label` string, required
    - `securitySchemeName` string, required
    - `flow` 'authorizationCode' | 'clientCredentials', required
    - `authorizationUrl` string, nullable
    - `tokenUrl` string, required
    - `resource` string, nullable
    - `refreshUrl` string, nullable
    - `scopes` object, required
    - `identityScopes` union, required
      - 'auto'
      - false
      - string[]
    - `supportsClientIdMetadataDocument` boolean, nullable
  - `healthCheckCandidates` object[], required
    - `operation` string, required
    - `method` string, required
    - `requiredArgCount` union, required
      - number
      - 'NaN'
      - 'Infinity'
      - '-Infinity'
      - 'Infinity' | '-Infinity' | 'NaN'
    - `destructive` boolean, required
    - `summary` string, nullable
    - `parameters` object[], nullable
      - `name` string, required
      - `location` string, required
      - `required` boolean, required
      - `description` string, nullable
    - `responseFields` object[], nullable
      - `path` string, required
      - `type` string, required

## Other responses

- `400` — OpenApiParseError | OpenApiExtractionError | OpenApiOAuthError | OpenApiSpecOverrideError
- `409` — IntegrationAlreadyExistsError
- `500` — InternalError

---

[API](https://skmtc.net/executor/apis/executor-api.md) · [All operations](https://skmtc.net/executor/apis/executor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/executor/executor-api/revisions/c1ec5e355d44/schema)