Postman

Postman Postbot API

The postbot API from Postman — 1 operation(s) for postbot.

GitHub OpenAPI

Operations 1

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

POST /postbot/generations/tool Generate agent tool code from a public request · Generate a tool #
Ask an LLM
“Can I generate AI agent tool code from a public collection request?”
“What is the rate limit on the deprecated tool generation endpoint?”
Tell an agent
Generate agent tool code for request {requestId} in public collection {collectionId} with config {config}.
Build a tool from request {requestId} of collection {collectionId} using {config}.

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-postbot-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-generate-tool-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-generate-tool-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-postbot-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-postbot-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Postbot 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:
- name: postbot
paths:
  /postbot/generations/tool:
    post:
      operationId: generateTool
      summary: Generate a tool
      description: '**This endpoint is deprecated**


        Generates code for an AI agent tool using a collection and request from the Public API Network. For more information, see **Tool Generation Demo** in Postman''s Public API Network.


        ### Important


        - This endpoint has a rate limit of **300 calls every 3 hours**. This does not accrue Postbot usage.

        - This endpoint only supports public Postman Collections and requests.'
      tags:
      - postbot
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateToolResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbot400Error'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateToolRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generateTool'
components:
  schemas:
    commonErrorTypeTitleDetail:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail'
          description: Information about the error.
      title: commonErrorTypeTitleDetail
    CommonErrorTypeTitleDetailDetail:
      oneOf:
      - type: string
      - type: object
        additionalProperties:
          description: Any type
      description: Information about the error.
      title: CommonErrorTypeTitleDetailDetail
    GenerateToolConfigAgentFramework:
      type: string
      enum:
      - openai
      - mistral
      - gemini
      - anthropic
      - langchain
      - autogen
      description: The AI agent framework to use. Note that the `autogen` framework only supports the `python` language.
      title: GenerateToolConfigAgentFramework
    GenerateToolConfig:
      type: object
      properties:
        language:
          $ref: '#/components/schemas/GenerateToolConfigLanguage'
          description: The programming language to use.
        agentFramework:
          $ref: '#/components/schemas/GenerateToolConfigAgentFramework'
          description: The AI agent framework to use. Note that the `autogen` framework only supports the `python` language.
      required:
      - language
      - agentFramework
      description: Information about the request.
      title: GenerateToolConfig
    commonErrorNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageError'
          description: Information about the error.
      title: commonErrorNameMessage
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
      - type: string
        format: uri-reference
      - type: string
      title: CommonErrorTypeTitleDetailStatusType
    GenerateToolRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GenerateToolRequestInternalServerError
    GenerateToolResponseData:
      type: object
      properties:
        text:
          type: string
          description: The generated tool code.
      description: The generated response data.
      title: GenerateToolResponseData
    generateTool:
      type: object
      properties:
        requestId:
          type: string
          description: The public collection's request ID.
        collectionId:
          type: string
          format: uid
          description: The Public API Network collection's ID.
        config:
          $ref: '#/components/schemas/GenerateToolConfig'
          description: Information about the request.
      required:
      - requestId
      - collectionId
      - config
      title: generateTool
    CommonErrorNameMessageError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      description: Information about the error.
      title: CommonErrorNameMessageError
    commonErrorTypeTitleDetailStatus:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType'
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Information about the error.
        status:
          type: integer
          description: The error's HTTP status code.
      title: commonErrorTypeTitleDetailStatus
    generateToolResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GenerateToolResponseData'
          description: The generated response data.
      title: generateToolResponse
    GenerateToolConfigLanguage:
      type: string
      enum:
      - javascript
      - typescript
      - python
      description: The programming language to use.
      title: GenerateToolConfigLanguage
    postbot400Error:
      type: object
      properties:
        detail:
          type: string
          description: Details about the occurrence of the error.
        status:
          type: number
          format: double
          description: The error's HTTP status code.
        title:
          type: string
          description: A short summary of the error.
        type:
          type: string
          format: uri
          description: The error type.
      title: postbot400Error
  securitySchemes:
    PostmanApiKey:
      type: apiKey
      in: header
      name: x-api-key
    basicAuth:
      type: http
      scheme: basic
    scimApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
x-provenance:
  first_party: true
  method: harvested
  provider_published: true
  source: https://learning.postman.com/api-docs/openapi.json
  harvested: '2026-08-05'
  note: Postman's own OpenAPI 3.1 definition for the Postman API, served by its Fern-hosted API reference. 162 paths, 256 operations, servers api.postman.com and api.eu.postman.com.