Agent-ready OpenAPI document · curated by JenticDeveloper ToolsMonitoring ObservabilityapiKey30 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Ingest application trace data and query service maps, traces, and insights so an agent can investigate latency and errors across distributed AWS services.
Use for: I need to find slow traces in my service in the last 30 minutes, Get the service map for my production environment, Look up a specific trace by its trace ID, List X-Ray insights about anomalies in service health
Not supported: Does not handle metric collection, log aggregation, or alerting - use for ingesting trace segments, querying traces and service maps, and managing sampling rules and groups only.
Jentic publishes the only available OpenAPI specification for AWS X-Ray, keeping it validated and agent-ready. AWS X-Ray collects distributed traces from applications running on EC2, ECS, EKS, Lambda, and API Gateway, then surfaces the request path through every downstream service as a service map and per-trace timeline. The API ingests trace segments and telemetry, queries traces by ID or filter expression, returns service graphs and time-series statistics, and manages sampling rules, groups, and resource policies. The 30 operations span PutTraceSegments / PutTelemetryRecords for ingestion, BatchGetTraces and GetTraceSummaries for query, GetServiceGraph and GetInsight for analysis, and full CRUD on groups and sampling rules.
Install Jentic One Beta
Connect the AWS X-Ray to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AWS X-Ray, 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%2Famazonaws.com%2Fxray" | 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%2Famazonaws.com%2Fxray" | 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 AWS X-Ray API.
Ingest application trace segments via PutTraceSegments and telemetry via PutTelemetryRecords
Search traces by filter expression and time range with GetTraceSummaries
Retrieve full traces (with sub-segments) via BatchGetTraces
Render the service map and trace graph for visualisation with GetServiceGraph and GetTraceGraph
Manage sampling rules to control trace volume and cost
Define groups with filter expressions for scoped views and per-team dashboards
Read X-Ray Insights for automatic anomaly detection on faults and latency
Use Cases
Patterns agents use AWS X-Ray API for, with concrete tasks.
★ Latency Investigation Across Microservices
When p99 latency spikes, use GetTraceSummaries with a filter expression like 'service("checkout") AND responsetime > 2' over the relevant time window to find the offending traces, then BatchGetTraces with the returned TraceIds to inspect sub-segments and pinpoint the slow downstream call. GetServiceGraph in parallel surfaces which service-to-service edge is degraded.
Call GetTraceSummaries with FilterExpression 'service("checkout") AND responsetime > 2', StartTime 30 minutes ago, EndTime now, and TimeRangeType 'TraceId', then BatchGetTraces with the first 5 returned TraceIds.
Cost-Aware Trace Sampling
Reduce X-Ray spend by raising sampling rates only for important paths. CreateSamplingRule defines rules that match by ServiceName, ServiceType, Host, HTTPMethod, URLPath, and ResourceARN, with a Reservoir (fixed traces per second) and a FixedRate (proportion of remaining traffic). UpdateSamplingRule adjusts the rule live without code changes; GetSamplingRules lists all active rules.
Call CreateSamplingRule with RuleName 'checkout-high', Priority 100, ReservoirSize 5, FixedRate 0.2, ServiceName 'checkout', URLPath '/checkout', and HTTPMethod 'POST'.
Service Health Insights
X-Ray Insights automatically detects anomalies in service-level error rates and latency. ListInsightSummaries enumerates open insights; GetInsight returns the root-cause analysis; GetInsightImpactGraph shows the user-impact graph; GetInsightEvents returns the time series of impact. Together they produce a richer signal than raw metrics for SRE on-call review.
Call ListInsightSummaries with States ['ACTIVE'], then for each InsightId call GetInsight and GetInsightImpactGraph and return the affected services.
Agent-Driven Trace Triage via Jentic
An on-call agent investigating a paged alert can query X-Ray through Jentic without holding AWS keys. The agent submits an intent like 'find slow traces in the last 30 minutes for the checkout service'; Jentic loads GetTraceSummaries, executes it with a filter expression, and returns the offending TraceIds; the agent then calls BatchGetTraces for the timeline detail. The agent context never sees a SecretAccessKey.
Through Jentic, search for 'find slow traces in aws xray', load GetTraceSummaries, and execute with FilterExpression and TimeRange.
Key Endpoints
30 endpoints — jentic publishes the only available openapi specification for aws x-ray, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/Traces
Batch get traces by trace ID
POST
/TraceSummaries
Search traces by filter expression
POST
/ServiceGraph
Get the service map graph
POST
/TraceSegments
Submit trace segment documents
POST
/CreateSamplingRule
Create a sampling rule
POST
/InsightSummaries
List insight summaries
POST
/Traces
Batch get traces by trace ID
POST
/TraceSummaries
Search traces by filter expression
POST
/ServiceGraph
Get the service map graph
POST
/TraceSegments
Submit trace segment documents
POST
/CreateSamplingRule
Create a sampling rule
POST
/InsightSummaries
List insight summaries
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.
A
AWS X-Ray
- AI-Aware (B-)61/100
99
Foundational Compliance63
Developer Experience & Jentic Compatibility37
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
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: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
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.
37
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
49%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
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).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
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 AWS X-Ray by hand means computing SigV4 signatures against the us-east-1 xray endpoint and batching trace segments correctly yourself. Through Jentic you install once, import X-Ray from the API Directory, store the access keys once, and your agent calls it.
Permission scoping
X-Ray identifies traces and rules through the request body rather than resource ids in the path, so scope the agent to the operations it needs, such as TraceSummaries and ServiceGraph. You choose the operations it may call, so CreateSamplingRule or segment ingestion are not included unless you add them.
Credential isolation
Your AWS access keys are stored once, encrypted, by your own Jentic One instance and used to sign each X-Ray request with SigV4 at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'find slow traces' or 'get the service map', and Jentic returns the matching X-Ray 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 AWS X-Ray API through Jentic.
Why is there no official OpenAPI spec for AWS X-Ray?
AWS does not publish an OpenAPI specification for AWS X-Ray; it ships Smithy models and language-specific SDKs instead. Jentic generates and maintains this OpenAPI spec so that AI agents and developers can call AWS X-Ray via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does AWS X-Ray use?
X-Ray uses AWS SigV4 in the Authorization header. The IAM principal needs xray:PutTraceSegments and xray:PutTelemetryRecords for ingestion and xray:Get* / xray:BatchGet* for query. Through Jentic, your AWS keys are vaulted and Jentic signs each request.
Can I search traces by HTTP status code or service name?
Yes. GetTraceSummaries accepts a FilterExpression in X-Ray's filter syntax: clauses like 'service("checkout")', 'http.status >= 500', and 'responsetime > 2' can be combined with AND/OR. The TimeRangeType selector controls whether you query by trace start time or by event time.
What are the rate limits for AWS X-Ray?
PutTraceSegments has a default ingestion rate of around 250,000 segments per second per account but is metered per trace; query APIs (GetTraceSummaries, BatchGetTraces) have lower per-second quotas. Sampling rules are the primary cost lever - fewer sampled traces means fewer ingestion charges.
How do I find slow traces through Jentic?
Search Jentic with 'find slow traces in aws xray', load GetTraceSummaries, and execute with FilterExpression 'responsetime > 2', StartTime, and EndTime. Jentic returns TraceSummaries; pass the TraceIds into BatchGetTraces for full timelines.
Can I control how many traces X-Ray records?
Yes. Sampling rules combine a Reservoir (fixed traces per second) with a FixedRate (fraction of remaining matching requests). CreateSamplingRule, UpdateSamplingRule, and DeleteSamplingRule manage them; GetSamplingTargets returns the live targets for instrumented clients.
Does X-Ray work with Lambda and API Gateway out of the box?
Yes. Lambda and API Gateway can emit X-Ray segments when active tracing is enabled in their configuration; this API is then used to query the resulting traces and service map. Custom applications use the X-Ray daemon or OpenTelemetry to emit segments via PutTraceSegments.
Can I limit what my agent is allowed to do with the AWS X-Ray API?
Yes. Because you run Jentic One yourself, your own rules decide which X-Ray operations and which stored AWS credentials the agent may use. Since X-Ray identifies traces and rules through the request body rather than resource IDs in the path, you scope by operation: grant read-only calls like GetTraceSummaries, BatchGetTraces, and GetServiceGraph for investigation while leaving out write paths such as CreateSamplingRule and PutTraceSegments unless you explicitly add them. Nothing the agent can call is available until you include it in that operation list.
GET STARTED