Skyramp

Skyramp API

Skyramp API as documented publicly: 14 operations. Contract generated from the documentation by API Evangelist (2026-10-24); not the provider's own document.

GitHub OpenAPI

Operations 14

POST / POST / #
GET /* GET /* #
GET /api/v1/generate You can generate a session ID at any time simply by calling GET https://demoshop.skyramp.dev/api/v1/generate. #
GET /api/v1/orders Advanced Load Test Generation #
POST /api/v1/orders Create a new order #
DELETE /api/v1/orders/{orderId} Advanced Load Test Generation #
GET /api/v1/orders/{orderId} Advanced Load Test Generation #
GET /api/v1/products Advanced Load Test Generation #
POST /api/v1/products Create new product (via cURL) #
DELETE /api/v1/products/{productId} Advanced Load Test Generation #
POST /api/v1/reset You can clear state at any time simply by calling POST https://demoshop.skyramp.dev/api/v1/reset. #
GET /installer.sh Install or Upgrade Skyramp CLI #
POST /products POST /products #
GET /uninstaller.sh Uninstall Skyramp CLI #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/skyramp/openapi/_ae-authored/skyramp-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/skyramp/json-schema/skyramp-post-api-v1-products-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/skyramp/json-schema/skyramp-post-api-v1-orders-request-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/skyramp/apis.yml

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/skyramp:skyramp-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

skyramp-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Skyramp API
  version: '2026-10-24'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-24: 14 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Skyramp has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 11
    pages-with-code: 6
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-24'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.skyramp.dev/references/demo-shop
  - https://docs.skyramp.dev/quickstart/install
  - https://docs.skyramp.dev/agentic/agent
  - https://docs.skyramp.dev/e2e-test
  - https://docs.skyramp.dev/load-test/advanced-generation
  - https://docs.skyramp.dev/load-test/adjustments
  - https://docs.skyramp.dev/integration-test/advanced-generation
servers:
- url: https://demoshop.skyramp.dev
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.skyramp.dev/integration-test/advanced-generation
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl) GET of products (via UI) - opening page POST of a new order containing the new product (via cURL) GET of all orders (via
          UI) GET of the new order (via UI) DELETE of the new order (via UI) DELETE of newly created product (via UI) We are using cURL to demonstrate
          the network calls, however, any network call that is made from the newly spawned shell will be collected by Skyramp (e.g. executing '
  /*:
    get:
      operationId: get
      tags:
      - API
      summary: GET /*
      x-source: https://docs.skyramp.dev/agentic/agent
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl) Find product in product list (via UI) Update the product price (via UI) Create new order containing the new product (via
          curl) Find order in order list (via UI) Assert total price of the order (via UI) Delete newly created order (via UI) Delete newly created
          product (via UI) Stop Trace Collection Once you have completed your scenario in the Playwright Browser, simply head back to Cursor and '
  /api/v1/generate:
    get:
      operationId: get_api_v1_generate
      tags:
      - Api
      summary: You can generate a session ID at any time simply by calling GET https://demoshop.skyramp.dev/api/v1/generate.
      description: Generates a new session ID to be used in the Authorization header for subsequent Demo Shop API calls.
      x-source: https://docs.skyramp.dev/references/demo-shop
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/orders:
    get:
      operationId: get_api_v1_orders
      tags:
      - Api
      summary: Advanced Load Test Generation
      x-source: https://docs.skyramp.dev/load-test/advanced-generation
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_orders
      tags:
      - Api
      summary: Create a new order
      x-source: https://docs.skyramp.dev/integration-test/advanced-generation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1OrdersRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/orders/{orderId}:
    delete:
      operationId: delete_api_v1_orders_orderId
      tags:
      - Api
      summary: Advanced Load Test Generation
      x-source: https://docs.skyramp.dev/load-test/advanced-generation
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_v1_orders_orderId
      tags:
      - Api
      summary: Advanced Load Test Generation
      x-source: https://docs.skyramp.dev/load-test/advanced-generation
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/products:
    get:
      operationId: get_api_v1_products
      tags:
      - Api
      summary: Advanced Load Test Generation
      x-source: https://docs.skyramp.dev/load-test/advanced-generation
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_products
      tags:
      - Api
      summary: Create new product (via cURL)
      x-source: https://docs.skyramp.dev/e2e-test
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ProductsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/products/{productId}:
    delete:
      operationId: delete_api_v1_products_productId
      tags:
      - Api
      summary: Advanced Load Test Generation
      x-source: https://docs.skyramp.dev/load-test/advanced-generation
      parameters:
      - name: productId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reset:
    post:
      operationId: post_api_v1_reset
      tags:
      - Api
      summary: You can clear state at any time simply by calling POST https://demoshop.skyramp.dev/api/v1/reset.
      description: Resets the database to its original seed state while keeping the same session ID; requires the session ID in the Authorization
        header.
      x-source: https://docs.skyramp.dev/references/demo-shop
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /installer.sh:
    get:
      operationId: get_installer_sh
      tags:
      - Installer
      summary: Install or Upgrade Skyramp CLI
      x-source: https://docs.skyramp.dev/quickstart/install
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /products:
    post:
      operationId: post_products
      tags:
      - Products
      summary: POST /products
      x-source: https://docs.skyramp.dev/e2e-test
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl) Find product in product list (via UI) Update the product price (via UI) Create new order containing the new product (via
          cURL) Find order in order list (via UI) Assert total price of the order (via UI) Delete newly created order (via UI) Delete newly created
          product (via UI) Let's get started! 1. Setup session (via UI) To start, in the newly spawned Chromium browser, go to https://demoshop.s
  /uninstaller.sh:
    get:
      operationId: get_uninstaller_sh
      tags:
      - Uninstaller
      summary: Uninstall Skyramp CLI
      x-source: https://docs.skyramp.dev/quickstart/install
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1OrdersRequest:
      type: object
      properties:
        customer_email:
          type: string
        items:
          type: string
      required:
      - customer_email
      - items
    PostApiV1ProductsRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        price:
          type: string
        image_url:
          type: string
        category:
          type: string
        in_stock:
          type: string
      required:
      - name
      - description
      - price
      - image_url
      - category
      - in_stock
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: API
- name: Api
- name: Installer
- name: Products
- name: Uninstaller