ARKEN

ARKEN Conflict Resolution API

Public developer resources for ARKEN negotiation catalog search and unsaved case drafts.

REST API

Official agent integrations

SDK availability and quickstarts

ARKEN provides an official CLI and JavaScript and Python SDKs as versioned downloads, plus a published Go module. Registry publication is pending for npm and PyPI. See ARKEN SDKs and CLI for installation, examples, checksums, and release status. Use HTTP directly or an MCP client if preferred. These read-only examples search the public catalog without credentials, creating a case, sending mail, or running a model.

TypeScript

Run server-side with a runtime that provides fetch and AbortSignal.timeout.

const url = new URL("https://usearken.com/api/v1/deal-types");
url.searchParams.set("q", "breakup");
const response = await fetch(url, { signal: AbortSignal.timeout(10000) });
if (!response.ok) throw new Error("Catalog request failed: " + response.status);
const catalog = await response.json();
console.log(catalog.data);

Python

Uses only the standard library.

import json
from urllib.parse import urlencode
from urllib.request import urlopen

url = "https://usearken.com/api/v1/deal-types?" + urlencode({"q": "breakup"})
with urlopen(url, timeout=10) as response:
    catalog = json.load(response)
print(catalog["data"])

Public REST rate limits

Public REST requests use two shared, per-instance fixed windows of one minute: 600 reads per minute across API discovery, catalog, health, OpenAPI, and HTML API documentation; and 60 writes per minute for POST /api/v1/case-drafts. These quotas are shared across callers, not allocated per user or API key.

Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. Reset is the window reset time in Unix epoch seconds. Exhausted quotas return HTTP 429 with the structured API error code RATE_LIMITED and Retry-After in seconds. Wait for that delay before retrying; preserve the same Idempotency-Key when retrying a draft request.

Auth and agent endpoints are excluded from these public REST quotas. Pilot access request endpoints have a separate limiter.

Catalog identity and verification

All ARD catalog entries carry a trust manifest binding their identifier, URL, media type, and resource SHA-256 digest. The production publisher signs these claims using ES256 and publishes its public key in the DID document. See verification instructions.

MCP integration

Connect a Streamable HTTP client to https://usearken.com/mcp. The public tools search deal types, inspect a category, and prepare a draft for review.

Authentication and retries

No API key or OAuth token is required for public tools. Private case storage, uploads, and model analysis are not exposed by this public API.

ARKEN authentication documentation describes access boundaries. The agent email API requires scoped ARKEN credentials and explicit reply approval. Draft requests accept Idempotency-Key; keys last 24 hours, and a conflicting request returns 409. See the API reference for limits and errors.

Versioning and deprecation policy explains major paths and how future retirement dates will be announced.

Sign in. New users can create a private workspace with Google sign-in; model analysis requires prepaid credits and inbox access remains separate.

Coverage and evidence

Deal coverage and methodology describes the public inventory. A draft is not a saved case, completed negotiation, or validated advice.