ReadMe · Arazzo Workflow

ReadMe Publish A Custom Page

Version 1.0.0

Create a custom page on a branch and read it back by slug.

1 workflow 1 source API 1 provider
View Spec View on GitHub DocumentationDeveloper HubAPI ReferencePortalAnalyticsArtificial IntelligenceMCPBi-Directional SyncArazzoWorkflows

Provider

readme

Workflows

publish-custom-page
Create a custom page then fetch it back by slug.
Creates a custom page on the supplied branch and reads it back by slug to confirm it was published.
2 steps inputs: apiKey, body, branch, htmlmode, title outputs: slug, title
1
createCustomPage
{$sourceDescriptions.readmeApi.url}#/paths/~1branches~1{branch}~1custom_pages/post
Create a custom page on the target branch.
2
getCustomPage
{$sourceDescriptions.readmeApi.url}#/paths/~1branches~1{branch}~1custom_pages~1{slug}/get
Read the created custom page back by slug to confirm publication.

Source API Descriptions

Arazzo Workflow Specification

Raw ↑
arazzo: 1.0.1
info:
  title: ReadMe Publish A Custom Page
  summary: Create a custom page on a branch and read it back by slug.
  description: >-
    Custom pages host standalone documentation content such as landing pages,
    legal copy, or HTML-mode microsites. This workflow creates a custom page on
    the target branch and then fetches it back by slug to confirm it was
    published. Every step spells out its request inline so the flow can be read
    and executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: readmeApi
  url: ../openapi/readme-openapi.yml
  type: openapi
workflows:
- workflowId: publish-custom-page
  summary: Create a custom page then fetch it back by slug.
  description: >-
    Creates a custom page on the supplied branch and reads it back by slug to
    confirm it was published.
  inputs:
    type: object
    required:
    - branch
    - title
    - body
    properties:
      branch:
        type: string
        description: The branch (version) to publish the custom page on.
      title:
        type: string
        description: The custom page title.
      body:
        type: string
        description: The Markdown (or HTML) body of the custom page.
      htmlmode:
        type: boolean
        description: Whether the body should be rendered as raw HTML.
      apiKey:
        type: string
        description: ReadMe API key used as a Bearer token.
  steps:
  - stepId: createCustomPage
    description: Create a custom page on the target branch.
    operationPath: '{$sourceDescriptions.readmeApi.url}#/paths/~1branches~1{branch}~1custom_pages/post'
    parameters:
    - name: branch
      in: path
      value: $inputs.branch
    - name: Authorization
      in: header
      value: "Bearer $inputs.apiKey"
    requestBody:
      contentType: application/json
      payload:
        title: $inputs.title
        body: $inputs.body
        htmlmode: $inputs.htmlmode
    successCriteria:
    - condition: $statusCode == 201
    outputs:
      slug: $response.body#/slug
  - stepId: getCustomPage
    description: Read the created custom page back by slug to confirm publication.
    operationPath: '{$sourceDescriptions.readmeApi.url}#/paths/~1branches~1{branch}~1custom_pages~1{slug}/get'
    parameters:
    - name: branch
      in: path
      value: $inputs.branch
    - name: slug
      in: path
      value: $steps.createCustomPage.outputs.slug
    - name: Authorization
      in: header
      value: "Bearer $inputs.apiKey"
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      title: $response.body#/title
  outputs:
    slug: $steps.createCustomPage.outputs.slug
    title: $steps.getCustomPage.outputs.title

Work with this as data

Every workflow 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 arazzo workflows

4 MCP tools reach this
  • find_arazzoBrowse and filter every workflow in the catalog.
  • 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 workflow
curl "https://apis.io/api/v1/arazzo/readme-publish-custom-page-workflow"
All arazzo workflows
curl "https://apis.io/api/v1/arazzo?limit=25"

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

Get an API key

Free tier, no email required.

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