Skip to main content

REST API (/v1)

Availability

Cloud & Enterprise · per-endpoint plan tiers noted below

This reference covers the /v1 REST endpoints registered by the ee/* modules. Except for the open-core eval/guard endpoints, these paths are not present in Community — the Community collector imports none of the commercial modules, so they return 404. All requests authenticate with an ingest key (Authorization: Bearer <key>); see API overview.

Plan tiers below refer to Splyntra Cloud; the same feature set is available self-hosted under an Enterprise license. See Plans & pricing.

Governance

Append-only ledger, policy engine, delegation, and the central authorization decision. See Governance overview.

MethodPathPurposePlan
GET/v1/ledgerList activity-ledger entries for the orgTeam+
POST/v1/ledgerAppend an entry to the hash-chained ledgerTeam+
GET/v1/policiesList policy rulesEnterprise
POST/v1/policiesCreate a policy ruleEnterprise
DELETE/v1/policies/{policyID}Delete a policy ruleEnterprise
GET/v1/delegationList agent permissions and delegation stateEnterprise
POST/v1/delegation/permissions/{id}Grant an agent permissionEnterprise
DELETE/v1/delegation/permissions/{id}Revoke an agent permissionEnterprise
GET/v1/spend-limits/{id}Read an agent's spend limitTeam+
POST/v1/spend-limits/{id}Set a daily/monthly USD spend capTeam+
DELETE/v1/spend-limits/{id}Remove a spend limitTeam+
GET/v1/approval-rules/{id}Read an approval ruleEnterprise
POST/v1/approval-rules/{id}Create/update an approval ruleEnterprise
DELETE/v1/approval-rules/{id}Delete an approval ruleEnterprise
GET/v1/approvals/{id}Read a pending approval requestEnterprise
POST/v1/approvals/{requestID}/decideApprove or reject a requestEnterprise
POST/v1/authorizeDecide whether an agent may take an actionTeam+

POST /v1/authorize is the decision endpoint agents call before a consequential action. It evaluates, in order: explicit agent deny → spend limit (fails closed if analytics are unavailable) → policy evaluation (deny-wins) → approval-rule match. It returns {"decision": "allow" | "deny" | "needs_approval"} and writes every outcome to the ledger. Spend-limit checks apply from Team+; policy and approval-rule evaluation require Enterprise. See Delegation & approvals.

Example — POST /v1/authorize

curl -X POST "$SPLYNTRA_ENDPOINT/v1/authorize" \
-H "Authorization: Bearer $SPLYNTRA_API_KEY" \
-H "content-type: application/json" \
-d '{
"action": "payments.refund",
"agent_id": "support_agent",
"context": { "amount": 80 }
}'
{ "decision": "allow" }

Identity

Agent registry, scoped credentials, cross-agent trust, and OIDC federation. All identity endpoints are Enterprise. See Agent identity.

MethodPathPurpose
GET/v1/identity/agentsList registered agents
POST/v1/identity/agentsRegister an agent
DELETE/v1/identity/agents/{agentID}Remove a registered agent
GET/v1/identity/agents/{agentID}/credentialsList an agent's credentials
POST/v1/identity/agents/{agentID}/credentialsIssue a scoped credential (secret shown once)
DELETE/v1/identity/credentials/{credID}Revoke a credential
GET/v1/identity/trustList trust policies
POST/v1/identity/trustCreate a cross-agent trust policy
DELETE/v1/identity/trust/{policyID}Delete a trust policy
POST/v1/identity/authorizeEvaluate cross-agent trust (deny-wins, default deny)
GET/v1/identity/idpList trusted OIDC issuers
POST/v1/identity/idpTrust an OIDC issuer for federation
DELETE/v1/identity/idp/{idpID}Remove a trusted issuer
POST/v1/identity/tokenExchange a federated token for a scoped credential

See Trust policies and Federation.

Compliance

Framework reports and ledger verification. All compliance endpoints are Team+. See Compliance.

MethodPathPurpose
POST/v1/compliance/reportsGenerate a SOC 2 / EU AI Act / NIST AI RMF report
GET/v1/compliance/reportsList generated reports
GET/v1/compliance/reports/{id}?format=csvFetch a report (JSON or CSV)
POST/v1/compliance/verify-ledgerVerify the ledger hash chain
POST/v1/compliance/policies/dry-runPreview what the live policy set would decide

Eval & guard

The scoring and guard endpoints are open core — present in every edition.

MethodPathPurposePlan
POST/v1/scorersRun a scorer against resultsOpen core
POST/v1/guardPre-flight injection check for an inline guardOpen core

The built-in scorers ship in the core; the llm_as_judge scorer is a commercial add-on registered by ee/scorers-pro (Enterprise). See Scorers and Guardrails.