An API that treats workflows as first-class resources
Trigger runs, stream step events, manage connections, and subscribe to webhooks. Everything available in the interface is available programmatically.
curl https://api.amplifyai.com/v1/runs \
-H "Authorization: Bearer $AMPLIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"workflow": "invoice-intake",
"input": {
"document_url": "https://files.example.com/inv-8842.pdf",
"vendor_hint": "Northwind Supply"
}
}'import { Amplify } from "@amplifyai/sdk";
const amplify = new Amplify({ apiKey: process.env.AMPLIFY_API_KEY });
const run = await amplify.runs.create({
workflow: "contract-review",
input: { documentId: "doc_9f21" },
});
for await (const event of amplify.runs.stream(run.id)) {
console.log(event.step, event.status);
}Everything you need to integrate
REST API
Predictable resource-oriented endpoints with cursor pagination and idempotency keys.
SDKs
First-party TypeScript and Python clients with typed responses and retry handling.
Authentication
Workspace-scoped API keys and OAuth for partner applications, rotatable at any time.
Webhooks
Signed event delivery for run.created, run.step.completed, run.failed, and approvals.
API reference
Endpoint-by-endpoint reference with request and response examples in every language.
Sandbox
A non-billable environment with seeded documents for integration testing and CI.
Subscribe to the lifecycle
Every delivery is signed with an HMAC signature and retried with exponential backoff for 24 hours.
run.createdA workflow run has been accepted and queued.run.step.completedAn individual step finished, including extracted output.run.approval.requestedA human approval gate is waiting on a reviewer.run.completedThe run finished successfully with final output.run.failedThe run stopped; payload includes the failing step and error.