Air Pipe Examples API

Air Pipe Examples API as documented publicly: 28 operations. Contract generated from the documentation by API Evangelist (2026-11-01); not the provider's own document.

Operations 28

POST / POST / #
POST /ai/complete LLM Gateway — A configurable LLM completion and content-moderation endpoint. #
POST /ai/moderate LLM Gateway — A configurable LLM completion and content-moderation endpoint. #
GET /api/analytics/author-activity Author activity #
GET /api/analytics/posts-by-category Posts by category #
GET /api/analytics/posts-by-status Posts by status #
GET /api/categories List categories #
POST /api/categories/create Create category #
DELETE /api/categories/delete Delete category #
POST /api/categories/get Get category #
POST /api/me Get current user #
GET /api/posts List published posts #
GET /api/posts/all List all posts #
POST /api/posts/create Create post #
DELETE /api/posts/delete Delete post #
POST /api/posts/get Get post #
PUT /api/posts/update Update post #
POST /api/seed POST /api/seed #
GET /api/users List users ( passwordHash excluded) #
POST /api/users/create Create user #
DELETE /api/users/delete Delete user #
POST /api/users/get Get user #
PUT /api/users/update Update user #
POST /graphql/sync Run a parameterised query, check errors, upsert the result. #
GET /graphql/users List synced records #
POST /jobs-status Read a job's outcome #
POST /jobs-submit Start a job and get its id immediately #

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/airpipe-io:examples-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.

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

OpenAPI Specification

airpipe-io-examples-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Air Pipe Examples API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 28 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Air Pipe has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 11
    documentation: 26
    pages-with-code: 9
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-01'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.airpipe.io/docs/examples/marketplace
  - https://docs.airpipe.io/docs/examples/marketplace/async-job-api
  - https://docs.airpipe.io/docs/examples/marketplace/graphql-client
  - https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
  x-docs-section: examples
servers:
- url: https://app.airpipe.io
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.airpipe.io/docs/examples/marketplace/async-job-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://<host>/jobs-init -d ''{}'' # 2. start a job. `owner` comes from the token, so the body carries only the
          work. curl -X POST https://<host>/jobs-submit -H "airpipe-jwt: $TOKEN" \ -H ''content-type: application/json'' \ -d ''{"payload":{"report":"quarterly"}}''
          # -> { "accepted": true, "id": "...", "status": "running", "watch": "jobs:alice" } # 3. the answer arrives on the channel. Thi'
  /ai/complete:
    post:
      operationId: post_ai_complete
      tags:
      - Ai
      summary: LLM Gateway — A configurable LLM completion and content-moderation endpoint.
      x-source: https://docs.airpipe.io/docs/examples/marketplace
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAiCompleteResponse'
      x-evidence:
        kind: documentation
  /ai/moderate:
    post:
      operationId: post_ai_moderate
      tags:
      - Ai
      summary: LLM Gateway — A configurable LLM completion and content-moderation endpoint.
      x-source: https://docs.airpipe.io/docs/examples/marketplace
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAiModerateResponse'
      x-evidence:
        kind: documentation
  /api/analytics/author-activity:
    get:
      operationId: get_api_analytics_author_activity
      tags:
      - Api
      summary: Author activity
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAnalyticsAuthorActivityResponse'
      x-evidence:
        kind: documentation
  /api/analytics/popular-tags:
    get:
      operationId: get_api_analytics_popular_tags
      tags:
      - Api
      summary: Popular tags
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAnalyticsPopularTagsResponse'
      x-evidence:
        kind: documentation
  /api/analytics/posts-by-category:
    get:
      operationId: get_api_analytics_posts_by_category
      tags:
      - Api
      summary: Posts by category
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAnalyticsPostsByCategoryResponse'
      x-evidence:
        kind: documentation
  /api/analytics/posts-by-status:
    get:
      operationId: get_api_analytics_posts_by_status
      tags:
      - Api
      summary: Posts by status
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAnalyticsPostsByStatusResponse'
      x-evidence:
        kind: documentation
  /api/categories:
    get:
      operationId: get_api_categories
      tags:
      - Api
      summary: List categories
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/categories/create:
    post:
      operationId: post_api_categories_create
      tags:
      - Api
      summary: Create category
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCategoriesCreateRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCategoriesCreateResponse'
      x-evidence:
        kind: documentation
  /api/categories/delete:
    delete:
      operationId: delete_api_categories_delete
      tags:
      - Api
      summary: Delete category
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiCategoriesDeleteResponse'
      x-evidence:
        kind: documentation
  /api/categories/get:
    post:
      operationId: post_api_categories_get
      tags:
      - Api
      summary: Get category
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCategoriesGetRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCategoriesGetResponse'
      x-evidence:
        kind: documentation
  /api/me:
    post:
      operationId: post_api_me
      tags:
      - Api
      summary: Get current user
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiMeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMeResponse'
      x-evidence:
        kind: documentation
  /api/posts:
    get:
      operationId: get_api_posts
      tags:
      - Api
      summary: List published posts
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/posts/all:
    get:
      operationId: get_api_posts_all
      tags:
      - Api
      summary: List all posts
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/posts/create:
    post:
      operationId: post_api_posts_create
      tags:
      - Api
      summary: Create post
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPostsCreateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/posts/delete:
    delete:
      operationId: delete_api_posts_delete
      tags:
      - Api
      summary: Delete post
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/posts/get:
    post:
      operationId: post_api_posts_get
      tags:
      - Api
      summary: Get post
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPostsGetRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/posts/update:
    put:
      operationId: put_api_posts_update
      tags:
      - Api
      summary: Update post
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiPostsUpdateRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/seed:
    post:
      operationId: post_api_seed
      tags:
      - Api
      summary: POST /api/seed
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSeedRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://your-airpipe-host/api/seed # → [ { \"status\": \"archived\", \"count\": 1 }, # { \"status\": \"draft\"\
          , \"count\": 1 }, # { \"status\": \"published\",\"count\": 4 } ] \n Quick start: curl walkthrough ​ \n BASE=https://your-airpipe-host\
          \ # Seed sample users, posts, and categories curl -X POST $BASE/api/seed # List published posts curl $BASE/api/posts # Create a user\
          \ (password is bcrypt-hashed befor"
  /api/users:
    get:
      operationId: get_api_users
      tags:
      - Api
      summary: List users ( passwordHash excluded)
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/users/create:
    post:
      operationId: post_api_users_create
      tags:
      - Api
      summary: Create user
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiUsersCreateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/users/delete:
    delete:
      operationId: delete_api_users_delete
      tags:
      - Api
      summary: Delete user
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/users/get:
    post:
      operationId: post_api_users_get
      tags:
      - Api
      summary: Get user
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiUsersGetRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/users/update:
    put:
      operationId: put_api_users_update
      tags:
      - Api
      summary: Update user
      x-source: https://docs.airpipe.io/docs/examples/marketplace/mongodb-atlas-backend-rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiUsersUpdateRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /graphql/sync:
    post:
      operationId: post_graphql_sync
      tags:
      - Graphql
      summary: Run a parameterised query, check errors, upsert the result.
      x-source: https://docs.airpipe.io/docs/examples/marketplace/graphql-client
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGraphqlSyncRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGraphqlSyncResponse'
      x-evidence:
        kind: documentation
  /graphql/users:
    get:
      operationId: get_graphql_users
      tags:
      - Graphql
      summary: List synced records
      x-source: https://docs.airpipe.io/docs/examples/marketplace/graphql-client
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of records to return (default 25)
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGraphqlUsersResponse'
      x-evidence:
        kind: documentation
  /jobs-status:
    post:
      operationId: post_jobs_status
      tags:
      - Jobs Status
      summary: Read a job's outcome
      x-source: https://docs.airpipe.io/docs/examples/marketplace/async-job-api
      parameters:
      - name: airpipe-jwt
        in: header
        required: true
        schema:
          type: string
        description: JWT token for authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostJobsStatusRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostJobsStatusResponse'
      x-evidence:
        kind: documentation
  /jobs-submit:
    post:
      operationId: post_jobs_submit
      tags:
      - Jobs Submit
      summary: Start a job and get its id immediately
      x-source: https://docs.airpipe.io/docs/examples/marketplace/async-job-api
      parameters:
      - name: airpipe-jwt
        in: header
        required: true
        schema:
          type: string
        description: JWT token for authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostJobsSubmitRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostJobsSubmitResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAiCompleteResponse:
      type: object
      properties:
        '200':
          type: string
          description: Successful response
    PostAiModerateResponse:
      type: object
      properties:
        '200':
          type: string
          description: Successful response
    GetApiAnalyticsAuthorActivityResponse:
      type: object
      properties:
        author:
          type: string
        posts:
          type: integer
        avgRating:
          type: number
    GetApiAnalyticsPopularTagsResponse:
      type: object
      properties:
        tag:
          type: string
        count:
          type: integer
    GetApiAnalyticsPostsByCategoryResponse:
      type: object
      properties:
        category:
          type: string
        posts:
          type: integer
        avgRating:
          type: number
    GetApiAnalyticsPostsByStatusResponse:
      type: object
      properties:
        status:
          type: string
        count:
          type: integer
    PostApiCategoriesCreateRequest:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        description:
          type: string
      required:
      - slug
      - name
      - description
    PostApiCategoriesCreateResponse:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        postCount:
          type: integer
    DeleteApiCategoriesDeleteResponse:
      type: object
      properties:
        deleted:
          type: integer
    PostApiCategoriesGetRequest:
      type: object
      properties:
        slug:
          type: string
      required:
      - slug
    PostApiCategoriesGetResponse:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        postCount:
          type: integer
    PostApiMeRequest:
      type: object
      properties:
        token:
          type: string
      required:
      - token
    PostApiMeResponse:
      type: object
      properties:
        username:
          type: string
        email:
          type: string
        isActive:
          type: boolean
        roles:
          type: array
    PostApiPostsCreateRequest:
      type: object
      properties:
        slug:
          type: string
        title:
          type: string
        body:
          type: string
        status:
          type: string
        author:
          type: string
        category:
          type: string
      required:
      - slug
      - title
      - body
      - status
      - author
      - category
    PostApiPostsGetRequest:
      type: object
      properties:
        slug:
          type: string
      required:
      - slug
    PutApiPostsUpdateRequest:
      type: object
      properties:
        slug:
          type: string
        title:
          type: string
        body:
          type: string
        status:
          type: string
      required:
      - slug
      - title
      - body
      - status
    PostApiSeedRequest:
      type: object
      properties:
        username:
          type: string
        email:
          type: string
        password:
          type: string
    PostApiUsersCreateRequest:
      type: object
      properties:
        username:
          type: string
        email:
          type: string
        password:
          type: string
      required:
      - username
      - email
      - password
    PostApiUsersGetRequest:
      type: object
      properties:
        username:
          type: string
      required:
      - username
    PutApiUsersUpdateRequest:
      type: object
      properties:
        username:
          type: string
        email:
          type: string
      required:
      - username
      - email
    PostGraphqlSyncRequest:
      type: object
      properties:
        login:
          type: string
          description: GitHub login to query
      required:
      - login
    PostGraphqlSyncResponse:
      type: object
      properties:
        login:
          type: string
        name:
          type: string
        repos:
          type: integer
        synced:
          type: boolean
    GetGraphqlUsersResponse:
      type: object
      properties:
        login:
          type: string
        name:
          type: string
        repo_count:
          type: integer
        synced_at:
          type: string
          description: Timestamp of last sync
    PostJobsStatusRequest:
      type: object
      properties:
        job_id:
          type: string
          description: Identifier of the job to query
      required:
      - job_id
    PostJobsStatusResponse:
      type: object
      properties:
        id:
          type: string
          description: Job identifier
        owner:
          type: string
          description: Owner of the job
        status:
          type: string
          description: Current status of the job (e.g., running, done, failed, timed_out)
        result:
          type: string
          description: Result payload if job completed successfully
        error:
          type: string
          description: Error message if job failed
        created_at:
          type: string
          description: Timestamp when the job was created
        finished_at:
          type: string
          description: Timestamp when the job finished
    PostJobsSubmitRequest:
      type: object
      properties:
        payload:
          type: string
          description: Arbitrary job payload
      required:
      - payload
    PostJobsSubmitResponse:
      type: object
      properties:
        job_id:
          type: string
          description: Identifier of the created job
        status:
          type: string
          description: HTTP status code of the submission (e.g., 200)
  securitySchemes:
    Backend_API_key:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    Backend_API_key_alternative_header:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    Backend_API_key_query:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    JWT_shared_secret:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    JWT_shared_secret_query:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    JWT_JWKS:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    OAuth2_Authorization_Code:
      type: http
      scheme: bearer
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
    Basic_Auth:
      type: http
      scheme: basic
      x-source: https://docs.airpipe.io/docs/features/realtime/realtime-auth/
tags:
- name: Ai
- name: Api
- name: Graphql
- name: Jobs Status
- name: Jobs Submit
security:
- Backend_API_key: []
- Backend_API_key_alternative_header: []
- Backend_API_key_query: []
- JWT_shared_secret: []
- JWT_shared_secret_query: []
- JWT_JWKS: []
- OAuth2_Authorization_Code: []
- Basic_Auth: []