Knowledge Skill SMAPI Operations
You can create and update knowledge skills programmatically by using the Alexa Skill Management API (SMAPI).
For a walkthrough of how to use SMAPI to create a simple knowledge skill, see Get started.
- Endpoint
- Import data
- Get the status of all imports
- Get the status of a specific import
- Get template IDs
- Related topics
Endpoint
The endpoint for SMAPI is https://api.amazonalexa.com.
Each API request must have an Authorization header that contains an access token retrieved from Login with Amazon. For details about obtaining an access token, see Get an Access Token for SMAPI.
Import data
Adds the selected template to your knowledge skill (if it isn't already added) and imports new data to the template. The imported data overwrites all data current associated with the template. For details about templates and how to format your data, see Knowledge Skill Templates.
Request
HTTP method and URI path
POST /v1/skills/{skillId}/knowledge/imports
Request body structure
{
"contentType": string,
"template": {
"id": string
}
"importContent":string
}
Request parameters
| Field | Description | Type | Required | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
The ID of your knowledge skill. |
String |
Yes |
||||||||||||||||||||||||||||
|
|
MIME type of the content that is being imported into this knowledge skill. The only supported MIME type is |
String |
Yes |
||||||||||||||||||||||||||||
|
|
ID of the knowledge skill template that the data uses. The following table shows the ID that corresponds to each knowledge skill template.
|
String |
Yes |
||||||||||||||||||||||||||||
|
|
The text of the CSV file you want to import, as a string. |
String |
Yes |
Response
A successful request returns 202 Success. The Location header contains a string you can use to track the import.
Errors
| Code | Description |
|---|---|
|
400 |
Bad request. Returned when a required parameter isn't present, or is badly formatted. |
|
401 |
The authorization token is invalid/expired or doesn't have access to the resource. To obtain a new access token, use a refresh token. For details, see Get an Access Token for SMAPI. |
|
403 |
Request is forbidden. |
|
404 |
The resource being requested isn't found. |
|
409 |
The request couldn't be completed due to a conflict with the current state of the target resource. |
|
429 |
Too many requests received. |
|
500 |
Internal server error. |
|
503 |
Service unavailable. |
Get the status of all imports
Gets the status and percentage completion of all active and completed imports for a knowledge skill. The results are returned as an optionally paginated list of import IDs. You can also apply filters to the imports returned by your request.
Request
HTTP method and URI path
GET /v1/skills/{skillId}/knowledge/imports?nextToken={nextToken}&maxResults={maxResults}&status={status}
Request parameters
| Field | Description | Type | Required |
|---|---|---|---|
|
|
The ID of your knowledge skill. |
String |
Yes |
|
|
Token that you can use in the next request as the continuation token to list the next page of results. |
String |
No |
|
|
Total number of results that matched the request query. |
Integer |
No |
|
|
Status of the knowledge skill import request. |
String |
No |
Response
A successful request returns 200 Success.
Response body structure
{
"knowledgeImports": [
{
"errors": [string, string,...],
"id": string,
"status": string enum
},
...
],
"paginationContext": {
"nextToken": string,
"previousToken": string,
"totalCount": integer
}
}
Response body fields
| Field | Description | Type |
|---|---|---|
|
|
Total number of results that matched the request query. |
Integer |
|
|
A value that you can use in the next request as the continuation token to list the next page of results. |
String |
|
|
A value that you can use in the next request as the token to list the previous set of results. |
String |
|
|
Unique identifier for the import. |
String |
|
|
The status of the import. |
String |
|
|
List of import error messages, which explain the changes you need to make to your file to be able to import it. |
Array of strings |
Errors
| Code | Description |
|---|---|
|
400 |
Bad request. Returned when a required parameter isn't present, or is badly formatted. |
|
401 |
The authorization token is invalid/expired or doesn't have access to the resource. To obtain a new access token, use a refresh token. For details, see Get an Access Token for SMAPI. |
|
403 |
Request is forbidden. |
|
404 |
The resource being requested isn't found. |
|
429 |
Too many requests received. |
|
500 |
Internal server error. |
|
503 |
Service unavailable. |
Get the status of a specific import
Gets the status and percentage completion of a specific import.
Request
HTTP method and URI path
GET /v1/skills/{skillId}/knowledge/imports/{importId}
Request parameters
| Field | Description | Type | Required |
|---|---|---|---|
|
|
The ID of your knowledge skill. |
String |
Yes |
|
|
The ID of the import for which to get the status. |
String |
Yes |
Response
A successful request returns 200 Success.
Response body structure
{
"knowledgeImport": {
"errors": [string, string,...],
"progress": integer,
"status": string enum
}
}
Response body fields
| Field | Description | Type |
|---|---|---|
|
|
The status of the import. |
String |
|
|
List of import error messages, which explain the changes you need to make to your file to be able to import it. |
Array of strings |
|
|
The percentage completion of the import. |
Integer |
Errors
| Code | Description |
|---|---|
|
400 |
Bad request. Returned when a required parameter isn't present, or is badly formatted. |
|
401 |
The authorization token is invalid/expired or doesn't have access to the resource. To obtain a new access token, use a refresh token. For details, see Get an Access Token for SMAPI. |
|
403 |
Request is forbidden. |
|
404 |
The resource being requested isn't found. |
|
429 |
Too many requests received. |
|
500 |
Internal server error. |
|
503 |
Service unavailable. |
Get template IDs
Returns the IDs of templates that you added to your knowledge skill, including templates that you haven't imported data to yet.
Request
HTTP method and URI path
GET /v1/skills/{skillId}/knowledge/templates?nextToken={nextToken}&maxResults={maxResults}
Request parameters
| Field | Description | Type | Required |
|---|---|---|---|
|
|
The ID of your knowledge skill. |
String |
Yes |
|
|
Token that you can use in the next request as the continuation token to list the next page of results. |
String |
No |
|
|
Total number of results that matched the request query. |
Integer |
No |
Response
A successful request returns 200 Success.
Response body structure
{
"paginationContext": {
"previousToken": string,
"nextToken": string,
"totalCount": integer
},
"templates": [
{
"id": string,
"name": string
},
...
]
}
Response body fields
| Field | Description | Type |
|---|---|---|
|
|
Total number of results that matched the request query. |
Integer |
|
|
A value that you can use in the next request as the continuation token to list the next page of results. |
String |
|
|
A value that you can use in the next request as the token to list the previous set of results. |
String |
|
|
Unique identifier of the template. |
String |
|
|
Name of the template. |
String |
Errors
| Code | Description |
|---|---|
|
400 |
Bad request. Returned when a required parameter isn't present, or is badly formatted. |
|
401 |
The authorization token is invalid/expired or doesn't have access to the resource. To obtain a new access token, use a refresh token. For details, see Get an Access Token for SMAPI. |
|
403 |
Request is forbidden. |
|
404 |
The resource being requested isn't found. |
|
429 |
Too many requests received. |
|
500 |
Internal server error. |
|
503 |
Service unavailable. |