id
large_stringlengths
9
9
api
large_stringclasses
354 values
operation
large_stringlengths
2
64
prompt
large_stringlengths
13
1k
tools
large_stringlengths
213
34.7k
expected_call
large_stringlengths
47
1.21k
category
large_stringclasses
5 values
difficulty
large_stringclasses
3 values
split
large_stringclasses
1 value
prompt_teacher
large_stringlengths
13
1k
teacher_ok
bool
1 class
prompt_template
large_stringlengths
42
717
fc-002637
Rocket Services
getDevice
Get the registered device with id id_48291.
[{"type": "function", "function": {"name": "getDevice", "description": "Get a registered device.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the registered device e.g. serial number."}, "ff": {"type": "array", "description": "The set of opt in fea...
{"name": "getDevice", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the registered device with id id_48291.
true
Using the Rocket Services API, get a registered device with id=example.
fc-002638
Rocket Services
deregisterDevice
Deregister playback device id id_48291 from my account.
[{"type": "function", "function": {"name": "deregisterDevice", "description": "Deregister a playback device from an account.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the registered device e.g. serial number."}, "ff": {"type": "array", "descript...
{"name": "deregisterDevice", "arguments": {"id": "id_48291"}}
delete
easy
dev
Deregister playback device id id_48291 from my account.
true
Using the Rocket Services API, deregister a playback device from an account for id=example.
fc-002639
Rocket Services
renameDevice
Rename device id_48291 to Acme Analytics.
[{"type": "function", "function": {"name": "renameDevice", "description": "Rename a device", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for this registered device e.g. serial number."}, "name": {"type": "string", "description": "The new name for the de...
{"name": "renameDevice", "arguments": {"id": "id_48291", "name": "Acme Analytics"}}
update
medium
dev
Rename device id_48291 to Acme Analytics.
true
Using the Rocket Services API, rename a device, setting id=example, name=example.
fc-002640
Rocket Services
getItemMediaFiles
Get the video files for item id_48291 at resolution resolution-9f2a7c31 with delivery alpha, beta.
[{"type": "function", "function": {"name": "getItemMediaFiles", "description": "Get the video files associated with an item given maximum resolution, device type and one or more delivery types. This endpoint accepts an Account Catalog token, however if when requesting playback files you receive an *403 status code with...
{"name": "getItemMediaFiles", "arguments": {"id": "id_48291", "delivery": ["alpha", "beta"], "resolution": "resolution-9f2a7c31"}}
retrieve
hard
dev
Get the video files for item id_48291 at resolution resolution-9f2a7c31 with delivery alpha, beta.
true
Using the Rocket Services API, get the video files associated with an item given maximum resolution, device type and one or more delivery types with id=example, delivery=['example'], resolution=example.
fc-002641
Rocket Services
getItemMediaFilesGuarded
Get video files for item id_48291 at resolution resolution-9f2a7c31 for delivery alpha, beta.
[{"type": "function", "function": {"name": "getItemMediaFilesGuarded", "description": "Get the video files associated with an item given maximum resolution, device type and one or more delivery types. This endpoint is identical to the `/account/items/{id}/videos` however it expects an Account Playback token. This token...
{"name": "getItemMediaFilesGuarded", "arguments": {"id": "id_48291", "delivery": ["alpha", "beta"], "resolution": "resolution-9f2a7c31"}}
retrieve
hard
dev
Get video files for item id_48291 at resolution resolution-9f2a7c31 for delivery alpha, beta.
true
Using the Rocket Services API, get the video files associated with an item given maximum resolution, device type and one or more delivery types with id=example, delivery=['example'], resolution=example.
fc-002642
Rocket Services
changePassword
Change my account password to s3cr3t-T0ken-9f2a using profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "changePassword", "description": "Change the password of an account. The expected token scope is Settings.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\nWh...
{"name": "changePassword", "arguments": {"password": "s3cr3t-T0ken-9f2a", "profileToken": "s3cr3t-T0ken-9f2a"}}
update
medium
dev
Change my account password to s3cr3t-T0ken-9f2a using profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, change the password of an account, setting password=example, profileToken=example.
fc-002643
Rocket Services
changePin
Change the account pin to pin-9f2a7c31.
[{"type": "function", "function": {"name": "changePin", "description": "Change the pin of an account.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\nWhile Rocket APIs look to avoid breaking changes u...
{"name": "changePin", "arguments": {"pin": "pin-9f2a7c31"}}
action
easy
dev
Change the account pin to pin-9f2a7c31.
true
Using the Rocket Services API, change the pin of an account, setting pin=example.
fc-002644
Rocket Services
getItemBookmark
Get the bookmark for item itemid_48291 under my active profile.
[{"type": "function", "function": {"name": "getItemBookmark", "description": "Get the bookmark for an item under the active profile.", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "description": "The id of the item to get the bookmark for."}, "ff": {"type": "array", "description": "The s...
{"name": "getItemBookmark", "arguments": {"itemId": "itemid_48291"}}
retrieve
easy
dev
Get the bookmark for item itemid_48291 under my active profile.
true
Using the Rocket Services API, get the bookmark for an item under the active profile with itemId=example.
fc-002645
Rocket Services
bookmarkItem
Bookmark item itemid_48291 under the active profile.
[{"type": "function", "function": {"name": "bookmarkItem", "description": "Bookmark an item under the active profile. Creates one if it doesn't exist, overwrites one if it does.", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "description": "The id of the item to bookmark."}, "ff": {"type...
{"name": "bookmarkItem", "arguments": {"itemId": "itemid_48291"}}
update
easy
dev
Bookmark item itemid_48291 under the active profile.
true
Using the Rocket Services API, bookmark an item under the active profile, setting itemId=example.
fc-002646
Rocket Services
deleteItemBookmark
Unbookmark item itemid_48291 under my active profile.
[{"type": "function", "function": {"name": "deleteItemBookmark", "description": "Unbookmark an item under the active profile.", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "description": "The identifier of the bookmark to delete."}, "ff": {"type": "array", "description": "The set of opt...
{"name": "deleteItemBookmark", "arguments": {"itemId": "itemid_48291"}}
delete
easy
dev
Unbookmark item itemid_48291 under my active profile.
true
Using the Rocket Services API, unbookmark an item under the active profile for itemId=example.
fc-002647
Rocket Services
getNextPlaybackItem
Return the next item to play given source item itemid_48291.
[{"type": "function", "function": {"name": "getNextPlaybackItem", "description": "Returns the next item to play given a source item id. For an unwatched show it returns the first episode available to the account. For a watched show it returns the last incompletely watched episode by the profile, or the episode that imm...
{"name": "getNextPlaybackItem", "arguments": {"itemId": "itemid_48291"}}
retrieve
easy
dev
Return the next item to play given source item itemid_48291.
true
Using the Rocket Services API, returns the next item to play given a source item id with itemId=example.
fc-002648
Rocket Services
getItemRating
Get the rating info for item itemid_48291 under my active profile.
[{"type": "function", "function": {"name": "getItemRating", "description": "Get the rating info for an item under the active profile.", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "description": "The id of the item to get the rating info for."}, "ff": {"type": "array", "description": "T...
{"name": "getItemRating", "arguments": {"itemId": "itemid_48291"}}
retrieve
easy
dev
Get the rating info for item itemid_48291 under my active profile.
true
Using the Rocket Services API, get the rating info for an item under the active profile with itemId=example.
fc-002649
Rocket Services
rateItem
Rate item itemid_48291 under the active profile with rating 759.
[{"type": "function", "function": {"name": "rateItem", "description": "Rate an item under the active profile. Creates one if it doesn't exist, overwrites one if it does.", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "description": "The id of the item to rate."}, "rating": {"type": "inte...
{"name": "rateItem", "arguments": {"itemId": "itemid_48291", "rating": 759}}
update
medium
dev
Rate item itemid_48291 under the active profile with rating 759.
true
Using the Rocket Services API, rate an item under the active profile, setting itemId=example, rating=1.
fc-002650
Rocket Services
getItemWatchedStatus
Get the watched status info for item itemid_48291 under my active profile.
[{"type": "function", "function": {"name": "getItemWatchedStatus", "description": "Get the watched status info for an item under the active profile.", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "description": "The id of the item to get the watched status for."}, "ff": {"type": "array",...
{"name": "getItemWatchedStatus", "arguments": {"itemId": "itemid_48291"}}
retrieve
easy
dev
Get the watched status info for item itemid_48291 under my active profile.
true
Using the Rocket Services API, get the watched status info for an item under the active profile with itemId=example.
fc-002651
Rocket Services
setItemWatchedStatus
Record the watched playhead position 995 for video item itemid_48291 under the active profile.
[{"type": "function", "function": {"name": "setItemWatchedStatus", "description": "Record the watched playhead position of a video under the active profile. Can be used later to resume a video from where it was last watched. Creates one if it doesn't exist, overwrites one if it does.", "parameters": {"type": "object", ...
{"name": "setItemWatchedStatus", "arguments": {"itemId": "itemid_48291", "position": 995}}
update
medium
dev
Record the watched playhead position 995 for video item itemid_48291 under the active profile.
true
Using the Rocket Services API, record the watched playhead position of a video under the active profile, setting itemId=example, position=1.
fc-002652
Rocket Services
createProfile
Create a new profile named Acme Analytics under my active account.
[{"type": "function", "function": {"name": "createProfile", "description": "Create a new profile under the active account.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\nWhile Rocket APIs look to avo...
{"name": "createProfile", "arguments": {"name": "Acme Analytics"}}
create
easy
dev
Create a new profile named Acme Analytics under my active account.
true
Using the Rocket Services API, create a new profile under the active account with name=example.
fc-002653
Rocket Services
getProfileWithId
Get the summary of profile id_48291 under the active account.
[{"type": "function", "function": {"name": "getProfileWithId", "description": "Get the summary of a profile with a specific id under the active account.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the profile to return."}, "ff": {"type": "array", "descrip...
{"name": "getProfileWithId", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the summary of profile id_48291 under the active account.
true
Using the Rocket Services API, get the summary of a profile with a specific id under the active account with id=example.
fc-002654
Rocket Services
updateProfileWithId
Update the summary of profile id id_48291 under my active account.
[{"type": "function", "function": {"name": "updateProfileWithId", "description": "Update the summary of a profile with a specific id under the active account. This supports partial updates so you can send just the properties you wish to update.", "parameters": {"type": "object", "properties": {"id": {"type": "string", ...
{"name": "updateProfileWithId", "arguments": {"id": "id_48291"}}
update
easy
dev
Update the summary of profile id id_48291 under my active account.
true
Using the Rocket Services API, update the summary of a profile with a specific id under the active account, setting id=example.
fc-002655
Rocket Services
deleteProfileWithId
Delete profile id_48291 under the active account.
[{"type": "function", "function": {"name": "deleteProfileWithId", "description": "Delete a profile with a specific id under the active account. Note that you cannot delete the primary profile.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the profile to del...
{"name": "deleteProfileWithId", "arguments": {"id": "id_48291"}}
delete
easy
dev
Delete profile id_48291 under the active account.
true
Using the Rocket Services API, delete a profile with a specific id under the active account for id=example.
fc-002656
Rocket Services
getAccountToken
Request Account level authorization token for email alex.chen@example.com with password s3cr3t-T0ken-9f2a and scope alpha, beta.
[{"type": "function", "function": {"name": "getAccountToken", "description": "Request one or more `Account` level authorization tokens each with a chosen scope. Tokens are used to access restricted service endpoints. These restricted endpoints will require a specific token type (e.g Account) with a specific scope (e.g....
{"name": "getAccountToken", "arguments": {"email": "alex.chen@example.com", "password": "s3cr3t-T0ken-9f2a", "scopes": ["alpha", "beta"]}}
retrieve
hard
dev
Request Account level authorization token for email alex.chen@example.com with password s3cr3t-T0ken-9f2a and scope alpha, beta.
true
Using the Rocket Services API, request one or more level authorization tokens each with a chosen scope with email=example, password=example, scopes=['example'].
fc-002657
Rocket Services
getAccountTokenByCode
Fetch the catalog tokens for account id_48291 using device code CODE-9F2A7C31 and scope alpha, beta.
[{"type": "function", "function": {"name": "getAccountTokenByCode", "description": "Get Catalog tokens for an account using a device authorization code. Where a Profile level token of Catalog scope exists it will also be returned. This is the final step in the process of authorizing a device by pin code. Firstly the de...
{"name": "getAccountTokenByCode", "arguments": {"id": "id_48291", "code": "CODE-9F2A7C31", "scopes": ["alpha", "beta"]}}
retrieve
hard
dev
Fetch the catalog tokens for account id_48291 using device code CODE-9F2A7C31 and scope alpha, beta.
true
Using the Rocket Services API, get Catalog tokens for an account using a device authorization code with id=example, code=example, scopes=['example'].
fc-002658
Rocket Services
generateDeviceAuthorizationCode
Generate a device authorization code for device id_48291 called Acme Analytics using the standard type.
[{"type": "function", "function": {"name": "generateDeviceAuthorizationCode", "description": "Get a generated device authorization code. This is the first step in the process of authorizing a device by pin code. The device will make a request to this endpoint providing a unique identifier for the device such as a seria...
{"name": "generateDeviceAuthorizationCode", "arguments": {"id": "id_48291", "name": "Acme Analytics", "type": "standard"}}
create
hard
dev
Generate a device authorization code for device id_48291 called Acme Analytics using the standard type.
true
Using the Rocket Services API, get a generated device authorization code with id=example, name=example, type=example.
fc-002659
Rocket Services
getProfileToken
Request a Profile token for profile profileid_48291 with the alpha, beta scope.
[{"type": "function", "function": {"name": "getProfileToken", "description": "Request one or more `Profile` level authorization tokens each with a chosen scope. Tokens are used to access restricted service endpoints. These restriced endpoints will require a specific token type (e.g Profile) with a specific scope (e.g. ...
{"name": "getProfileToken", "arguments": {"profileId": "profileid_48291", "scopes": ["alpha", "beta"]}}
retrieve
medium
dev
Request a Profile token for profile profileid_48291 with the alpha, beta scope.
true
Using the Rocket Services API, request one or more level authorization tokens each with a chosen scope with profileId=example, scopes=['example'].
fc-002660
Rocket Services
refreshToken
Refresh my account token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "refreshToken", "description": "Refresh an account or profile level authorization token which is marked as refreshable.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to res...
{"name": "refreshToken", "arguments": {"token": "s3cr3t-T0ken-9f2a"}}
create
easy
dev
Refresh my account token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, refresh an account or profile level authorization token which is marked as refreshable with token=example.
fc-002661
Rocket Services
singleSignOn
Exchange my provider_48291 SSO token s3cr3t-T0ken-9f2a for our own authorization tokens.
[{"type": "function", "function": {"name": "singleSignOn", "description": "Exchange a third party single-sign-on token for our own authorization tokens.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\...
{"name": "singleSignOn", "arguments": {"provider": "provider_48291", "token": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Exchange my provider_48291 SSO token s3cr3t-T0ken-9f2a for our own authorization tokens.
true
Using the Rocket Services API, exchange a third party single-sign-on token for our own authorization tokens with provider=example, token=example.
fc-002662
Rocket Services
getPlanByToken
Show me all the BT plans available with token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "getPlanByToken", "description": "Returns all the plans available for BT flow including additional description data.", "parameters": {"type": "object", "properties": {"token": {"type": "string", "description": "The identifier of the user provided by BT in an initial URL."}, "l...
{"name": "getPlanByToken", "arguments": {"token": "s3cr3t-T0ken-9f2a"}}
retrieve
easy
dev
Show me all the BT plans available with token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, returns all the plans available for BT flow including additional description data with token=example.
fc-002663
Rocket Services
assignToken
Assign user token s3cr3t-T0ken-9f2a to the profile identified by profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "assignToken", "description": "Assigns an UserToken to a profile on the ITV side. Currently throws an exception.", "parameters": {"type": "object", "properties": {"lang": {"type": "string", "description": "Language code for the preferred language to be returned in the response...
{"name": "assignToken", "arguments": {"token": "s3cr3t-T0ken-9f2a", "profileToken": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Assign user token s3cr3t-T0ken-9f2a to the profile identified by profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, assigns an UserToken to a profile on the ITV side with token=example, profileToken=example.
fc-002664
Rocket Services
checkUserToken
Check whether user id_48291 is eligible for BT.
[{"type": "function", "function": {"name": "checkUserToken", "description": "Checks a provided token for BT eligible user.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "User token provided by BT."}, "ff": {"type": "array", "description": "The set of opt in feature flags whic...
{"name": "checkUserToken", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Check whether user id_48291 is eligible for BT.
true
Using the Rocket Services API, checks a provided token for BT eligible user with id=example.
fc-002665
Rocket Services
getSubscriptionData
Return subscription data for the user with id id_48291.
[{"type": "function", "function": {"name": "getSubscriptionData", "description": "Returns the details of subscription data for a user with specified id.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the user to load.\n"}}, "required": ["id"]}}}, {"type": "f...
{"name": "getSubscriptionData", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Return subscription data for the user with id id_48291.
true
Using the Rocket Services API, returns the details of subscription data for a user with specified id with id=example.
fc-002666
Rocket Services
assignMsisdn
Assign msisdn msisdn-9f2a7c31 to the profile with token s3cr3t-T0ken-9f2a, using tracking header trackingheader-9f2a7c31 for EE product eeproductid_48291.
[{"type": "function", "function": {"name": "assignMsisdn", "description": "Assigns a msisdn to a profile on ITV side.", "parameters": {"type": "object", "properties": {"lang": {"type": "string", "description": "Language code for the preferred language to be returned in the response.\n\nParameter value is case-insensiti...
{"name": "assignMsisdn", "arguments": {"msisdn": "msisdn-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a", "trackingHeader": "trackingheader-9f2a7c31", "eeProductId": "eeproductid_48291"}}
action
hard
dev
Assign msisdn msisdn-9f2a7c31 to the profile with token s3cr3t-T0ken-9f2a, using tracking header trackingheader-9f2a7c31 for EE product eeproductid_48291.
true
Using the Rocket Services API, assigns a msisdn to a profile on ITV side with msisdn=example, profileToken=example, trackingHeader=example, eeProductId=example.
fc-002667
Rocket Services
getEligibleOffers
List eligible partner offers for MSISDN msisdn-9f2a7c31 using access token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "getEligibleOffers", "description": "Returns eligible partner specific offers for the querying partner for an EE MSISDN. This call is supposed to be called after we have MSISDN accired. This call should be followed by POST /ee/msisdn.", "parameters": {"type": "object", "proper...
{"name": "getEligibleOffers", "arguments": {"msisdn": "msisdn-9f2a7c31", "accessToken": "s3cr3t-T0ken-9f2a"}}
retrieve
medium
dev
List eligible partner offers for MSISDN msisdn-9f2a7c31 using access token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, returns eligible partner specific offers for the querying partner for an EE MSISDN with msisdn=example, accessToken=example.
fc-002668
Rocket Services
validatePinRequest
Validate the PIN request pinreference_48291 with PIN pin-9f2a7c31 using access token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "validatePinRequest", "description": "Validate PIN request created by calling POST /ee/pin This call is to validate MSISDN entered by a user not comming through EE network. This call should be called after PUT /ee/pin. This call should be followed by POST /ee/offers.", "parame...
{"name": "validatePinRequest", "arguments": {"pinReference": "pinreference_48291", "pin": "pin-9f2a7c31", "accessToken": "s3cr3t-T0ken-9f2a"}}
action
hard
dev
Validate the PIN request pinreference_48291 with PIN pin-9f2a7c31 using access token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, validate PIN request created by calling POST /ee/pin This call is to validate MSISDN entered by a user not comming throu with pinReference=example, pin=example, accessToken=example.
fc-002669
Rocket Services
createPinRequest
Create a PIN request sending an SMS to msisdn-9f2a7c31 with access token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "createPinRequest", "description": "Creates a PIN request that will send an SMS to the given msisdn. This call is to validate MSISDN entered by a user not comming through EE network. This call should be followed by POST ee/pin.", "parameters": {"type": "object", "properties": ...
{"name": "createPinRequest", "arguments": {"msisdn": "msisdn-9f2a7c31", "accessToken": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Create a PIN request sending an SMS to msisdn-9f2a7c31 with access token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, creates a PIN request that will send an SMS to the given msisdn, setting msisdn=example, accessToken=example.
fc-002670
Rocket Services
getPlan
Get the EE plan description for id_48291.
[{"type": "function", "function": {"name": "getPlan", "description": "Returns the plan description for EE flow including additional description data.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the plan received from ee/offers."}, "lang": {"type": "string...
{"name": "getPlan", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the EE plan description for id_48291.
true
Using the Rocket Services API, returns the plan description for EE flow including additional description data with id=example.
fc-002671
Rocket Services
getItem
Return the details of item id_48291.
[{"type": "function", "function": {"name": "getItem", "description": "Returns the details of an item with the specified id.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the item to load.\n\nThe custom identifier of an item can be used here if the `use_cust...
{"name": "getItem", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Return the details of item id_48291.
true
Using the Rocket Services API, returns the details of an item with the specified id with id=example.
fc-002672
Rocket Services
getItemChildrenList
List the child items under item id_48291.
[{"type": "function", "function": {"name": "getItemChildrenList", "description": "Returns the List of child summary items under an item. If the item is a Season then the children will be episodes and ordered by episode number. If the item is a Show then the children will be Seasons and ordered by season number. Returns...
{"name": "getItemChildrenList", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
List the child items under item id_48291.
true
Using the Rocket Services API, returns the List of child summary items under an item with id=example.
fc-002673
Rocket Services
getItemRelatedList
Get the related items list for parent item id_48291.
[{"type": "function", "function": {"name": "getItemRelatedList", "description": "Returns the list of items related to the parent item. Note for now, due to the size of the list being unknown, only a single page will be returned.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "...
{"name": "getItemRelatedList", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the related items list for parent item id_48291.
true
Using the Rocket Services API, returns the list of items related to the parent item with id=example.
fc-002674
Rocket Services
getPublicItemMediaFiles
Get the public video files for item id_48291 at resolution resolution-9f2a7c31 using delivery type alpha, beta.
[{"type": "function", "function": {"name": "getPublicItemMediaFiles", "description": "Get the free / public video files associated with an item given maximum resolution, device type and one or more delivery types. Returns an array of video file objects which each include a url to a video. The first entry in the array c...
{"name": "getPublicItemMediaFiles", "arguments": {"id": "id_48291", "delivery": ["alpha", "beta"], "resolution": "resolution-9f2a7c31"}}
retrieve
hard
dev
Get the public video files for item id_48291 at resolution resolution-9f2a7c31 using delivery type alpha, beta.
true
Using the Rocket Services API, get the free / public video files associated with an item given maximum resolution, device type and one or more delivery with id=example, delivery=['example'], resolution=example.
fc-002675
Rocket Services
getAnonNextPlaybackItem
Fetch the next playback item for item itemid_48291 without requiring authorization.
[{"type": "function", "function": {"name": "getAnonNextPlaybackItem", "description": "Identical to GET /account/profile/items/{itemId}/next route but for users that are not logged in i.e. this endpoint does not require authorisation", "parameters": {"type": "object", "properties": {"itemId": {"type": "string", "descrip...
{"name": "getAnonNextPlaybackItem", "arguments": {"itemId": "itemid_48291"}}
retrieve
easy
dev
Fetch the next playback item for item itemid_48291 without requiring authorization.
true
Using the Rocket Services API, identical to GET /account/profile/items/{itemId}/next route but for users that are not logged in i.e with itemId=example.
fc-002676
Rocket Services
getBillingHistory
Show me the billing history on platform platform-9f2a7c31 for profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "getBillingHistory", "description": "Returns the list of billing records for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "lang": {"type":...
{"name": "getBillingHistory", "arguments": {"platform": "platform-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a"}}
retrieve
medium
dev
Show me the billing history on platform platform-9f2a7c31 for profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, returns the list of billing records for specified payment platform with platform=example, profileToken=example.
fc-002677
Rocket Services
getCardDetails
Get payment card details for platform platform-9f2a7c31 using profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "getCardDetails", "description": "Get payment card details.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "lang": {"type": "string", "description": "Language code for ...
{"name": "getCardDetails", "arguments": {"platform": "platform-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a"}}
retrieve
medium
dev
Get payment card details for platform platform-9f2a7c31 using profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, get payment card details with platform=example, profileToken=example.
fc-002678
Rocket Services
changeCardDetails
Update my payment card on platform platform-9f2a7c31 for profile s3cr3t-T0ken-9f2a using card token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "changeCardDetails", "description": "Change payment card details.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "lang": {"type": "string", "description": "Language cod...
{"name": "changeCardDetails", "arguments": {"platform": "platform-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a", "cardToken": "s3cr3t-T0ken-9f2a"}}
action
hard
dev
Update my payment card on platform platform-9f2a7c31 for profile s3cr3t-T0ken-9f2a using card token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, change payment card details, setting platform=example, profileToken=example, cardToken=example.
fc-002679
Rocket Services
changeEmail
Change the account email to alex.chen@example.com with profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "changeEmail", "description": "Change email address related to account/profile. The expected token scope is Settings.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to respo...
{"name": "changeEmail", "arguments": {"email": "alex.chen@example.com", "profileToken": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Change the account email to alex.chen@example.com with profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, change email address related to account/profile with email=example, profileToken=example.
fc-002680
Rocket Services
changeMarketing
Set my email opt-in to true for profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "changeMarketing", "description": "Change marketing preferences related to account/profile. The expected token scope is Settings.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking chan...
{"name": "changeMarketing", "arguments": {"emailOptIn": true, "profileToken": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Set my email opt-in to true for profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, change marketing preferences related to account/profile with emailOptIn=True, profileToken=example.
fc-002681
Rocket Services
deleteAccount
Delete my account in compliance with GDPR using profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "deleteAccount", "description": "Delete account in compliance with GDPR. The expected token scope is Settings.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n...
{"name": "deleteAccount", "arguments": {"profileToken": "s3cr3t-T0ken-9f2a"}}
create
easy
dev
Delete my account in compliance with GDPR using profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, delete account in compliance with GDPR with profileToken=example.
fc-002682
Rocket Services
getFeatureFlag
Check whether feature flag feature-9f2a7c31 is enabled or disabled.
[{"type": "function", "function": {"name": "getFeatureFlag", "description": "Gets info whether or not a feature is enabled or disabled using a feature flag. Feature flags are set as a custom field within PM. It also supports custom feature flag data if needed. Such data can be return as well.", "parameters": {"type": "...
{"name": "getFeatureFlag", "arguments": {"feature": "feature-9f2a7c31"}}
retrieve
easy
dev
Check whether feature flag feature-9f2a7c31 is enabled or disabled.
true
Using the Rocket Services API, gets info whether or not a feature is enabled or disabled using a feature flag with feature=example.
fc-002683
Rocket Services
googlePaySubscription
Process a Google Pay subscription purchase with token s3cr3t-T0ken-9f2a for item subscriptionitem-9f2a7c31.
[{"type": "function", "function": {"name": "googlePaySubscription", "description": "Get the list of recommended items under the active profile.", "parameters": {"type": "object", "properties": {"lang": {"type": "string", "description": "Language code for the preferred language to be returned in the response.\n\nParamet...
{"name": "googlePaySubscription", "arguments": {"purchaseToken": "s3cr3t-T0ken-9f2a", "subscriptionItem": "subscriptionitem-9f2a7c31"}}
action
medium
dev
Process a Google Pay subscription purchase with token s3cr3t-T0ken-9f2a for item subscriptionitem-9f2a7c31.
true
Using the Rocket Services API, get the list of recommended items under the active profile with purchaseToken=example, subscriptionItem=example.
fc-002684
Rocket Services
getItemsMediaClipFiles
Get the media clip files for items ids_48291.
[{"type": "function", "function": {"name": "getItemsMediaClipFiles", "description": "Get the media clip files associated with items.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\nWhile Rocket APIs l...
{"name": "getItemsMediaClipFiles", "arguments": {"ids": "ids_48291"}}
create
easy
dev
Get the media clip files for items ids_48291.
true
Using the Rocket Services API, get the media clip files associated with items with ids=example.
fc-002685
Rocket Services
getItemDownloadables
Return downloadable details for items ids_48291.
[{"type": "function", "function": {"name": "getItemDownloadables", "description": "Returns the details of an item with the specified id.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\nWhile Rocket AP...
{"name": "getItemDownloadables", "arguments": {"ids": "ids_48291"}}
create
easy
dev
Return downloadable details for items ids_48291.
true
Using the Rocket Services API, returns the details of an item with the specified id with ids=example.
fc-002686
Rocket Services
get_itv_itemsummary_externalId
Redirect me to the Axis item details page for external ID externalid_48291.
[{"type": "function", "function": {"name": "get_itv_itemsummary_externalId", "description": "Redirects to corresponding Axis Item details page.", "parameters": {"type": "object", "properties": {"externalId": {"type": "string", "description": "The external identifier of the item."}}, "required": ["externalId"]}}}, {"typ...
{"name": "get_itv_itemsummary_externalId", "arguments": {"externalId": "externalid_48291"}}
retrieve
easy
dev
Redirect me to the Axis item details page for external ID externalid_48291.
true
Using the Rocket Services API, redirects to corresponding Axis Item details page with externalId=example.
fc-002687
Rocket Services
getItvPage
Return the ITV page at path reports/2026-q3.pdf, optimized for low memory devices.
[{"type": "function", "function": {"name": "getItvPage", "description": "Returns a page with the specified id. This is a cut down version for low memory devices.123 If targeting the search page you must url encode the search term as a parameter using the `q` key. For example if your browser path looks like `/search?q=t...
{"name": "getItvPage", "arguments": {"path": "reports/2026-q3.pdf"}}
retrieve
easy
dev
Return the ITV page at path reports/2026-q3.pdf, optimized for low memory devices.
true
Using the Rocket Services API, returns a page with the specified id with path=example.
fc-002688
Rocket Services
getAccountTokenWithPin
Get an account token with playback scope using parental control pin pin-9f2a7c31.
[{"type": "function", "function": {"name": "getAccountTokenWithPin", "description": "Provides authorization with parental control pin. Returns an array containing account token with Playback scope. Requires access token with Catalog scope. Pin must be a 4-digit string", "parameters": {"type": "object", "properties": {"...
{"name": "getAccountTokenWithPin", "arguments": {"pin": "pin-9f2a7c31"}}
retrieve
easy
dev
Get an account token with playback scope using parental control pin pin-9f2a7c31.
true
Using the Rocket Services API, provides authorization with parental control pin with pin=example.
fc-002689
Rocket Services
upgradePlan
Upgrade my plan to planid_48291 on platform platform-9f2a7c31.
[{"type": "function", "function": {"name": "upgradePlan", "description": "Upgrades the plan for the current user.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes). Only Stripe is supported"}, "lang": {"type": "string"...
{"name": "upgradePlan", "arguments": {"platform": "platform-9f2a7c31", "planId": "planid_48291"}}
action
medium
dev
Upgrade my plan to planid_48291 on platform platform-9f2a7c31.
true
Using the Rocket Services API, upgrades the plan for the current user with platform=example, planId=example.
fc-002690
Rocket Services
get_itv_plans_platform
Return the ITV plans available on platform platform-9f2a7c31.
[{"type": "function", "function": {"name": "get_itv_plans_platform", "description": "Returns the plans available for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "lang": {"type": "s...
{"name": "get_itv_plans_platform", "arguments": {"platform": "platform-9f2a7c31"}}
retrieve
easy
dev
Return the ITV plans available on platform platform-9f2a7c31.
true
Using the Rocket Services API, returns the plans available for specified payment platform with platform=example.
fc-002691
Rocket Services
updateProfile
Update my ITV profile with profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "updateProfile", "description": "Update ITV profile. The expected token scope is Settings.", "parameters": {"type": "object", "properties": {"ff": {"type": "array", "description": "The set of opt in feature flags which cause breaking changes to responses.\n\nWhile Rocket APIs ...
{"name": "updateProfile", "arguments": {"profileToken": "s3cr3t-T0ken-9f2a"}}
update
easy
dev
Update my ITV profile with profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, update ITV profile, setting profileToken=example.
fc-002692
Rocket Services
getItvProfileToken
Return my ITV profile token using password s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "getItvProfileToken", "description": "Returns the ITV profile token.", "parameters": {"type": "object", "properties": {"lang": {"type": "string", "description": "Language code for the preferred language to be returned in the response.\n\nParameter value is case-insensitive and...
{"name": "getItvProfileToken", "arguments": {"password": "s3cr3t-T0ken-9f2a"}}
create
easy
dev
Return my ITV profile token using password s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, returns the ITV profile token with password=example.
fc-002693
Rocket Services
getCurrentSubscription
Return the current subscription details for platform platform-9f2a7c31.
[{"type": "function", "function": {"name": "getCurrentSubscription", "description": "Returns the details of current subscription for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "la...
{"name": "getCurrentSubscription", "arguments": {"platform": "platform-9f2a7c31"}}
retrieve
easy
dev
Return the current subscription details for platform platform-9f2a7c31.
true
Using the Rocket Services API, returns the details of current subscription for specified payment platform with platform=example.
fc-002694
Rocket Services
confirmPurchase
Confirm my purchase of plan planid_48291 on platform platform-9f2a7c31 for profile s3cr3t-T0ken-9f2a with card token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "confirmPurchase", "description": "Confirms purchase and returns the details of purchased subscription for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (strip...
{"name": "confirmPurchase", "arguments": {"platform": "platform-9f2a7c31", "planId": "planid_48291", "profileToken": "s3cr3t-T0ken-9f2a", "cardToken": "s3cr3t-T0ken-9f2a"}}
action
hard
dev
Confirm my purchase of plan planid_48291 on platform platform-9f2a7c31 for profile s3cr3t-T0ken-9f2a with card token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, confirms purchase and returns the details of purchased subscription for specified payment platform with platform=example, planId=example, profileToken=example, cardToken=example.
fc-002695
Rocket Services
delete_itv_purchase_platform
Cancel my subscription on platform platform-9f2a7c31 using profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "delete_itv_purchase_platform", "description": "Cancel a plan subscription. A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description...
{"name": "delete_itv_purchase_platform", "arguments": {"platform": "platform-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a"}}
delete
medium
dev
Cancel my subscription on platform platform-9f2a7c31 using profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, cancel a plan subscription for platform=example, profileToken=example.
fc-002696
Rocket Services
confirmPurchaseStrong
Confirm the purchase of plan planid_48291 on platform platform-9f2a7c31 with profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "confirmPurchaseStrong", "description": "Confirms purchase and returns the details of purchased subscription for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform ...
{"name": "confirmPurchaseStrong", "arguments": {"platform": "platform-9f2a7c31", "planId": "planid_48291", "profileToken": "s3cr3t-T0ken-9f2a"}}
action
hard
dev
Confirm the purchase of plan planid_48291 on platform platform-9f2a7c31 with profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, confirms purchase and returns the details of purchased subscription for specified payment platform with platform=example, planId=example, profileToken=example.
fc-002697
Rocket Services
confirmPurchaseWithOffer
Confirm the purchase of plan planid_48291 on platform platform-9f2a7c31 with coupon couponid_48291 using profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "confirmPurchaseWithOffer", "description": "Confirms purchase and returns the details of purchased subscription for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platfo...
{"name": "confirmPurchaseWithOffer", "arguments": {"platform": "platform-9f2a7c31", "planId": "planid_48291", "profileToken": "s3cr3t-T0ken-9f2a", "couponId": "couponid_48291"}}
action
hard
dev
Confirm the purchase of plan planid_48291 on platform platform-9f2a7c31 with coupon couponid_48291 using profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, confirms purchase and returns the details of purchased subscription for specified payment platform with platform=example, planId=example, profileToken=example, couponId=example.
fc-002698
Rocket Services
resubscribe
Resubscribe me to plan planid_48291 on platform platform-9f2a7c31.
[{"type": "function", "function": {"name": "resubscribe", "description": "Resubscription for a user.", "parameters": {"type": "object", "properties": {"planId": {"type": "string", "description": "The id of the plan to renew."}, "platform": {"type": "string", "description": "The identifier of the payment platform (strip...
{"name": "resubscribe", "arguments": {"planId": "planid_48291", "platform": "platform-9f2a7c31"}}
action
medium
dev
Resubscribe me to plan planid_48291 on platform platform-9f2a7c31.
true
Using the Rocket Services API, resubscription for a user with planId=example, platform=example.
fc-002699
Rocket Services
executeTransaction
Execute transaction transactionid_48291 with profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "executeTransaction", "description": "Sends request to execute specified transaction.", "parameters": {"type": "object", "properties": {"transactionid": {"type": "string", "description": "The identifier of the Roku transaction (subscribe/upgrade/downgrade/cancellation)."}, "la...
{"name": "executeTransaction", "arguments": {"transactionid": "transactionid_48291", "profileToken": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Execute transaction transactionid_48291 with profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, sends request to execute specified transaction with transactionid=example, profileToken=example.
fc-002700
Rocket Services
getSubscriptionStatus
Check the status of my latest payment intent on platform platform-9f2a7c31.
[{"type": "function", "function": {"name": "getSubscriptionStatus", "description": "Returns status of latest payment intent.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "lang": {"type": "string", "description...
{"name": "getSubscriptionStatus", "arguments": {"platform": "platform-9f2a7c31"}}
retrieve
easy
dev
Check the status of my latest payment intent on platform platform-9f2a7c31.
true
Using the Rocket Services API, returns status of latest payment intent with platform=example.
fc-002701
Rocket Services
updatePaymentIntentStrong
Change my payment method details for platform platform-9f2a7c31 using profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "updatePaymentIntentStrong", "description": "Change payment method details.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe only is currently supported)."}, "lang": {"type": "string...
{"name": "updatePaymentIntentStrong", "arguments": {"platform": "platform-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a"}}
update
medium
dev
Change my payment method details for platform platform-9f2a7c31 using profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, change payment method details, setting platform=example, profileToken=example.
fc-002702
Rocket Services
updatePaymentMethodStrong
Change my payment method details on platform platform-9f2a7c31 for profile token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "updatePaymentMethodStrong", "description": "Change payment method details.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe only is currently supported)."}, "lang": {"type": "string...
{"name": "updatePaymentMethodStrong", "arguments": {"platform": "platform-9f2a7c31", "profileToken": "s3cr3t-T0ken-9f2a"}}
update
medium
dev
Change my payment method details on platform platform-9f2a7c31 for profile token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, change payment method details, setting platform=example, profileToken=example.
fc-002703
Rocket Services
getVoucherById
Check whether voucher voucherid_48291 is valid for plan planid_48291.
[{"type": "function", "function": {"name": "getVoucherById", "description": "Checks the provided coupon id for a user. Only Stripe platform is currently supported.", "parameters": {"type": "object", "properties": {"voucherId": {"type": "string", "description": "The identifier of the voucher."}, "planId": {"type": "stri...
{"name": "getVoucherById", "arguments": {"voucherId": "voucherid_48291", "planId": "planid_48291"}}
retrieve
medium
dev
Check whether voucher voucherid_48291 is valid for plan planid_48291.
true
Using the Rocket Services API, checks the provided coupon id for a user with voucherId=example, planId=example.
fc-002704
Rocket Services
checkVoucher
Validate voucher platform-9f2a7c31 for payment platform VCHR-9F2A7C31.
[{"type": "function", "function": {"name": "checkVoucher", "description": "Validates the coupon/voucher for specified payment platform.", "parameters": {"type": "object", "properties": {"platform": {"type": "string", "description": "The identifier of the payment platform (stripe/itunes)."}, "lang": {"type": "string", "...
{"name": "checkVoucher", "arguments": {"platform": "platform-9f2a7c31", "voucher": "VCHR-9F2A7C31"}}
action
medium
dev
Validate voucher platform-9f2a7c31 for payment platform VCHR-9F2A7C31.
true
Using the Rocket Services API, validates the coupon/voucher for specified payment platform with platform=example, voucher=example.
fc-002705
Rocket Services
getLists
Return item lists ids_48291 with their first page of content resolved.
[{"type": "function", "function": {"name": "getLists", "description": "Returns an array of item lists with their first page of content resolved.", "parameters": {"type": "object", "properties": {"ids": {"type": "array", "description": "A comma delimited list of item list identifiers.\n\nThese can be list ids e.g. `1435...
{"name": "getLists", "arguments": {"ids": ["ids_48291"]}}
retrieve
easy
dev
Return item lists ids_48291 with their first page of content resolved.
true
Using the Rocket Services API, returns an array of item lists with their first page of content resolved with ids=['example'].
fc-002706
Rocket Services
getList
Return the list of items under item id_48291.
[{"type": "function", "function": {"name": "getList", "description": "Returns a list of items under the specified item list", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the list to load."}, "page": {"type": "integer", "description": "The page of items to l...
{"name": "getList", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Return the list of items under item id_48291.
true
Using the Rocket Services API, returns a list of items under the specified item list with id=example.
fc-002707
Rocket Services
getPage
Return the page at path reports/2026-q3.pdf.
[{"type": "function", "function": {"name": "getPage", "description": "Returns a page with the specified id. If targeting the search page you must url encode the search term as a parameter using the `q` key. For example if your browser path looks like `/search?q=the` then what you pass to this endpoint would look like `...
{"name": "getPage", "arguments": {"path": "reports/2026-q3.pdf"}}
retrieve
easy
dev
Return the page at path reports/2026-q3.pdf.
true
Using the Rocket Services API, returns a page with the specified id with path=example.
fc-002708
Rocket Services
get_plans_id
Get the details of plan id_48291.
[{"type": "function", "function": {"name": "get_plans_id", "description": "Returns the details of a Plan with the specified id.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "The identifier of the Plan to load."}, "device": {"type": "string", "description": "The type of devic...
{"name": "get_plans_id", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the details of plan id_48291.
true
Using the Rocket Services API, returns the details of a Plan with the specified id with id=example.
fc-002709
Rocket Services
register
Register a new user account with email alex.chen@example.com and password s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "register", "description": "Register a new user, creating them an account. Registration, when successful, will return an array of access tokens so the user is immediately signed in. It returns Catalog and Commerce scoped tokens for both Account and Profile. The Commerce ones a...
{"name": "register", "arguments": {"email": "alex.chen@example.com", "password": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Register a new user account with email alex.chen@example.com and password s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, register a new user, creating them an account with email=example, password=example.
fc-002710
Rocket Services
forgotPassword
Request a password reset for alex.chen@example.com.
[{"type": "function", "function": {"name": "forgotPassword", "description": "Request the password of an account's primary profile be reset. Should be called when a user has forgotten their password. This will send an email with a password reset link to the email address of the primary profile of an account. The link, o...
{"name": "forgotPassword", "arguments": {"email": "alex.chen@example.com"}}
create
easy
dev
Request a password reset for alex.chen@example.com.
true
Using the Rocket Services API, request the password of an account's primary profile be reset with email=example.
fc-002711
Rocket Services
resetPassword
Reset my password to s3cr3t-T0ken-9f2a using reset token s3cr3t-T0ken-9f2a.
[{"type": "function", "function": {"name": "resetPassword", "description": "When a user requests to reset their password via the /request-password-reset endpoint, an email is sent to the email address of the primary profile of the account. This email contains a link with a reset token as query parameter. The link shoul...
{"name": "resetPassword", "arguments": {"resetToken": "s3cr3t-T0ken-9f2a", "password": "s3cr3t-T0ken-9f2a"}}
create
medium
dev
Reset my password to s3cr3t-T0ken-9f2a using reset token s3cr3t-T0ken-9f2a.
true
Using the Rocket Services API, when a user requests to reset their password via the /request-password-reset endpoint, an email is sent to the email add with resetToken=example, password=example.
fc-002712
Rocket Services
getSchedules
Get schedules for channel alpha, beta on 2026-10-15 starting at hour 694 for a duration of 660 minutes.
[{"type": "function", "function": {"name": "getSchedules", "description": "Returns schedules for a defined set of channels over a requested period. Schedules are requested in hour blocks and returned grouped by the channel they belong to. For example, to load 12 hours of schedules for channels `4343` and `5234`, on 21/...
{"name": "getSchedules", "arguments": {"channels": ["alpha", "beta"], "date": "2026-10-15", "hour": 694, "duration": 660}}
retrieve
hard
dev
Get schedules for channel alpha, beta on 2026-10-15 starting at hour 694 for a duration of 660 minutes.
true
Using the Rocket Services API, returns schedules for a defined set of channels over a requested period with channels=['example'], date=example, hour=1, duration=1.
fc-002713
Rocket Services
search
Search the catalog for term term-9f2a7c31.
[{"type": "function", "function": {"name": "search", "description": "Search the catalog of items and people.", "parameters": {"type": "object", "properties": {"term": {"type": "string", "description": "The search term to query."}, "include": {"type": "array", "description": "By default people, movies and tv (shows + pr...
{"name": "search", "arguments": {"term": "term-9f2a7c31"}}
retrieve
easy
dev
Search the catalog for term term-9f2a7c31.
true
Using the Rocket Services API, search the catalog of items and people with term=example.
fc-002714
Browshot
CreateBatch
Request a batch of thousands of screenshots for instance instance_48291.
[{"type": "function", "function": {"name": "CreateBatch", "description": "Requests thousands of screenshtos at once", "parameters": {"type": "object", "properties": {"instance_id": {"type": "string", "description": "instance ID to use"}, "file": {"type": "string", "description": "text file to use"}, "size": {"type": "s...
{"name": "CreateBatch", "arguments": {"instance_id": "instance_48291"}}
create
easy
dev
Request a batch of thousands of screenshots for instance instance_48291.
true
Using the Browshot API, requests thousands of screenshtos at once with instance_id=example.
fc-002715
Browshot
GetBatchInfo
Get the batch status for id id_48291.
[{"type": "function", "function": {"name": "GetBatchInfo", "description": "Get the batch status", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "batch ID"}}, "required": ["id"]}}}, {"type": "function", "function": {"name": "GetScreenshotInfo", "description": "Query screenshot s...
{"name": "GetBatchInfo", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the batch status for id id_48291.
true
Using the Browshot API, get the batch status with id=example.
fc-002716
Browshot
GetBrowserInfo
Get information about browser id_48291.
[{"type": "function", "function": {"name": "GetBrowserInfo", "description": "Get information about a browser", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "browser ID"}}, "required": ["id"]}}}, {"type": "function", "function": {"name": "HostScreenshot", "description": "Host t...
{"name": "GetBrowserInfo", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get information about browser id_48291.
true
Using the Browshot API, get information about a browser with id=example.
fc-002717
Browshot
GetInstanceInfo
Get information about instance id_48291.
[{"type": "function", "function": {"name": "GetInstanceInfo", "description": "Get information about an instance", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "instance ID"}}, "required": ["id"]}}}, {"type": "function", "function": {"name": "GetHTML", "description": "Get the H...
{"name": "GetInstanceInfo", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get information about instance id_48291.
true
Using the Browshot API, get information about an instance with id=example.
fc-002718
Browshot
CreateScreenshot
Request a screenshot of https://api.example.com/v1/items on instance instance_48291.
[{"type": "function", "function": {"name": "CreateScreenshot", "description": "Request a screenshot", "parameters": {"type": "object", "properties": {"url": {"type": "string", "description": "URL of the page to get a screenshot for"}, "instance_id": {"type": "string", "description": "instance ID to use"}, "size": {"typ...
{"name": "CreateScreenshot", "arguments": {"url": "https://api.example.com/v1/items", "instance_id": "instance_48291"}}
retrieve
medium
dev
Request a screenshot of https://api.example.com/v1/items on instance instance_48291.
true
Using the Browshot API, request a screenshot with url=example, instance_id=example.
fc-002719
Browshot
DeleteScreenshot
Delete screenshot data for id id_48291.
[{"type": "function", "function": {"name": "DeleteScreenshot", "description": "Delete screenshot data", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "screenshot ID"}, "data": {"type": "string", "description": "data to remove. You can specify multiple of them (separated by a ,)...
{"name": "DeleteScreenshot", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Delete screenshot data for id id_48291.
true
Using the Browshot API, delete screenshot data with id=example.
fc-002720
Browshot
HostScreenshot
Host thumbnail id_48291 on my own S3 account using hosting hosting-9f2a7c31.
[{"type": "function", "function": {"name": "HostScreenshot", "description": "Host thumbnails on your own S3 account or on Browshot.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "screenshot ID"}, "hosting": {"type": "string", "description": "hosting option: s3 or browshot"}, ...
{"name": "HostScreenshot", "arguments": {"id": "id_48291", "hosting": "hosting-9f2a7c31"}}
action
medium
dev
Host thumbnail id_48291 on my own S3 account using hosting hosting-9f2a7c31.
true
Using the Browshot API, host thumbnails on your own S3 account or on Browshot with id=example, hosting=example.
fc-002721
Browshot
GetHTML
Get the HTML code for id id_48291.
[{"type": "function", "function": {"name": "GetHTML", "description": "Get the HTML code", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "screenshot ID"}}, "required": ["id"]}}}, {"type": "function", "function": {"name": "GetThumbnail", "description": "Retrieve a thumbnail image...
{"name": "GetHTML", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Get the HTML code for id id_48291.
true
Using the Browshot API, get the HTML code with id=example.
fc-002722
Browshot
GetScreenshotInfo
Query the screenshot status for id_48291.
[{"type": "function", "function": {"name": "GetScreenshotInfo", "description": "Query screenshot status", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "screenshot ID received from /api/v1/screenshot/create"}, "details": {"type": "string", "description": "level of details about...
{"name": "GetScreenshotInfo", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Query the screenshot status for id_48291.
true
Using the Browshot API, query screenshot status with id=example.
fc-002723
Browshot
CreateMultipleScreenshots
Request multiple screenshots of https://api.example.com/v1/items on instance instance_48291.
[{"type": "function", "function": {"name": "CreateMultipleScreenshots", "description": "Request multiple screenshots", "parameters": {"type": "object", "properties": {"url": {"type": "string", "description": "URL of the page to get a screenshot for. You can specify multiple url parameters (up to 10)."}, "instance_id": ...
{"name": "CreateMultipleScreenshots", "arguments": {"url": "https://api.example.com/v1/items", "instance_id": "instance_48291"}}
retrieve
medium
dev
Request multiple screenshots of https://api.example.com/v1/items on instance instance_48291.
true
Using the Browshot API, request multiple screenshots with url=example, instance_id=example.
fc-002724
Browshot
SearchScreenshot
Search for screenshots of https://api.example.com/v1/items.
[{"type": "function", "function": {"name": "SearchScreenshot", "description": "Search for screenshots", "parameters": {"type": "object", "properties": {"url": {"type": "string", "description": "look for a string matching the URL requested"}, "limit": {"type": "string", "description": "maximum number of screenshots' inf...
{"name": "SearchScreenshot", "arguments": {"url": "https://api.example.com/v1/items"}}
retrieve
easy
dev
Search for screenshots of https://api.example.com/v1/items.
true
Using the Browshot API, search for screenshots with url=example.
fc-002725
Browshot
ShareScreenshot
Share the screenshot with id id_48291.
[{"type": "function", "function": {"name": "ShareScreenshot", "description": "Share a screenshot", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "screenshot ID"}, "note": {"type": "string", "description": "note to add on the sharing page"}}, "required": ["id"]}}}, {"type": "fun...
{"name": "ShareScreenshot", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Share the screenshot with id id_48291.
true
Using the Browshot API, share a screenshot with id=example.
fc-002726
Browshot
GetThumbnail
Retrieve the thumbnail image for id_48291.
[{"type": "function", "function": {"name": "GetThumbnail", "description": "Retrieve a thumbnail image", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": "screenshot ID"}, "width": {"type": "string", "description": "width of the thumbnail"}, "height": {"type": "string", "descriptio...
{"name": "GetThumbnail", "arguments": {"id": "id_48291"}}
retrieve
easy
dev
Retrieve the thumbnail image for id_48291.
true
Using the Browshot API, retrieve a thumbnail image with id=example.
fc-002727
Bufferapp
get_info_configuration_mediaTypeExtension
Return Buffer's current configuration with media type extension standard.
[{"type": "function", "function": {"name": "get_info_configuration_mediaTypeExtension", "description": "Returns an object with the current configuration that Buffer is using, including supported services, their icons and the varying limits of character and schedules.", "parameters": {"type": "object", "properties": {"m...
{"name": "get_info_configuration_mediaTypeExtension", "arguments": {"mediaTypeExtension": "standard"}}
retrieve
easy
dev
Return Buffer's current configuration with media type extension standard.
true
Using the Bufferapp API, returns an object with the current configuration that Buffer is using, including supported services, their icons and the with mediaTypeExtension=example.
fc-002728
Bufferapp
get_links_shares_mediaTypeExtension
Return the share counts for link https://api.example.com/v1/items using media type extension standard.
[{"type": "function", "function": {"name": "get_links_shares_mediaTypeExtension", "description": "Returns an object with a the numbers of shares a link has had using Buffer.", "parameters": {"type": "object", "properties": {"mediaTypeExtension": {"type": "string", "description": ""}, "url": {"type": "string", "descript...
{"name": "get_links_shares_mediaTypeExtension", "arguments": {"mediaTypeExtension": "standard", "url": "https://api.example.com/v1/items"}}
retrieve
medium
dev
Return the share counts for link https://api.example.com/v1/items using media type extension standard.
true
Using the Bufferapp API, returns an object with a the numbers of shares a link has had using Buffer with mediaTypeExtension=example, url=example.
fc-002729
Bufferapp
post_profiles_id_schedules_update_mediaTypeExtension
Set posting schedules for social media profile id_48291 using media type extension standard.
[{"type": "function", "function": {"name": "post_profiles_id_schedules_update_mediaTypeExtension", "description": "\"Set the posting schedules for the specified social media profile.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": ""}, "mediaTypeExtension": {"type": "string", "...
{"name": "post_profiles_id_schedules_update_mediaTypeExtension", "arguments": {"id": "id_48291", "mediaTypeExtension": "standard"}}
create
medium
dev
Set posting schedules for social media profile id_48291 using media type extension standard.
true
Using the Bufferapp API, "Set the posting schedules for the specified social media profile with id=example, mediaTypeExtension=example.
fc-002730
Bufferapp
get_profiles_id_schedules_mediaTypeExtension
Get the posting schedules for social media profile id_48291 with media type extension standard.
[{"type": "function", "function": {"name": "get_profiles_id_schedules_mediaTypeExtension", "description": "Returns details of the posting schedules associated with a social media profile.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": ""}, "mediaTypeExtension": {"type": "strin...
{"name": "get_profiles_id_schedules_mediaTypeExtension", "arguments": {"id": "id_48291", "mediaTypeExtension": "standard"}}
retrieve
medium
dev
Get the posting schedules for social media profile id_48291 with media type extension standard.
true
Using the Bufferapp API, returns details of the posting schedules associated with a social media profile with id=example, mediaTypeExtension=example.
fc-002731
Bufferapp
get_profiles_id_updates_pending_mediaTypeExtension
Return pending buffer updates for social media profile id_48291 with media type extension standard.
[{"type": "function", "function": {"name": "get_profiles_id_updates_pending_mediaTypeExtension", "description": "\"Returns an array of updates that are currently in the buffer for an individual social media profile.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": ""}, "mediaTyp...
{"name": "get_profiles_id_updates_pending_mediaTypeExtension", "arguments": {"id": "id_48291", "mediaTypeExtension": "standard"}}
retrieve
medium
dev
Return pending buffer updates for social media profile id_48291 with media type extension standard.
true
Using the Bufferapp API, "Returns an array of updates that are currently in the buffer for an individual social media profile with id=example, mediaTypeExtension=example.
fc-002732
Bufferapp
post_profiles_id_updates_reorder_mediaTypeExtension
Reorder the statuses for profile id_48291 with media type extension standard.
[{"type": "function", "function": {"name": "post_profiles_id_updates_reorder_mediaTypeExtension", "description": "Edit the order at which statuses for the specified social media profile will be sent out of the buffer.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": ""}, "mediaT...
{"name": "post_profiles_id_updates_reorder_mediaTypeExtension", "arguments": {"id": "id_48291", "mediaTypeExtension": "standard"}}
create
medium
dev
Reorder the statuses for profile id_48291 with media type extension standard.
true
Using the Bufferapp API, edit the order at which statuses for the specified social media profile will be sent out of the buffer with id=example, mediaTypeExtension=example.
fc-002733
Bufferapp
get_profiles_id_updates_sent_mediaTypeExtension
Return sent buffer updates for social media profile id_48291 with media type extension standard.
[{"type": "function", "function": {"name": "get_profiles_id_updates_sent_mediaTypeExtension", "description": "Returns an array of updates that have been sent from the buffer for an individual social media profile.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": ""}, "mediaTypeE...
{"name": "get_profiles_id_updates_sent_mediaTypeExtension", "arguments": {"id": "id_48291", "mediaTypeExtension": "standard"}}
retrieve
medium
dev
Return sent buffer updates for social media profile id_48291 with media type extension standard.
true
Using the Bufferapp API, returns an array of updates that have been sent from the buffer for an individual social media profile with id=example, mediaTypeExtension=example.
fc-002734
Bufferapp
post_profiles_id_updates_shuffle_mediaTypeExtension
Shuffle the order of statuses for profile id_48291 with media type extension standard.
[{"type": "function", "function": {"name": "post_profiles_id_updates_shuffle_mediaTypeExtension", "description": "Randomize the order at which statuses for the specified social media profile will be sent out of the buffer.", "parameters": {"type": "object", "properties": {"id": {"type": "string", "description": ""}, "m...
{"name": "post_profiles_id_updates_shuffle_mediaTypeExtension", "arguments": {"id": "id_48291", "mediaTypeExtension": "standard"}}
create
medium
dev
Shuffle the order of statuses for profile id_48291 with media type extension standard.
true
Using the Bufferapp API, randomize the order at which statuses for the specified social media profile will be sent out of the buffer with id=example, mediaTypeExtension=example.
fc-002735
Bufferapp
get_profiles_id_mediaTypeExtension
Return details of social media profile id_48291 using media type extension standard.
[{"type": "function", "function": {"name": "get_profiles_id_mediaTypeExtension", "description": "Returns details of the single specified social media profile.", "parameters": {"type": "object", "properties": {"mediaTypeExtension": {"type": "string", "description": ""}, "id": {"type": "string", "description": ""}}, "req...
{"name": "get_profiles_id_mediaTypeExtension", "arguments": {"mediaTypeExtension": "standard", "id": "id_48291"}}
retrieve
medium
dev
Return details of social media profile id_48291 using media type extension standard.
true
Using the Bufferapp API, returns details of the single specified social media profile with mediaTypeExtension=example, id=example.
fc-002736
Bufferapp
get_profiles_mediaTypeExtension
Return the array of social media profiles connected to my account with media type extension standard.
[{"type": "function", "function": {"name": "get_profiles_mediaTypeExtension", "description": "Returns an array of social media profiles connected to a users account.", "parameters": {"type": "object", "properties": {"mediaTypeExtension": {"type": "string", "description": ""}}, "required": ["mediaTypeExtension"]}}}, {"t...
{"name": "get_profiles_mediaTypeExtension", "arguments": {"mediaTypeExtension": "standard"}}
retrieve
easy
dev
Return the array of social media profiles connected to my account with media type extension standard.
true
Using the Bufferapp API, returns an array of social media profiles connected to a users account with mediaTypeExtension=example.