Rudder Example Rudder API
53
AI ReadinessFoundational (C-)53/100
Identity AuthAuthenticationapiKey167 EndpointsREST
For Agents
Programmatically list all change requests, get a zip archive of the requested items and their dependencies. Covers 167 operations with apiKey authentication.
Use for: I need to all change requests, I want to a zip archive of the requested items and their dependencies, Search for import a zip archive of policies into rudder, Find all web interface customization
Not supported: Does not handle payments, communications, or crm - use for identity and authentication only.
Download OpenAPI specification: [openapi.yml](openapi.yml) **Other documentation sources**: * [Main documentation](https://docs.rudder.io) * [Internal relay API](https://docs.rudder.io/api/relay/) Introduction Rudder exposes a REST API, enabling the user to interact with Rudder without using the webapp, for example, in scripts or cron jobs. Authentication The Rudder REST API uses simple API keys f. The API exposes 167 endpoints secured with apiKey authentication.
Install Jentic One Beta
Connect the Rudder API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Rudder API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Frudder.example.local%2Frudder-example-local" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Frudder.example.local%2Frudder-example-local" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Rudder API.
List all change requests
Get a ZIP archive of the requested items and their dependencies
Import a ZIP archive of policies into Rudder
Update web interface customization
Reload branding file
Save a campaign
Use Cases
Patterns agents use Rudder API for, with concrete tasks.
★ Identity and Authentication Operations
Use the Rudder API to perform identity auth operations programmatically. The API provides 167 endpoints covering core functionality including list all change requests, get a zip archive of the requested items and their dependencies, import a zip archive of policies into rudder.
Call GET /api/changeRequests to list all change requests
Automated API Info Management
Automate API info operations by combining multiple Rudder API endpoints. Agents can get a zip archive of the requested items and their dependencies and then import a zip archive of policies into rudder in a single workflow.
Call GET /archives/export to get a zip archive of the requested items and their dependencies, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Rudder API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.
Search Jentic for 'list all change requests', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
167 endpoints — download openapi specification: [openapi.
METHOD
PATH
DESCRIPTION
GET
/api/changeRequests
List all change requests
GET
/archives/export
Get a ZIP archive of the requested items and their dependencies
POST
/archives/import
Import a ZIP archive of policies into Rudder
POST
/branding
Update web interface customization
GET
/branding
Get branding configuration
POST
/branding/reload
Reload branding file
POST
/campaigns
Save a campaign
GET
/campaigns
Get all campaigns details
GET
/api/changeRequests
List all change requests
GET
/archives/export
Get a ZIP archive of the requested items and their dependencies
POST
/archives/import
Import a ZIP archive of policies into Rudder
POST
/branding
Update web interface customization
GET
/branding
Get branding configuration
POST
/branding/reload
Reload branding file
POST
/campaigns
Save a campaign
GET
/campaigns
Get all campaigns details
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
R
Rudder API
- Foundational (C-)53/100
50
Foundational Compliance63
Developer Experience & Jentic Compatibility45
AI-Readiness & Agent Experience59
Agent Usability50
Security59
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
50
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: D+Signals: 4
91%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
7%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
32%
Example Density
How richly the API is illustrated with examples.
96%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
45
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
52%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
88%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
40%
Summary Coverage
Coverage of summaries across operations/tags/info.
59
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: C+Signals: 1
59%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
59
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: C+Signals: 1
59%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Rudder API by hand means passing your key in the X-API-Token header and resolving the {rudderServer} host in the /rudder/api/latest base yourself for each request. Through Jentic you install once, import the Rudder API from the API Directory, store the token once, and your agent calls it.
Permission scoping
Rudder puts resource ids in the URL path (for example a change request or an archive item), so a rule can pin your agent to specific resources: it can read change requests and export archives and nothing else. You choose the operations it may call, so importing a policy archive or updating branding is not included unless you add them.
Credential isolation
Your Rudder API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list change requests' or 'export items as a ZIP archive', and Jentic returns the matching Rudder operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Rudder API through Jentic.
What authentication does the Rudder API use?
The Rudder API uses an API key passed in the `X-API-Token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I list all change requests with the Rudder API?
Yes. Use the GET /api/changeRequests endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Rudder API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I list all change requests through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list all change requests'. Jentic returns the matching Rudder API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Rudder API have?
The Rudder API exposes 167 endpoints covering API info, status, compliance operations.
Can I limit what my agent is allowed to do with the Rudder API?
Yes. Jentic One is self-hosted, so you set the rules that decide which Rudder operations and credentials your agent may use. Because Rudder puts resource ids in the URL path, such as a change request or an archive item, you can pin the agent to specific resources and let it read change requests and export archives while nothing else is permitted. Operations like importing a policy archive or updating branding stay off limits unless you explicitly add them.
GET STARTED