Skip to content

API Reference

For trace uploads, see Accepted trace schemas, including required fields, examples, and file limits.

For agent assessment workers, see Agent twin request contract 1.7, including customer_tier, queue claims, and reassessment behavior.

All endpoints require an X-API-Key header. Base URL: https://app.carveragents.ai

X-API-Key: your-api-key-here

Workflow obligations

Submit multiple step descriptions asynchronously, poll the entire assessment, read per-step obligations, and revise a Workflow using the Workflow integration guide and API reference.

Categories

Method Endpoint Description
GET /api/v1/feeds/categories List all regulatory categories, with optional filters for name and active status
GET /api/v1/feeds/categories/{category_id} Get a single category by ID
GET /api/v1/feeds/categories/{category_id}/topics List all topics belonging to a category

Topics

Method Endpoint Description
GET /api/v1/feeds/topics List all topics, optionally filtered by category_id; pass details=true for extended fields
GET /api/v1/feeds/topics/{topic_id} Get a single topic by ID
GET /api/v1/feeds/topics/{topic_id}/entries List entries for a topic, paginated via limit and offset
GET /api/v1/feeds/topics/{topic_id}/summary Get an AI-generated summary of recent activity for a topic

Entries

Method Endpoint Description
GET /api/v1/feeds/entries/list List entries across all feeds, filterable by feed and active status
GET /api/v1/feeds/entries/detail List entries with enriched detail, filterable by topic, status, search, and date
GET /api/v1/feeds/entries/{entry_id} Get a single entry by ID

Stats

Method Endpoint Description
GET /api/v1/feeds/stats/overview High-level platform stats: total feeds, topics, and entries
GET /api/v1/feeds/stats/topics Stats broken down by topic, paginated
GET /api/v1/feeds/stats/topics/{topic_id} Detailed stats for a single topic