Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rasa Model API

The Model API from Rasa — 6 operation(s) for model.

Rasa Model API is one of 5 APIs that Rasa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Model. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 51 schemas. It is described by OpenAPI 3.0.2, at version 0.0.0.

Requests are made against a single base URL, http://localhost:5055/webhook.

7 operations 6 paths 51 schemas 1 DELETE5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
0.0.0
Base URL
http://localhost:5005
Resource Areas
1

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Model 7
POST
/model/train
Train a Rasa model
trainModel 5 params body → 200204400401403500
POST
/model/test/stories
Evaluate stories
testModelStories 1 param body → 200400401403409500
POST
/model/test/intents
Perform an intent evaluation
testModelIntent 3 params body → 200204400401403409500
POST
/model/predict
Predict an action on a temporary state
predictModelAction 1 param body → 200400401403409500
POST
/model/parse
Parse a message using the Rasa model
parseModelMessage 1 param body → 200400401403500
PUT
/model
Replace the currently loaded model
replaceModel body → 204400401403500
DELETE
/model
Unload the trained model
unloadModel → 204401403

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are YAMLTrainingRequest (14 properties), Tracker (11 properties), EvaluationStoriesResult (7 properties), Error (7 properties). Each schema is shown below with its type and property counts.

FormEvent
SessionStartedEvent
ActionExecutionRejectedEvent
ConversationAccuracyReport
object
4 properties
EntitiesAddedEvent
Error
object
7 properties
SlotEvent
ParseResult
object
NLU parser information. If set, message will not be passed through NLU, but instead this parsing information will be used.
4 properties 1 required
RestartEvent
CancelReminderEvent
Slot
object
Event
FormValidationEvent
TrainingResult
string
Entity
object
Entities within a message
5 properties 4 required
BotEvent
ResponseSelectorTestError
object
Error during response prediction which was made during testing
3 properties
SlotValue
ExportEvent
RasaNLUData
object
1 property
UserEvent
UndoEvent
EvaluationItem
object
Evaluation Result
6 properties
EndpointConfig
object
7 properties
IntentTestError
object
Intent prediction errors which was made during testing
3 properties
ReminderEvent
EntityTestError
object
Entity prediction errors which was made during testing
3 properties
ResetSlotsEvent
EventList
array
EvaluationReport
object
Sklearn classification report, see http://scikit-learn.org/stable/modules/generated/sklearn.metrics.classificationreport.html
NLUEvaluationResult
object
3 properties
EvaluationStoriesResult
object
7 properties
CommonExample
object
3 properties
ActiveLoopEvent
UserFeaturizationEvent
LoopInterruptedEvent
PredictResult
object
3 properties
StoriesTrainingData
string
Rasa Core stories in YAML format
FollowupEvent
PauseEvent
LatestAction
object
Latest bot action.
2 properties
RewindEvent
ActionEvent
ModelRequest
object
3 properties
Tracker
object
Conversation tracker which stores the conversation state.
11 properties
ResumeEvent
YAMLTrainingRequest
object
14 properties
Intent
object
Intent of the text
2 properties 2 required
BasicEvent
object
3 properties 1 required
TemplateDescription
object
1 property 1 required
AgentEvent

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rasa-model-api-openapi.yml Raw ↑

Other APIs Rasa publishes across the network.

Rasa Domain API
Rasa Rasa SDK Action Server Endpoint API
Rasa Server Information API
Rasa Tracker API