Skill Beta Testing API

The Skill Beta Testing API is an asynchronous API that can be used by skill developers to set up skill beta testing for a limited audience before releasing a skill for production. You can also use this API to test changes to an existing skill, while still keeping the currently live version of the skill available for the general public. You can invite friends or family, your social network contacts, or other people for whom you have an email address to test your skill and provide feedback. You can send up to 500 invitations per test. At any time, you can add testers, remove testers, or end a test. You can get feedback on your skill throughout the testing cycle, and reduce costs by making fixes before you release the skill to production. Using skill beta testing can help increase your chances of skill success.

The API's endpoint is https://api.amazonalexa.com. Each API request must have an Authorization header whose value should be the access token retrieved from Login with Amazon.

Errors

The auth token is invalid/expired or doesn't have access to the resource.

404

The resource being requested is not found.

429

Exceed the permitted request limit. Throttling criteria includes total requests, per API, ClientId, and CustomerId.

500

Internal Server Error.

Add testers to a beta test

If you have an existing beta test, you can add testers to it, if you have not exceeded the limit of 500 testers.

Request

POST /skills/{skillId}/betaTest/testers/add

Request body

Include an array of emailId values, each of which is a tester's email address.

{"testers":[{"emailId":"string"}]}

Response

204 Success. No content.

Errors

Code

Description

400

Bad request

401

The auth token is invalid/expired or doesn't have access to the resource.

404

The resource being requested is not found.

429

Exceed the permitted request limit. Throttling criteria includes total requests, per API, ClientId, and CustomerId.

500

Internal Server Error.

Remove testers from a beta test

Remove testers from an existing beta test.

Request

POST /skills/{skillId}/betaTest/testers/remove

Request body

Include an array of emailId values, each of which is a tester's email address.

{"testers":[{"emailId":"string"}]}

Response

204 Success. No content.

Errors

Code

Description

400

Bad request

401

The auth token is invalid/expired or doesn't have access to the resource.

404

The resource being requested is not found.

429

Exceed the permitted request limit. Throttling criteria includes total requests, per API, ClientId, and CustomerId.

500

Internal Server Error.

Send reminder to testers

Send reminder to the testers in a beta test for the given Alexa skill. The system will send an invitation email to each tester and add entitlement on the acceptance.

Request

POST /skills/{skillId}/betaTest/testers/sendReminder

Request body

{
"testers": [
{
"emailId": "string"
}
]
}

Response

204 Success. No content.

Errors

Code

Description

400

Bad request

401

The auth token is invalid/expired or doesn't have access to the resource.

404

The resource being requested is not found.

409

The request could not be completed due to a conflict with the current state of the target resource.

429

Exceed the permitted request limit. Throttling criteria includes total requests, per API, ClientId, and CustomerId.

500

Internal Server Error.

Request feedback from testers

Request feedback from the testers in a beta test for the specified Alexa skill. The system will send notification emails to testers, and these emails will request feedback.

Request

POST /skills/{skillId}/betaTest/testers/requestFeedback

Request body

{
"testers": [
{
"emailId": "string"
}
]
}

Response

204 Success. No content.

Errors

Code

Description

400

Bad request

401

The auth token is invalid/expired or doesn't have access to the resource.

404

The resource being requested is not found.

409

The request could not be completed due to a conflict with the current state of the target resource.

429

Exceed the permitted request limit. Throttling criteria includes total requests, per API, ClientId, and CustomerId.

500

Internal Server Error.

Pagination and filtering of results

For API calls that return a list, you can optionally control the number of results that appear at once with maxResults, and you can use nextToken to obtain the next set of results with the next API call. This sample request has been given line breaks here for readability, but should be concatenated without line breaks. Some of the API calls that return lists also allow additional parameters for filtering.

String. The nextToken value can be used in a subsequent API call to obtain the next values after the maxResults are shown. This token has a 24-hour expiry.

maxResults

Integer. The maximum number of results to display in a single API call. The default is 100, and the range is 1-500. The `nextToken` value can be used to obtain the remaining results in a subsequent API call.