API Referencev1

Platform API and SDKs

Use Nexra from your own code with the platform API, the TypeScript SDK or the Python SDK, all generated from one versioned OpenAPI document.

Updated 11/10/2026

On this page

What you can do

The platform API does what the console does, from your own code:

build and change integrations and flows, publish versions and request go-live;

start runs, follow them record by record, and retry or resolve failed records;

manage connections (settings and status only; credentials are added in the console), schedules and triggers;

run reconciliations and work through the review queue;

add event webhooks and receive signed events;

read and decide approvals, and read governance evidence;

reach published integrations as tools through MCP;

ask about company data and read the Leadership summary as yourself, from an AI client or a custom connector (Company data over REST).

The full list is in the Platform API reference.

The OpenAPI document

One OpenAPI 3.1 document describes the whole platform API, including every event Nexra sends to your endpoints.

text
https://api.nexra.amakoragroup.com/api/public/openapi.json

Use it to generate a client in any language, import it into Postman or Insomnia, or give it to an AI agent. The document is versioned by date; this is version 2026-10-01. Adding an operation or an optional field is not a breaking change. A breaking change gets a new dated version.

Sign in

Install the CLI and run nexra auth login. It opens the console for you to approve, then stores an access token.

Send it with every request, with the workspace to act in:

http
Authorization: Bearer <access token>
X-Workspace-Id: <workspace id>

The token acts with your own role, so the API can do exactly what you can do in the console. Without X-Workspace-Id, your oldest active workspace is used.

SDKs

LanguagePackageGuide
TypeScript/JavaScript@amakora/nexra-sdk (npm)TypeScript SDK
Pythonnexra (PyPI)Python SDK
Gogithub.com/TochukwuAchebe/nexra-goGo SDK
C# and .NETAmakora.Nexra (NuGet)C# and .NET SDK
Java and Kotlincom.amakoragroup.nexra:nexra-sdk (Maven)Java SDK
Any otherGenerate from the OpenAPI documentPlatform API reference

If your build cannot reach a public registry, ask for the package file at contact@amakoragroup.com. You can also generate a client from the OpenAPI document, or call the API directly.

Every SDK adds the sign-in headers, retries safely with backoff, adds idempotency keys when you start runs, follows cursor pages and verifies event signatures.

Errors

Every error has the same shape:

json
{
  "error": "request_failed",
  "message": "A bounded execution idempotency key is required.",
  "statusCode": 400,
  "requestId": "1f0c2a4e-6b1d-4c39-9d0f-2f8a8e1f6b7a",
  "path": "/api/console/connect/flows/cmflow01orders/executions"
}

code is added where a stable reason exists, for example approval_digest_mismatch. Quote requestId (also the X-Request-ID header) when you contact support.

Lists and pages

Most lists return the newest items first as a plain array with a documented cap. Governance lists return { "items": [...], "nextCursor": "..." }; pass nextCursor back as cursor until it is null.

Retrying safely

Starting a run takes an idempotencyKey. Sending the same key again returns the first run instead of starting a second one, so you can retry after a timeout. The SDKs make the key for you and only retry requests that are safe to repeat.

Events

Add an endpoint under Webhooks or with POST /api/console/connect/event-webhooks. Each delivery is signed with X-Amakora-Signature. Verify it with the SDK, answer with any 2xx within 8 seconds, and de-duplicate on the event id. See Webhooks and the events section of the reference.

Need a hand?

Ask Nexra Agent for implementation steps or error guidance.

Ask Nexra Agent