Generate GitHub Actions Workflow API

Generate a GitHub Actions workflow YAML file from a spec: trigger events, runner OS, steps with uses/run/env, matrix strategy, secrets references, and artifact upload/download. Supports common presets: CI, release, deploy. Available as a simple REST API — POST your input, get structured JSON back. 1 credit per call, no rate limiting, works in any language with HTTP support.

How it works

POST a JSON object with your input data to /v1/gen-doc-github-action. The API processes your request server-side using real computation (not mocked data) and returns a structured JSON response with your results and metadata including credits used and processing time.

Use cases

• Use Generate GitHub Actions Workflow in automated pipelines without installing a library
• Call Generate GitHub Actions Workflow from AI agent workflows via MCP or REST
• Integrate Generate GitHub Actions Workflow into serverless functions with zero dependencies
• Build Generate GitHub Actions Workflow functionality into any language that supports HTTP

API Reference

POST https://slopshop.gg/v1/gen-doc-github-action
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Input parameters

Example response

{
  "data": {
    "result": "success",
    "processed": true
  },
  "meta": {
    "credits_used": 1,
    "engine": "real",
    "ms": 4
  }
}

Examples

Three real-world scenarios showing how developers use Generate GitHub Actions Workflow in production.

curl -X POST https://slopshop.gg/v1/gen-doc-github-action \
  -H "Authorization: Bearer $SLOPSHOP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": "sample input data"}'

curl -X POST https://slopshop.gg/v1/gen-doc-github-action \
  -H "Authorization: Bearer $SLOPSHOP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": "agent workflow input for generate github actions workflow"}'

curl -X POST https://slopshop.gg/v1/gen-doc-github-action \
  -H "Authorization: Bearer $SLOPSHOP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": "production data payload"}'

Code examples

curl

curl -X POST https://slopshop.gg/v1/gen-doc-github-action \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": "your data here"}'

Python

import requests

response = requests.post(
    "https://slopshop.gg/v1/gen-doc-github-action",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"input": "your data here"}
)
result = response.json()
print(result["data"])

Node.js

const response = await fetch("https://slopshop.gg/v1/gen-doc-github-action", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ input: "your data here" })
});
const { data } = await response.json();
console.log(data);

CLI

# Install the Slopshop CLI
npm install -g slopshop

# Set your API key
export SLOPSHOP_KEY=your_api_key

# Call gen-doc-github-action
slop gen-doc-github-action '{"input": "your data here"}'

Pricing

Credits are purchased in bundles starting at $1 for 1,000 credits. All compute APIs like this one use 1 credit per call — that's $0.001. See all pricing tiers.

Related APIs in Generate: Doc

• Generate Markdown Table API — Convert a JSON array of objects to a formatted Markdown table. Supports custom column order, custom header labels, column alignment (left/center/right), and optional row numbering. Handles missing fields gracefully.
• Generate Markdown Badges API — Generate shields.io badge Markdown for common project metadata: npm version, GitHub stars, license, build status, coverage percentage, code size, last commit, and custom label/value/color badges.
• Generate CHANGELOG.md API — Generate a Keep a Changelog format CHANGELOG.md from an array of version entries. Each entry includes version number, release date, and categorized changes (Added, Changed, Deprecated, Removed, Fixed, Security).
• Generate README Template API — Generate a structured README.md template for a project type (npm-library, cli-tool, web-app, api-service, chrome-extension, etc.). Fills in provided project name, description, and tech stack into appropriate sections.
• Generate API Endpoint Docs API — Generate Markdown documentation for an API endpoint from a structured definition: method, path, description, request parameters, request body schema, response schema, example request/response, and error codes.

View the full API catalog · Try in playground · Documentation