How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amperity Workflow API

List, run, and stop workflows.

Amperity Workflow API is one of 8 APIs that Amperity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and rate-limit docs.

This API exposes 4 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.amperity.com/api, https://.amperity.com/api.

4 operations 3 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.amperity.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Amperity Workflow API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Authenticate using a Bearer token generated from an Amperity API key. Include the token in the Authorization header of every request.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow 4

List, run, and stop workflows.

GET
/workflow/runs
GET /workflow/runs
list-workflows 11 params → 200400401403500
POST
/workflow/runs
POST /workflow/runs
run-workflow 2 params body → 201400401403500
GET
/workflow/runs/{workflow-id}
GET /workflow/runs/{workflow-id}
get-workflow 4 params → 200400401403404500
POST
/workflow/runs/{workflow-id}/stop
POST /workflow/runs/{workflow-id}/stop
stop-workflow 3 params → 200400401403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Workflow (15 properties), WorkflowTaskInstance (14 properties), WorkflowError (4 properties), WorkflowRunRequest (4 properties). Each schema is shown below with its type and property counts.

Workflow
object
A workflow.
15 properties 6 required
WorkflowTaskInstance
object
A task within a workflow.
14 properties 3 required
ErrorResponse
object
An error response returned by the API.
2 properties 2 required
WorkflowRunRequest
object
The request body used to start a new workflow.
4 properties 1 required
WorkflowError
object
An error associated with a workflow or workflow task.
4 properties 2 required
WorkflowList
object
A paginated list of workflows.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amperity-workflow-api-openapi.yml Raw ↑

Other APIs Amperity publishes across the network.

Amperity MCP Server
Amperity Profile API
Amperity Streaming API
Amperity Audit Events API
Amperity Campaigns API
Amperity Ingest API
Amperity Segments API
Where this information came from

This is an independent, third-party profile of Amperity Workflow API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.