---
title: "Preview Spec"
method: POST
path: "/v1/workspaces/{workspace}/openapi-connections/preview-spec"
tags: ["v1", "protected", "openapi-connections"]
---

# Preview Spec

`POST /v1/workspaces/{workspace}/openapi-connections/preview-spec`

Fetch/parse an OpenAPI spec and return metadata + tools without creating a connection.

The service dependency ensures authentication is enforced.

## Path parameters

- `workspace` string, required — Slug of the workspace the request acts in

## Request body

- SpecPreviewRequest
  - `spec_content` object, nullable
  - `spec_url` string, nullable

## Response `200`

Successful Response

- SpecPreviewResponse
  - `base_url` string, nullable
  - `description` string, nullable
  - `title` string, nullable
  - `tools` object[]
  - `version` string, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-26** `d3ad8e1a3681` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/agentarea/apis/agentarea-api/changes/v1/workspaces/:workspace/openapi-connections/preview-spec/post.md)

---

[API](https://skmtc.dev/agentarea/apis/agentarea-api.md) · [All operations](https://skmtc.dev/agentarea/apis/agentarea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentarea/apis/agentarea-api/revisions/286327d8bd86?raw)