Interaction Model Operations (Skill Management API)
- Get Interaction Model
- Head Interaction Model
- Update Interaction Model
- Get the Interaction Model Building Status
This document describes all API operations related to the interaction model resource. Each request must have an Authorization header whose value should be the access token retrieved from Login with Amazon.
Get Interaction Model
Get an interaction model for a specified skill.
Request
GET /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}
Parameters
| Field | Description | Parameter Type | Required? |
|---|---|---|---|
| skillId | Unique identifier of skill. | Path | Yes |
| stage | Stage of the skill. Accepted values are DEVELOPMENT, LIVE. |
Path | Yes |
| locale | Locale of interaction model being retrieved, such as “en-GB”, “en-US”, “en-IN”, “en-CA”, “de-DE”, or “ja-JP”. | Path | Yes |
Response
Headers
ETag: <etag_value>
Body
Interaction model object.
HTTP/1.1 200 OK
Exceptions
HTTP/1.1 400 Bad Request
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
HTTP/1.1 404 Not Found
HTTP/1.1 429 Too Many Requests
HTTP/1.1 500 Internal Server Error
HTTP/1.1 503 Service Unavailable
Head Interaction Model
Checks whether an interaction model exists for a specified skill.
Request
HEAD /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}
Parameters
| Field | Description | Parameter Type | Required? |
|---|---|---|---|
| skillId | Unique identifier of skill. | Path | Yes |
| stage | Stage of the skill. Accepted values are DEVELOPMENT, LIVE. |
Path | Yes |
| locale | Locale of interaction model being retrieved. | Path | Yes |
Response
HTTP/1.1 204 NoContent
Headers
ETag: {eTag}
Exceptions
HTTP/1.1 400 Bad Request
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
HTTP/1.1 404 Not Found
HTTP/1.1 429 Too Many Requests
HTTP/1.1 500 Internal Server Error
HTTP/1.1 503 Service Unavailable
Update Interaction Model
Use to update the interaction model for a specified skill.
Request
PUT /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}
Creates an InteractionModel for the skill.
Parameters
| Field | Description | Parameter Type | Required? |
|---|---|---|---|
| skillId | Unique identifier of skill. | Path | Yes |
| stage | Stage of the skill. Accepted value is DEVELOPMENT. |
Path | Yes |
| locale | Locale of interaction model being retrieved. | Path | Yes |
Headers
If-Match: <etag_value>
Body
interactionModel object as described here.
Response
HTTP/1.1 202 Accepted
Returns build status location link on success.
Headers
ETag: <etag>
Location: <Returns a relative URL to track the status>
Exceptions
HTTP/1.1 400 Bad Request
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
HTTP/1.1 404 Not Found
HTTP/1.1 412 Precondition Failed
HTTP/1.1 429 Too Many Requests
HTTP/1.1 500 Internal Server Error
HTTP/1.1 503 Service Unavailable
Get the Interaction Model Building Status
Use Get Skill Status to get the interaction model’s building status.