Alexa Skills REST API Reference
The Alexa Skills REST API reference describes the operations for Alexa features that you can add to your Alexa skill and for Alexa skill management tasks that you can do programmatically. The REST API definitions include the endpoints, authentication methods, and request and response parameters.
Pagination in Query results
For query requests that return a large number of results, Alexa divides the results into pages and includes a paginationContext
object in the response. You can iterate through the paged response by sending the same query request with paginationContext.nextToken
in the request header. Some REST API definitions allow additional filter parameters.
The following response shows that there are more results. The nextToken
property points to the next page of results.
{
"paginationContext": {
"nextToken": "someToken.2"
},
"results": [{
...
},
...
]
}
Property | Description | Type |
---|---|---|
|
Indicates there are more matching results. If present, the response contains a subset of the results. When there are no more matching results, |
Object |
|
Identifies the next set of results to return. The token expires in 24 hours. |
String |
paginationContext
property in the response body.The following example shows the HTTP header that includes the nextToken
value. On receipt of this request, Alexa sends the next set of results. If there are more results, Alexa includes another token in the response to enable you to get the next set of results. When Alexa returns the last page of results, the response doesn't include paginationContext
.
GET /{resource}?nextToken=someToken.2
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Limit the number of results
You can control the number of results on a page by including the maxResults
parameter in the request. In the response, Alexa returns up to the specified number of results.
The following example shows the HTTP header that includes the maxResults
and nextToken
values. On receipt of this request, Alexa sends the next set of results up to the 10. If there are more than 10 results, Alexa includes another token in the response to enable you to get the next set of results.
GET {resource}?maxResults=10&nextToken=someToken.2
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
The following table shows the definition of the request path parameters.
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Query |
Token from the previous response. |
String |
No |
|
Query |
Maximum number of results to return in the response. |
Number |
No |
Amazon request ID
In some REST APIs, Alexa includes the X-Amzn-RequestId
parameter in the response header. If a problem occurs, Amazon can use the request-id
to help troubleshoot problems. For example, the response might contain the following header:
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Property | Description | Type |
---|---|---|
|
Unique identifier for the request. |
String |
In this section
- Access Token Retrieval
- Account Linking Management
- Alexa-hosted Skill Management
- Audit Logs
- Beta Test Management
- Beta Tester Management
- Catalog Management
- Customer Profile
- Device Settings
- In-Skill Product Management
- Intent Request History
- Interaction Model Catalog Management
- Interaction Model Management
- Linked Data
- Locale Cloning
- Metrics
- Monetization
- Natural Language Understanding Annotation Set
- Natural Language Understanding Evaluation
- Person Profile
- Proactive Events
- Proactive Suggestion
- Progressive Response
- Reminders
- Resource Schema
- Skill Certification
- Skill Credentials
- Skill Development Notifications
- Skill Enablement
- Skill Invocation
- Skill Manifest
- Skill Messaging
- Skill Package Management
- Skill Publishing
- Skill Rollback
- Skill Simulation
- Skill Validation
- Smart Home Skill Evaluation
- SSL Certificates
- Timers
- Utterance Profiler REST API Reference
- Vendor Management
Related topics
Last updated: Aug 07, 2024