Gateway connector API reference
Authentication, request envelopes, shared connector tools and SDK download contracts.
Updated 08/10/2026
On this page
Origins and authentication
Your API base URL: https://api.nexra.amakoragroup.com.
External Gateway REST calls use Authorization: Bearer <Nexra MCP OAuth access token> and Content-Type: application/json. The token selects the application and published MCP server; explicit tool grants and current policy still apply. No MCP-Session-Id is needed for REST. See connection setup for MCP protocol, CLI and SDK examples.
Request and response contracts
| Endpoint | Contract |
|---|---|
POST /api/gateway/tools/{toolName} | External OAuth/grant-governed tool call; body { "arguments": {}, "meta": {} }; result is MCP-compatible content containing JSON as text |
POST /api/console/gateway/applications/{applicationId}/tools/{toolName} | Authenticated workspace member and application project; body { "arguments": {}, "meta": {} }; structured JSON result |
GET /api/gateway/sdk/typescript | Public current SDK download: JSON files with name and content; save runtime and declarations together |
POST /mcp | OAuth-governed JSON-RPC Streamable HTTP; initialise first, then tools/list / tools/call |
The connector's credentials are never an argument to these tools. Unknown tools, foreign connections, invalid inputs and missing grants are rejected. Describe each provider operation before sending its input.
Shared tools
| Tool | Required arguments | Scope |
|---|---|---|
search_capabilities | query; optional mode, limit | connect:read |
describe_capability | connectionId, operationKey | connect:read |
resolve_capability | query; optional explicit account/operation selection, mode | connect:read |
compose_workflow | No arguments lists blueprints; workflowKey, bindings constructs a bound plan | connect:read |
execute_capability | connectionId, operationKey, described input; stable idempotencyKey for writes | connect:execute |
qualify_complete_read_workflow | Read workflowKey, exact bindings, inputs, identity/currency/status mapping, per-step expectedRecords, maxPages, pageSize | connect:read, connect:execute |
qualify_workflow | Supported workflowKey, explicit bindings, step inputs, matching mapping | connect:read, connect:execute |
start_workflow_qualification | flowId, expectedRecords, idempotencyKey, correlationId | connect:execute |
get_workflow_qualification | executionId | connect:read |
inspect_workflow_lifecycle | flowId, versionId | connect:read |
preview_workflow_mapping | Selection, reviewed fingerprint, flowStepId, explicit record; optional proposed fields | connect:read |
apply_workflow_action | Selection, reviewed fingerprint, action, confirmed: true; mapping for save_mapping | connect:execute |
inspect_workflow_deployment | flowId, versionId, environmentId; optional exact revisionId | connect:read |
apply_workflow_deployment | Same deployment selection, reviewed fingerprint, action, confirmed: true; optional decision comment | connect:execute |
Native lifecycle actions are compile, publish_sandbox, prepare_repair, save_mapping. Deployment actions are separate: request, approve, reject, activate, rollback. Native member permissions, current state, compiled environment and independent approval requirements apply in addition to transport scopes. Inspect immediately before confirming an action. Stale review requires another inspection; never automatically retry a mutation.
Published MCP tools/list supplies the exact JSON schema for tools granted to your client. describe_capability supplies provider operation inputs, permissions and constraints. SDK declarations provide typed client method arguments. An API product's OpenAPI download describes that product rather than every connector operation.
Approval metadata
meta on REST corresponds to MCP params._meta. Sensitive tool approval requests require "nexra/idempotencyKey"; optional "nexra/correlationId" links evidence. Once another authorised member approves the exact request, submit "nexra/approvalRequestId" with unchanged reviewed arguments. Provider writes retain their own stable argument idempotencyKey and connection write permissions. Tool-level approval does not replace native deployment approval.
Status and evidence
Inspect HTTP errors rather than interpreting an error envelope as data. 401 requires the correct current token; 403 requires current grants/authority. A changed review or write outcome needs inspection and reconciliation. Planned connectors cannot execute. Sample, fixture and whole-workflow evidence have distinct meanings; see Gateway qualification and recovery.