Interaction Model Management v0

Note: Sign in to the developer console to build or publish your skill.

Warning: You are viewing the SMAPI v0 API documentation. The current version of SMAPI is Version 1. Switch to v1 to view the latest documentation.

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 /v0/skills/{skillId}/interactionModel/locales/{locale}

Parameter Description

Field	Description	Parameter Type	Required?
skillId	Unique identifier of skill.	Path	Yes
locale	Locale of interaction model being retrieved, such as "en-GB", "en-US", "en-IN", "en-CA", or "de-DE".	Path	Yes

Return Type

InteractionModel

Example data

{
  "languageModel": {
    "invocationName": "string",
    "types": [
      {
        "name": "string",
        "values": [
          "string"
        ]
      }
    ],
    "intents": [
      {
        "name": "string",
        "slots": [
          {
            "name": "string",
            "type": "string",
            "samples": [
              "string"
            ]
          }
        ],
        "samples": [
          "string"
        ]
      }
    ]
  },
  "dialog": {
    "intents": [
      {
        "name": "string",
        "slots": [
          {
            "name": "string",
            "prompts": {
              "elicitation": "string",
              "confirmation": "string"
            },
            "validations": [
              {
                "type": "string",
                "prompt": "string"
              }
            ]
          }
        ]
      }
    ]
  },
  "prompts": [
    {
      "id": "string",
      "variations": [
        {
          "type": "SSML",
          "value": "string"
        }
      ]
    }
  ]
}

Response

HTTP/1.1 200 OK

HTTP/1.1 401 Unauthorized

HTTP/1.1 404

The specified skill doesn't exist or there is no model defined for the locale

Update Interaction Model

Important: The update interaction model operation is available but no longer supported. To replace it, you should use Skill Package Management REST APIs.

Use to update the interaction model for a specified skill.

Request

POST /v0/skills/{skillId}/interactionModel/locales/{locale}

Creates an InteractionModel for the skill.

Parameter Description

Field	Description	Parameter Type	Required?
skillId	Unique identifier of skill.	Path	Yes
locale	Locale of interaction model being retrieved.	Path	Yes

Request Body

Field	Description	Parameter Type	Required?
interactionModel	Name of interaction model	String	Yes

Response

HTTP/1.1 200 OK

Returns build status location link on success.

HTTP/1.1 401 Unauthorized

HTTP/1.1 400 Bad Request

HTTP/1.1 404 Not Found

HTTP/1.1 409 Conflict

The request could not be processed because of conflict. For example, the specified ETag did not match the current ETag in the store, or another build is in progress.

HTTP/1.1 413 Payload Too Large

The payload exceeded the size limit allowed.

Get the Interaction Model Building Status

Important: The get the interaction model building status operation is available but no longer supported. To replace it, you should use Skill Package Management REST APIs.

Request

GET /v0/skills/{skillId}/interactionModel/locales/{locale}/status

Parameter Description

Field	Description	Parameter Type	Required?
skillId	Unique identifier of skill.	Path	Yes
locale	Locale of interaction model being retrieved.	Path	Yes

Return type

BuildStatus

Example data

Content-Type: application/json
{ }

Responses

HTTP/1.1 200 OK

{
    "status": "SUCCESS"
}

Other possible status values are FAILURE and IN_PROGRESS.

HTTP/1.1 401 Unauthorized

HTTP/1.1 404 Not Found

The specified skill does not exist, or there is no model defined for the locale.

Was this page helpful?

Provide feedback

Last updated: Aug 07, 2023