Alloy Automation

Alloy Automation Metadata API

The Metadata API from Alloy Automation — 3 operation(s) for metadata.

Documentation GitHub OpenAPI

Operations 3

GET /metadata/credentials Retrieve all credential structures #

GET /metadata/apps Retrieve all supported apps #

GET /metadata/credentials/{credentialName} Retrieve credential structure for an app #

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/alloy-automation:alloy-automation-metadata-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

openapi: 3.2.0
info:
  title: Embedded 2025-09 Metadata API
  version: '5.0'
servers:
- url: https://production.runalloy.com
tags:
- name: Metadata
paths:
  /metadata/credentials:
    get:
      summary: Retrieve all credential structures
      description: 'This endpoint returns a basic structure of what data must be inputted when adding a credential manually. This should be used when creating a credential using the POST credential endpoint.


        This endpoint returns the structure of every supported block on Alloy Embedded. It returns a boolean flag called `isOauth` which indicates if the credential uses OAuth or an API key.'
      operationId: get-credential-metadata
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    data:
                    - connector: acuityScheduling
                      icon: https://cdn.runalloy.com/icons/acuityScheduling.png
                      isOauth: false
                      properties:
                      - name: apiKey
                        displayName: API Key
                      - name: userId
                        displayName: User Id
                    - connector: amazonBusiness
                      icon: https://cdn.runalloy.com/icons/amazonBusiness.png
                      isOauth: true
                      properties:
                      - name: regionCountry
                        displayName: Country
                        description: ''
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        connector:
                          type: string
                          example: acuityScheduling
                        icon:
                          type: string
                          example: https://cdn.runalloy.com/icons/acuityScheduling.png
                        isOauth:
                          type: boolean
                          example: false
                          default: true
                        properties:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: apiKey
                              displayName:
                                type: string
                                example: API Key
      deprecated: false
      security: []
      tags:
      - Metadata
  /metadata/apps:
    get:
      summary: Retrieve all supported apps
      description: Returns all the available apps currently supported by Alloy Embedded
      operationId: list-apps
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    data:
                    - connector: acuityScheduling
                      icon: https://cdn.runalloy.com/icons/acuityScheduling.png
                      type:
                      - action
                      - trigger
                      oauth: false
                    - connector: shopify
                      icon: https://cdn.runalloy.com/icons/shopify.png
                      type:
                      - action
                      - trigger
                      oauth: true
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      tags:
      - Metadata
  /metadata/credentials/{credentialName}:
    get:
      summary: Retrieve credential structure for an app
      description: ''
      operationId: credential-medata-by-app
      parameters:
      - name: credentialName
        in: path
        description: Name of connector (camelCased, can be found in App Metadata response)
        schema:
          type: string
        required: true
      - name: Authorization
        in: header
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    data:
                      connector: shopify
                      icon: https://cdn.runalloy.com/icons/shopify.png
                      isOauth: true
                      properties:
                      - name: shopSubdomain
                        displayName: Shop Subdomain
                        description: Enter your store subdomain. If your store domain is example.myshopify.com, the subdomain would be example.
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                        example: shopify
                      icon:
                        type: string
                        example: https://cdn.runalloy.com/icons/shopify.png
                      isOauth:
                        type: boolean
                        example: true
                        default: true
                      properties:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: shopSubdomain
                            displayName:
                              type: string
                              example: Shop Subdomain
                            description:
                              type: string
                              example: Enter your store subdomain. If your store domain is example.myshopify.com, the subdomain would be example.
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      tags:
      - Metadata
components:
  parameters:
    xApiVersion:
      name: x-api-version
      in: header
      required: true
      description: The version of the API to use. The current API version is **2025-09**.
      schema:
        type: string
        default: 2025-09
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
x-readme:
  headers: []
  explorer-enabled: true
  proxy-enabled: true
x-readme-fauxas: true
x-provenance:
  method: harvested
  publisher: Alloy Automation
  source: https://docs.runalloy.com/openapi/2025-09/embedded/embedded.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)