Skip to content

API Overview

The CertusOrdo REST API provides programmatic access to all platform features.

Base URL

https://web-production-b910f.up.railway.app

Interactive Documentation

Explore the API interactively:

Authentication

The API uses two authentication methods:

API Key (Organization Level)

For administrative operations (creating agents, managing org):

curl -H "X-API-Key: aa_your_api_key" \
  https://web-production-b910f.up.railway.app/v1/agents

JWT Token (Agent Level)

For agent operations (transactions, sessions):

curl -H "Authorization: Bearer eyJhbG..." \
  https://web-production-b910f.up.railway.app/v1/transactions

Response Format

All responses are JSON:

{
  "id": "uuid",
  "created_at": "2025-01-16T14:30:00Z",
  ...
}

Error Responses

{
  "detail": "Error message",
  "code": "ERROR_CODE"
}
Status Code Meaning
400 Bad Request - Invalid input
401 Unauthorized - Missing/invalid auth
403 Forbidden - Insufficient permissions
404 Not Found - Resource doesn't exist
429 Rate Limited - Too many requests
500 Server Error - Something went wrong

Endpoints Summary

Organizations

Method Endpoint Description
POST /v1/organizations Create organization
GET /v1/organizations List organizations
GET /v1/organizations/{id} Get organization

Agents

Method Endpoint Description
POST /v1/agents Create agent
GET /v1/agents List agents
GET /v1/agents/{id} Get agent
DELETE /v1/agents/{id} Revoke agent

Authentication

Method Endpoint Description
POST /v1/auth/token Get JWT tokens
POST /v1/auth/refresh Refresh access token
POST /v1/auth/revoke Revoke refresh token

Sessions

Method Endpoint Description
POST /sessions Create session
GET /sessions List sessions
GET /sessions/{id} Get session
POST /sessions/{id}/end End session

Transactions

Method Endpoint Description
POST /transactions/begin Begin transaction
POST /transactions/{id}/commit Commit transaction
POST /transactions/{id}/rollback Rollback transaction
GET /transactions List transactions
GET /transactions/{id} Get transaction

Audit

Method Endpoint Description
GET /audit List audit entries
GET /audit/verify Verify chain integrity

Health

Method Endpoint Description
GET /health Health check

Rate Limits

Plan Requests/minute
Starter 100
Growth 1,000
Enterprise 10,000+

Rate limit headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1705420800

Pagination

List endpoints support pagination:

GET /v1/agents?limit=20&offset=0

Response includes pagination info:

{
  "data": [...],
  "total": 150,
  "limit": 20,
  "offset": 0
}

SDKs

Official SDKs handle authentication, pagination, and errors:

  • Python: pip install certusrodo
  • TypeScript: Coming soon
  • Go: Coming soon

Next Steps

Explore each endpoint: