How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Ansible Lightspeed with IBM watsonx Code Assistant API

REST API for Ansible Lightspeed, the generative AI service that produces and explains Ansible content. Provides playbook and role generation, content explanations, chat and streaming chat, content-match attribution against training data, feedback capture and watsonx Code Assistant model/key configuration.

Red Hat Ansible Lightspeed with IBM watsonx Code Assistant API is one of 7 APIs that Red Hat Ansible Automation Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Artificial Intelligence, Code Assistant, Lightspeed, and REST. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 23 operations across 19 paths, organized into 5 resource areas, and defines 39 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0 (v1).

Requests are made against 2 base URLs: https://lightspeed-instance/api/v1, https://aap/api/lightspeed/v1.

23 operations 19 paths 39 schemas 1 DELETE10 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0 (v1)
Base URL
https://lightspeed-instance/api/v1
Authentication
API Key, OAuth 2.0
Resource Areas
5

Authentication & Security 2

Red Hat Ansible Lightspeed with IBM watsonx Code Assistant API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 23

Across 19 paths, the API surfaces 23 operations — 1 DELETE, 10 GET, 12 POST. They span 5 resource areas: ai, health, me, telemetry, wca. Each is listed below with its method, path, parameters, and response codes.

ai 9

AI-related operations

POST
/ai/chat/
Chat request
ai_chat_create body → 200400403413422500503
POST
/ai/completions/
Inline code suggestions
ai_completions_create body → 200204400401429503
POST
/ai/contentmatches/
Code suggestion attributions
ai_contentmatches_create body → 200400401429503
POST
/ai/explanations/
Playbook explanation
ai_explanations_create body → 200204400401429503
POST
/ai/explanations/role/
Role explanation
ai_explanations_role_create body → 200204400401429503
POST
/ai/feedback/
Feedback API for the AI service
ai_feedback_create body → 200400401
POST
/ai/generations/playbook/
Playbook generation
ai_generations_playbook_create body → 200204400401429503
POST
/ai/generations/role/
Role generation
ai_generations_role_create body → 200401
POST
/ai/streaming_chat/
Streaming chat request
ai_streaming_chat_create body → 200400403413422500503
health 3
GET
/health/
Liveness probe
health_retrieve → 200
GET
/health/status/
Health check with backend server status
health_status_retrieve → 200500
GET
/health/status/chatbot/
Chatbot health check
health_status_chatbot_retrieve → 200
me 2

Authenticated user information

GET
/me/
me_retrieve → 200
GET
/me/summary/
me_summary_retrieve → 200
telemetry 2
GET
/telemetry/
Get the telemetry settings for an Organisation
telemetry_settings_get → 200400401403429500501
POST
/telemetry/
Set the Telemetry settings for an Organisation
telemetry_settings_set body → 204400401403429500501
wca 7

watsonx Code Assistant

GET
/wca/apikey/
Get WCA key for an Organisation
wca_api_key_get → 200400401403429500501
POST
/wca/apikey/
Set the WCA key for an Organisation
wca_api_key_set body → 204400401403429500501
DELETE
/wca/apikey/
DELETE WCA key for an Organization
wca_api_key_delete → 204400401403429500501
GET
/wca/apikey/test/
Validate WCA key for an Organisation
wca_api_key_validator_get → 200400401403429500501
GET
/wca/modelid/
Get WCA Model Id for an Organisation
wca_model_id_get → 200400401403429500501
POST
/wca/modelid/
Set the Model Id to be used for an Organisation
wca_model_id_set body → 204400401403429500501
GET
/wca/modelid/test/
Validate WCA Model Id for an Organisation
wca_model_id_validator_get → 200400401403429500501

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are UserResponse (12 properties), FeedbackRequest (12 properties), GenerationRoleRequest (10 properties), GenerationPlaybookRequest (8 properties). Each schema is shown below with its type and property counts.

ChatFeedback
object
3 properties 3 required
ChatRequest
object
5 properties 1 required
ChatResponse
object
4 properties 3 required
CompletionMetadata
object
5 properties
CompletionRequest
object
5 properties 1 required
CompletionResponse
object
3 properties 1 required
ContentMatch
object
6 properties 6 required
ContentMatchList
object
1 property 1 required
ContentMatchRequest
object
5 properties 1 required
ContentMatchResponse
object
1 property 1 required
ExplanationRequest
object
6 properties 1 required
ExplanationResponse
object
3 properties 2 required
ExplanationRoleRequest
object
6 properties 2 required
FeedbackRequest
object
12 properties
GenerationPlaybookRequest
object
8 properties 1 required
GenerationPlaybookResponse
object
5 properties 3 required
GenerationRoleFileEntry
object
3 properties 3 required
GenerationRoleRequest
object
10 properties 1 required
GenerationRoleResponse
object
5 properties 3 required
GenerationWarningResponse
object
3 properties 2 required
InlineSuggestionFeedback
object
5 properties 2 required
IssueFeedback
object
3 properties 3 required
MarkdownUserResponse
object
1 property 1 required
Metadata
object
1 property
Organization
object
4 properties 4 required
Plan
object
2 properties 2 required
PlaybookExplanationFeedback
object
2 properties 2 required
PlaybookGenerationAction
object
4 properties 2 required
PlaybookGenerationFeedback
object
2 properties 2 required
ReferencedDocuments
object
2 properties 2 required
RoleGenerationAction
object
4 properties 2 required
SentimentFeedback
object
2 properties 2 required
StreamingChatRequest
object
6 properties 1 required
SuggestionQualityFeedback
object
4 properties 3 required
TelemetrySettingsRequest
object
1 property 1 required
UserPlan
object
4 properties 2 required
UserResponse
object
12 properties 5 required
WcaKeyRequest
object
1 property 1 required
WcaModelIdRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-ansible-lightspeed-openapi.json Raw ↑

Other APIs Red Hat Ansible Automation Platform publishes across the network.

Red Hat Ansible Automation Controller API
Red Hat Ansible Private Automation Hub API
Red Hat Event-Driven Ansible Controller API
Red Hat Automation Services Catalog API
Red Hat Ansible Automation Platform Gateway API
Red Hat Automation Hub API (Hybrid Cloud Console)
Where this information came from

This is an independent, third-party profile of Red Hat Ansible Lightspeed with IBM watsonx Code Assistant API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.