Postman

Postman Specs API

The specs API from Postman — 14 operation(s) for specs.

GitHub OpenAPI

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /apis/{apiId}/spec-migrations Check an API Builder to Spec Hub migration · Get status of API Builder to Spec Hub migration #
Ask an LLM
“Has my API Builder definition finished migrating to Spec Hub?”
“Where can I see whether a Spec Hub migration failed or is still running?”
Tell an agent
Check the Spec Hub migration status of API {apiId}.
Tell me if API Builder API {apiId} has been moved to Spec Hub yet.
POST /apis/{apiId}/spec-migrations Migrate an API Builder API to Spec Hub · Migrate API Builder API to Spec Hub #
Ask an LLM
“How do I move a legacy API Builder definition over to Spec Hub?”
“Can I migrate an API Builder API into an existing workspace or a brand new one?”
Tell an agent
Migrate API Builder API {apiId} to Spec Hub.
Convert the API Builder definition of {apiId} into a Spec Hub specification.
GET /collections/{collectionUid}/generations/{elementType} Get the spec generated from a collection · Get generated spec #
Ask an LLM
“Where do I find the OpenAPI spec that was generated from my collection?”
“Can I see which specifications have already been produced from a given collection?”
Tell an agent
Show the {elementType} generated from collection {collectionUid}.
Get the spec that was created from collection {collectionUid} as {elementType}.
POST /collections/{collectionUid}/generations/{elementType} Generate an OpenAPI spec from a collection · Generate spec from collection #
Ask an LLM
“How do I turn an existing Postman collection into an OpenAPI 3.1 specification?”
“Can I choose OpenAPI 2.0, 3.0 or 3.1 and JSON or YAML when generating a spec from a collection?”
Tell an agent
Generate a {elementType} named {name} from collection {collectionUid}.
Create an {type} spec called {name} in {format} format from collection {collectionUid} as {elementType}.
PUT /collections/{collectionUid}/synchronizations Update a generated collection from its spec · Sync collection with spec #
Ask an LLM
“How do I push spec changes into the collection that was generated from it?”
“Which spec formats support syncing a generated collection?”
Tell an agent
Sync collection {collectionUid} with the latest version of spec {specId}.
Refresh generated collection {collectionUid} from spec {specId}.
GET /{elementType}/{elementId}/tasks/{taskId} Check a spec or collection generation task · Get status of an async spec task #
Ask an LLM
“Is the spec generation or sync task I kicked off still running?”
“How can I poll the result of an asynchronous Spec Hub task?”
Tell an agent
Check task {taskId} on {elementType} {elementId}.
Poll the generation task {taskId} for {elementType} {elementId} until it is done.
GET /specs List the specs in a workspace · Get all specs #
Ask an LLM
“Which API specifications live in my workspace's Spec Hub?”
“Can I page through all specs in a workspace a few at a time?”
Tell an agent
List all specs in workspace {workspaceId}.
Show the first {limit} Spec Hub specifications in workspace {workspaceId}.
POST /specs Create a spec in Spec Hub · Create a spec #
Ask an LLM
“How do I create a new OpenAPI or AsyncAPI specification in Spec Hub?”
“Can a Spec Hub specification span multiple files?”
Tell an agent
Create a {type} spec named {name} in workspace {workspaceId} with files {files}.
Add a new specification {name} to Spec Hub in workspace {workspaceId}.
GET /specs/{specId} Get a spec's details · Get a spec #
Ask an LLM
“What type and name does a given Spec Hub specification have?”
“Can I look up a specification's metadata by its ID?”
Tell an agent
Get spec {specId}.
Show the metadata for specification {specId}.
DELETE /specs/{specId} Delete a spec · Delete a spec #
Ask an LLM
“How do I delete a specification from Spec Hub?”
“Is removing a Spec Hub specification permanent?”
Tell an agent destructive · confirm first
Delete spec {specId}.
Remove specification {specId} from Spec Hub.
PATCH /specs/{specId} Rename a spec · Update a spec's properties #
Ask an LLM
“How do I rename a specification in Spec Hub?”
“Can I change a spec's name without touching its files?”
Tell an agent
Rename spec {specId} to {name}.
Change the title of specification {specId} to {name}.
PATCH /specs/{specId}/collections/{collectionId}/sync-options Change sync settings for a spec's collection · Update spec sync options #
Ask an LLM
“How do I configure how a spec's generated collection syncs with it?”
“Can I change the sync options for one collection generated from a specification?”
Tell an agent
Update the sync options between spec {specId} and collection {collectionId} to {syncOptions}.
Adjust how collection {collectionId} stays in sync with spec {specId}.
GET /specs/{specId}/definitions Get a spec's full definition · Get a spec's definition #
Ask an LLM
“How do I download the complete OpenAPI or AsyncAPI definition of a spec?”
“Can I get the whole spec definition in one response instead of file by file?”
Tell an agent
Get the full definition of spec {specId}.
Export the complete API definition for specification {specId}.
GET /specs/{specId}/files List a spec's files · Get a spec's files #
Ask an LLM
“What files does a multi-file specification contain?”
“Can I see the file tree of a Spec Hub specification?”
Tell an agent
List the files in spec {specId}.
Show me every file that makes up specification {specId}.
POST /specs/{specId}/files Add a file to a spec · Create a spec file #
Ask an LLM
“How do I add a new file to an OpenAPI or protobuf specification?”
“Does a forward slash in a spec file path create a folder?”
Tell an agent
Add file {path} with content {content} to spec {specId}.
Create a new spec file at {path} in specification {specId} containing {content}.
GET /specs/{specId}/files/{filePath} Read one file in a spec · Get a spec file #
Ask an LLM
“How do I read the contents of a single file within a specification?”
“Can I fetch just the components file of a multi-file spec?”
Tell an agent
Show the contents of file {filePath} in spec {specId}.
Open spec {specId}'s file at {filePath}.
DELETE /specs/{specId}/files/{filePath} Delete a file from a spec · Delete a spec file #
Ask an LLM
“How do I delete one file from a Spec Hub specification?”
“Can I remove a spec file without deleting the whole specification?”
Tell an agent destructive · confirm first
Delete file {filePath} from spec {specId}.
Remove the spec file at {filePath} in specification {specId}.
PATCH /specs/{specId}/files/{filePath} Edit or rename a file in a spec · Update a spec file #
Ask an LLM
“How do I update the content of an existing file in a specification?”
“Can I rename a spec file or change it to the root file?”
Tell an agent
Replace the content of file {filePath} in spec {specId} with {content}.
Rename spec {specId}'s file {filePath} to {name}.
GET /specs/{specId}/generations/{elementType} List collections generated from a spec · Get a spec's generated collections #
Ask an LLM
“Which collections have been generated from my specification?”
“Can I see every generated collection that is linked to a spec?”
Tell an agent
List the {elementType} generated from spec {specId}.
Show the first {limit} generated collections of specification {specId} ({elementType}).
POST /specs/{specId}/generations/{elementType} Generate a collection from a spec · Generate a collection from spec #
Ask an LLM
“How do I create a Postman collection from an OpenAPI 3.1 or Smithy spec?”
“Can I pass generation options when building a collection from a specification?”
Tell an agent
Generate a {elementType} named {name} from spec {specId} with options {options}.
Build a new collection called {name} from specification {specId} as {elementType} using {options}.
PUT /specs/{specId}/synchronizations Update a spec from its linked collection · Sync spec with collection #
Ask an LLM
“How do I pull changes made in a collection back into its linked specification?”
“Is syncing a spec from a collection asynchronous?”
Tell an agent
Sync spec {specId} with the changes in collection {collectionUid}.
Update specification {specId} to match linked collection {collectionUid}.
GET /specs/{specId}/version-tags/{tagId}/files Get a spec snapshot by version tag · Get a version tag #
Ask an LLM
“What did my specification look like at a tagged point in time?”
“Can I retrieve the files of a spec as captured by one version tag?”
Tell an agent
Get the files of spec {specId} at version tag {tagId}.
Show the snapshot of specification {specId} saved under tag {tagId}.
GET /specs/{specId}/version-tags List a spec's version tags · Get a specification's version tags #
Ask an LLM
“Which version tags have been created on my specification?”
“How can I see the history of tagged snapshots for a spec?”
Tell an agent
List the version tags on spec {specId}.
Show the latest {limit} tagged snapshots of specification {specId}.
POST /specs/{specId}/version-tags Tag a spec version · Create a version tag #
Ask an LLM
“How do I snapshot a specification so I can track changes over time?”
“What causes a conflict when creating a spec version tag?”
Tell an agent
Create version tag {name} on spec {specId}.
Snapshot specification {specId} under the tag {name}.

Documentation

📖
Documentation
https://www.postman.com/postman/postman-public-workspace/documentation/i2uqzpp/postman-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/postman/openapi/postman-specs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-create-update-spec-file-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-get-spec-file-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-spec-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-update-spec-file-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-update-spec-properties-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-create-spec-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postman:postman-specs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postman-specs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Specs API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:


# --- truncated at 32 KB (103 KB total) ---
# Full source: https://artifacts.apis.io/postman/openapi/postman-specs-api-openapi.yml