Dataset Viewer
id
int64 0
30k
| tools
stringlengths 1.42k
24k
|
|---|---|
0 | {"simple_note": [{"api_name": "verify_account", "description": "Verify your account using the verification code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "verification_code", "type": "string", "required": true, "description": "The verification code sent to your email address.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_profile", "description": "Show public profile information of a user.", "parameters": [{"name": "email", "type": "string", "required": false, "description": "Email of the person you want to see the profile information of.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "search_notes", "description": "Search your notes. This will not show contents of the notes. Pinned notes will be shown first by default, except when dont_reorder_pinned is true.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "Search query for the notes.", "default": "", "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Tags to filter the notes by. Notes not having any of these tags will be filtered out.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Filter notes by pinned status.", "default": null, "constraints": []}, {"name": "dont_reorder_pinned", "type": "boolean", "required": false, "description": "If true, pinned notes will not be reordered to be shown at the top.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the notes by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at and updated_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page. If both query and sort_by are not given, null, or empty, sort_by will default to -updated_at.", "default": null, "constraints": []}], "response_schemas": {"success": [{"note_id": 1, "title": "string", "tags": ["string"], "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "pinned": true}], "failure": {"message": "string"}}}, {"api_name": "show_note", "description": "Show detailed information of a note, including its content.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to be shown.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"note_id": 1, "title": "string", "content": "string", "tags": ["string"], "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "pinned": true}, "failure": {"message": "string"}}}], "file_system": [{"api_name": "move_file", "description": "Move a file to another location.", "parameters": [{"name": "source_file_path", "type": "string", "required": true, "description": "Path of the source file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_file_path", "type": "string", "required": true, "description": "Path of the destination file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the file if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the moved file should retain the original file's created and updated dates.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_file_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "copy_file", "description": "Copy a file to another location.", "parameters": [{"name": "source_file_path", "type": "string", "required": true, "description": "Path of the source file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_file_path", "type": "string", "required": true, "description": "Path of the destination file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the file if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the copied file should retain the original file's created and updated dates.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_file_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "directory_exists", "description": "Check if a directory exists.", "parameters": [{"name": "directory_path", "type": "string", "required": true, "description": "Path of the directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"exists": true}, "failure": {"message": "string"}}}, {"api_name": "decompress_file", "description": "Decompress a compressed file.", "parameters": [{"name": "compressed_file_path", "type": "string", "required": true, "description": "Path of the compressed file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. Must have an extension: zip or tar.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "decompressed_directory_path", "type": "string", "required": false, "description": "Path of the directory to save decompressed files. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If not passed, it'll be saved in the same directory as the compressed file.", "default": null, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the decompressed files should retain the created and updated dates of the files in the compressed file.", "default": true, "constraints": []}, {"name": "delete_compressed_file", "type": "boolean", "required": false, "description": "Whether to delete the compressed file after decompression.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "decompressed_directory_path": "string"}, "failure": {"message": "string"}}}]} |
1 | {"splitwise": [{"api_name": "show_notifications", "description": "Get a list of your notifications.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter notifications by read status. Will skip filtering if not passed.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"notification_id": 1, "type": "expense_added", "title": "string", "message": "string", "read": true, "created_at": "2019-01-01T00:00:00", "data": {}}], "failure": {"message": "string"}}}, {"api_name": "logout", "description": "Logout from your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "mark_notifications", "description": "Mark all notifications as read or unread.", "parameters": [{"name": "read", "type": "boolean", "required": true, "description": "Read status of the notification.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_expense", "description": "Mark the expense you are involved in as deleted. Anyone involved in the expense or a member of its group can undelete it later.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_payment_comments", "description": "Get a list of payment comments.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"payment_comment_id": 1, "payment_id": 1, "comment": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}], "gmail": [{"api_name": "send_email", "description": "Send a new email to one or more recipients.", "parameters": [{"name": "email_addresses", "type": "list[string]", "required": true, "description": "List of recipient email addresses.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": true, "description": "The subject of the email.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": true, "description": "The body of the email.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "attachment_file_paths", "type": "list[string]", "required": false, "description": "List of absolute file paths (starting with /) from the file_system app to attach to the email.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login. Only needed for attachments.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "sent_email_thread_id": 1, "sent_email_id": 1}, "failure": {"message": "string"}}}, {"api_name": "mark_thread_spam", "description": "Mark an email thread as spam.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to mark as spam.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "label_thread", "description": "Label an email thread.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to label.", "default": null, "constraints": []}, {"name": "label", "type": "string", "required": true, "description": "The label to assign to the email thread.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_email_from_draft", "description": "Send a new email from a draft right away.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to send.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login. Only needed if draft has attachments.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "sent_email_thread_id": 1, "sent_email_id": 1}, "failure": {"message": "string"}}}]} |
2 | {"simple_note": [{"api_name": "create_note", "description": "Create a new note.", "parameters": [{"name": "title", "type": "string", "required": true, "description": "Title of the note", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": true, "description": "Content of the note", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Pinned status of the note.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "note_id": 1}, "failure": {"message": "string"}}}, {"api_name": "signup", "description": "Sign up to create account.", "parameters": [{"name": "first_name", "type": "string", "required": true, "description": "Your first name", "default": null, "constraints": ["length >= 1"]}, {"name": "last_name", "type": "string", "required": true, "description": "Your last name", "default": null, "constraints": ["length >= 1"]}, {"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password", "type": "string", "required": true, "description": "Your password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_note", "description": "Delete a note.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to be deleted.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "verify_account", "description": "Verify your account using the verification code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "verification_code", "type": "string", "required": true, "description": "The verification code sent to your email address.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "splitwise": [{"api_name": "verify_account", "description": "Verify your account using the verification code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "verification_code", "type": "string", "required": true, "description": "The verification code sent to your email address.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "record_payment", "description": "Record a new payment for an expense. This only records payment on splitwise and does not move real money.", "parameters": [{"name": "payer_email", "type": "string", "required": true, "description": "Email of the user who made the payment.", "default": null, "constraints": ["value is email address"]}, {"name": "receiver_email", "type": "string", "required": true, "description": "Email of the user who received the payment.", "default": null, "constraints": ["value is email address"]}, {"name": "amount", "type": "number", "required": true, "description": "The amount of the payment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "group_id", "type": "integer", "required": false, "description": "The ID of the group to record the payment in.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "A short note or description of the payment.", "default": null, "constraints": []}, {"name": "receipt_file_path", "type": "string", "required": false, "description": "Receipt file path to attach as an evidence of this payment made (e.g., snapshot of bank transfer, venmo, etc.)", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login. Only needed for attaching receipt file.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_id": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_expense_comment", "description": "Delete a comment you posted on an expense.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the expense comment to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "mark_notifications", "description": "Mark all notifications as read or unread.", "parameters": [{"name": "read", "type": "boolean", "required": true, "description": "Read status of the notification.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "post_payment_comment", "description": "Create a new payment comment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment.", "default": null, "constraints": []}, {"name": "comment", "type": "string", "required": true, "description": "The comment for the payment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_comment_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_payment_comments", "description": "Get a list of payment comments.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"payment_comment_id": 1, "payment_id": 1, "comment": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "download_payment_receipt_file", "description": "Download receipt file attachment for a payment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to download receipt for.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "download_to_file_path", "type": "string", "required": false, "description": "The file path to download the receipt file to in file system app. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If not passed, it will be saved in your ~/downloads directory.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the file if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "file_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_group", "description": "Show group details based on its ID.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"group_id": 1, "name": "string", "description": "string", "created_at": "2019-01-01T00:00:00", "deleted": true, "creator": {"name": "string", "email": "[email protected]"}, "members": [{"name": "string", "email": "[email protected]"}], "invitation_code": "string"}, "failure": {"message": "string"}}}, {"api_name": "post_expense_comment", "description": "Post a a comment on an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense.", "default": null, "constraints": []}, {"name": "comment", "type": "string", "required": true, "description": "The comment for the expense.", "default": null, "constraints": ["length >= 1, <= 1000"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "expense_comment_id": 1}, "failure": {"message": "string"}}}, {"api_name": "settle_up", "description": "Settle up outstanding balance with a user in a group. This only records payment on splitwise and does not move real money.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "The email of the user to settle balance with.", "default": null, "constraints": ["value is email address"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "group_id", "type": "integer", "required": false, "description": "The ID of the group to settle balance.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the payment.", "default": "Settle up balance.", "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
3 | {"amazon": [{"api_name": "add_gift_wrapping_to_product", "description": "Add gift wrapping to a product in your cart. If the product is already set to be gift wrapped, its quantity will be updated.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product in your cart to be gift wrapped.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": false, "description": "Quantity of the product to be gift wrapped.", "default": 1, "constraints": ["value >= 1.0"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "add_payment_card", "description": "Add a new payment card.", "parameters": [{"name": "card_name", "type": "string", "required": true, "description": "Name of the payment card.", "default": null, "constraints": ["length >= 1"]}, {"name": "owner_name", "type": "string", "required": true, "description": "Full name of the owner of the payment card.", "default": null, "constraints": ["length >= 1"]}, {"name": "card_number", "type": "integer", "required": true, "description": "16-digit card number.", "default": null, "constraints": ["value >= 1000000000000000.0, < 1e+16"]}, {"name": "expiry_year", "type": "integer", "required": true, "description": "Expiration year of the payment card.", "default": null, "constraints": []}, {"name": "expiry_month", "type": "integer", "required": true, "description": "Expiration month of the payment card.", "default": null, "constraints": ["value >= 1.0, <= 12.0"]}, {"name": "cvv_number", "type": "integer", "required": true, "description": "A 3-digit CVV number of the payment card.", "default": null, "constraints": ["value >= 100.0, < 1000.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_card_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_seller", "description": "Show a detailed information about the seller.", "parameters": [{"name": "seller_id", "type": "integer", "required": true, "description": "The ID of the seller.", "default": null, "constraints": []}], "response_schemas": {"success": {"seller_id": 1, "name": "string", "rating": 0.0}, "failure": {"message": "string"}}}], "gmail": [{"api_name": "send_email_from_draft", "description": "Send a new email from a draft right away.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to send.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login. Only needed if draft has attachments.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "sent_email_thread_id": 1, "sent_email_id": 1}, "failure": {"message": "string"}}}, {"api_name": "download_attachment", "description": "Download a file attachment.", "parameters": [{"name": "attachment_id", "type": "integer", "required": true, "description": "The ID of the attachment to download.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "download_to_file_path", "type": "string", "required": false, "description": "The file path to download the attachment to in file system app. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If not passed, it will be saved in your ~/downloads directory.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the file if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "file_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_draft", "description": "Show detailed draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to show.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"draft_id": 1, "subject": "string", "body": "string", "belongs_to_email_thread_id": 1, "response_to_email_id": 1, "scheduled_send_at": "2019-01-01T00:00:00", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "recipients": [{"name": "string", "email": "[email protected]"}], "attachments": [{"id": 1, "file_name": "string"}]}, "failure": {"message": "string"}}}, {"api_name": "forward_email_thread", "description": "Forward entire email thread to one or more recipients.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to forward.", "default": null, "constraints": []}, {"name": "email_addresses", "type": "list[string]", "required": true, "description": "List of recipient email addresses.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "draft_not_send", "type": "boolean", "required": false, "description": "If true, the email will be saved as a draft instead of being sent. This way it can be edited before sending.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "sent_email_thread_id": 1, "sent_email_id": 1, "draft_id": 1}, "failure": {"message": "string"}}}, {"api_name": "mark_thread_unread", "description": "Mark an email thread as unread.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to mark as unread.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_thread", "description": "Show detailed information about a given email thread, including emails and drafts within it.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to show.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"email_thread_id": 1, "incoming": true, "outgoing": true, "read": true, "label": "string", "starred": true, "archived": true, "spam": true, "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "emails": [{"email_id": 1, "subject": "string", "sender": {"name": "string", "email": "[email protected]"}, "recipients": [{"name": "string", "email": "[email protected]"}], "body": "string", "attachments": [{"id": 1, "file_name": "string"}], "created_at": "2019-01-01T00:00:00"}], "drafts": [{"draft_id": 1, "response_to_email_id": 1, "subject": "string", "recipients": [{"name": "string", "email": "[email protected]"}], "body": "string", "attachments": [{"id": 1, "file_name": "string"}], "scheduled_send_at": "2019-01-01T00:00:00", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00"}]}, "failure": {"message": "string"}}}]} |
4 | {"phone": [{"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "Your phone number.", "default": null, "constraints": []}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your phone number.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_alarm", "description": "Update an alarm's settings.", "parameters": [{"name": "alarm_id", "type": "integer", "required": true, "description": "ID of the alarm to be updated.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "time", "type": "string", "required": false, "description": "The updated time of the alarm in HH:MM format.", "default": null, "constraints": []}, {"name": "repeat_days", "type": "list[string]", "required": false, "description": "The updated days on which the alarm should repeat.", "default": null, "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The updated label for the alarm.", "default": null, "constraints": []}, {"name": "enabled", "type": "boolean", "required": false, "description": "Whether the alarm is enabled or not.", "default": null, "constraints": []}, {"name": "snooze_minutes", "type": "integer", "required": false, "description": "The updated duration of snooze in minutes. Use 0 for no snooze.", "default": null, "constraints": ["value >= 0.0"]}, {"name": "vibration", "type": "boolean", "required": false, "description": "Whether the alarm should vibrate or not.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_text_message_window", "description": "Show text messages with a contact around a given date and time.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "min_datetime", "type": "string", "required": false, "description": "The minimum datetime to show messages on or after in YYYY-MM-DD|HH:MM:SS format.", "default": "1500-01-01|00:00:00", "constraints": []}, {"name": "max_datetime", "type": "string", "required": false, "description": "The maximum datetime to show messages on or before in YYYY-MM-DD|HH:MM:SS format.", "default": "3000-01-01|00:00:00", "constraints": []}, {"name": "pagination_order", "type": "string", "required": false, "description": "If set to ascending, as page_index increases, the results will have newer messages. If set to descending, as page_index increases, the results will have older messages. The messages within each page will always be oldest to newest.", "default": "descending", "constraints": ["value in ['ascending', 'descending']"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"text_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "show_voice_message_window", "description": "Show voice messages with a contact around a given date and time.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "min_datetime", "type": "string", "required": false, "description": "The minimum datetime to show messages on or after in YYYY-MM-DD|HH:MM:SS format.", "default": "1500-01-01|00:00:00", "constraints": []}, {"name": "max_datetime", "type": "string", "required": false, "description": "The maximum datetime to show messages on or before in YYYY-MM-DD|HH:MM:SS format.", "default": "3000-01-01|00:00:00", "constraints": []}, {"name": "pagination_order", "type": "string", "required": false, "description": "If set to ascending, as page_index increases, the results will have newer messages. If set to descending, as page_index increases, the results will have older messages. The messages within each page will always be oldest to newest.", "default": "descending", "constraints": ["value in ['ascending', 'descending']"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"voice_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}], "venmo": [{"api_name": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your email address.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_payment_card", "description": "Get details of a payment card.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to be shown.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"payment_card_id": 1, "card_name": "string", "owner_name": "string", "card_number": 1000000000000000.0, "expiry_year": 1, "expiry_month": 1.0, "cvv_number": 100.0}, "failure": {"message": "string"}}}, {"api_name": "show_transactions", "description": "Get a list of your transactions.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "Search query string.", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "If passed, only transactions between you and user with this email address will be shown.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Minimum created_at datetime to filter transactions in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Maximum created_at datetime to filter transactions in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "min_like_count", "type": "integer", "required": false, "description": "Minimum like count to filter transactions.", "default": 0, "constraints": []}, {"name": "max_like_count", "type": "integer", "required": false, "description": "Maximum like count to filter transactions.", "default": 9223372036854775807, "constraints": []}, {"name": "min_amount", "type": "number", "required": false, "description": "Minimum amount to filter transactions.", "default": 0.01, "constraints": ["value > 0.0"]}, {"name": "max_amount", "type": "number", "required": false, "description": "Maximum amount to filter transactions.", "default": 9223372036854775807, "constraints": ["value > 0.0"]}, {"name": "private", "type": "boolean", "required": false, "description": "Filter transactions by privacy.", "default": null, "constraints": []}, {"name": "direction", "type": "string", "required": false, "description": "Filter transactions by direction of the transaction (sent or received). Will skip filtering if not passed.", "default": null, "constraints": ["value in ['sent', 'received']"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the transactions by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at, like_count and amount. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page.", "default": null, "constraints": []}], "response_schemas": {"success": [{"transaction_id": 1, "amount": 0.0, "description": "string", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "private": true, "like_count": 1, "payment_card_digits": "string", "comment_count": 1, "sender": {"name": "string", "email": "[email protected]"}, "receiver": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}]} |
5 | {"splitwise": [{"api_name": "delete_notifications", "description": "Delete all of your notifications.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "undelete_payment", "description": "Restore a previously deleted payment you are involved in.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "file_system": [{"api_name": "show_directory", "description": "Show a list of files and/or sub-directories, optionally recursively, in a directory.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "directory_path", "type": "string", "required": false, "description": "Path of the directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": "/", "constraints": ["length >= 1"]}, {"name": "substring", "type": "string", "required": false, "description": "If passed, only files and sub-directories containing the given substring (ignoring case) will be shown.", "default": null, "constraints": []}, {"name": "entry_type", "type": "string", "required": false, "description": "Whether to show all files and sub-directories, only files, or only sub-directories.", "default": "all", "constraints": ["value in ['all', 'files', 'directories']"]}, {"name": "recursive", "type": "boolean", "required": false, "description": "Whether to show files recursively.", "default": true, "constraints": []}], "response_schemas": {"success": ["string"], "failure": {"message": "string"}}}, {"api_name": "decompress_file", "description": "Decompress a compressed file.", "parameters": [{"name": "compressed_file_path", "type": "string", "required": true, "description": "Path of the compressed file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. Must have an extension: zip or tar.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "decompressed_directory_path", "type": "string", "required": false, "description": "Path of the directory to save decompressed files. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If not passed, it'll be saved in the same directory as the compressed file.", "default": null, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the decompressed files should retain the created and updated dates of the files in the compressed file.", "default": true, "constraints": []}, {"name": "delete_compressed_file", "type": "boolean", "required": false, "description": "Whether to delete the compressed file after decompression.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "decompressed_directory_path": "string"}, "failure": {"message": "string"}}}]} |
6 | {"spotify": [{"api_name": "add_album_to_library", "description": "Add an album to the user's album library.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to add.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_payment_cards", "description": "Get a list of users payment cards.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"payment_card_id": 1, "card_name": "string", "owner_name": "string", "card_number": 1000000000000000.0, "expiry_year": 1, "expiry_month": 1.0, "cvv_number": 100.0}], "failure": {"message": "string"}}}], "phone": [{"api_name": "login", "description": "Login to your account.", "parameters": [{"name": "username", "type": "string", "required": true, "description": "Your account phone_number.", "default": null, "constraints": []}, {"name": "password", "type": "string", "required": true, "description": "Your account password.", "default": null, "constraints": []}], "response_schemas": {"success": {"access_token": "string", "token_type": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_voice_message_window", "description": "Show voice messages with a contact around a given date and time.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "min_datetime", "type": "string", "required": false, "description": "The minimum datetime to show messages on or after in YYYY-MM-DD|HH:MM:SS format.", "default": "1500-01-01|00:00:00", "constraints": []}, {"name": "max_datetime", "type": "string", "required": false, "description": "The maximum datetime to show messages on or before in YYYY-MM-DD|HH:MM:SS format.", "default": "3000-01-01|00:00:00", "constraints": []}, {"name": "pagination_order", "type": "string", "required": false, "description": "If set to ascending, as page_index increases, the results will have newer messages. If set to descending, as page_index increases, the results will have older messages. The messages within each page will always be oldest to newest.", "default": "descending", "constraints": ["value in ['ascending', 'descending']"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"voice_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "delete_contact", "description": "Delete contact information.", "parameters": [{"name": "contact_id", "type": "integer", "required": true, "description": "ID of the contact to be deleted.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
7 | {"spotify": [{"api_name": "search_artists", "description": "Search for artists with a query.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "genre", "type": "string", "required": false, "description": "The genre to filter the artists by.", "default": null, "constraints": []}, {"name": "min_follower_count", "type": "integer", "required": false, "description": "The minimum number of followers for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_follower_count", "type": "integer", "required": false, "description": "The maximum number of followers for search results.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the artists by prefixed with +/- to reflect ascending/descending. Valid attributes: follower_count. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page.", "default": null, "constraints": []}], "response_schemas": {"success": [{"artist_id": 1, "name": "string", "genre": "string", "follower_count": 1, "created_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "show_liked_playlists", "description": "Get a list of playlists you have liked.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the liked playlists by prefixed with +/- to reflect ascending/descending. Valid attributes: liked_at and title.", "default": "-liked_at", "constraints": []}], "response_schemas": {"success": [{"playlist_id": 1, "title": "string", "is_public": true, "rating": 0.0, "like_count": 1, "review_count": 1, "owner": {"name": "string", "email": "[email protected]"}, "created_at": "2019-01-01T00:00:00", "song_ids": [1], "liked_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "add_payment_card", "description": "Add a new payment card.", "parameters": [{"name": "card_name", "type": "string", "required": true, "description": "Name of the payment card.", "default": null, "constraints": ["length >= 1"]}, {"name": "owner_name", "type": "string", "required": true, "description": "Full name of the owner of the payment card.", "default": null, "constraints": ["length >= 1"]}, {"name": "card_number", "type": "integer", "required": true, "description": "16-digit card number.", "default": null, "constraints": ["value >= 1000000000000000.0, < 1e+16"]}, {"name": "expiry_year", "type": "integer", "required": true, "description": "Expiration year of the payment card.", "default": null, "constraints": []}, {"name": "expiry_month", "type": "integer", "required": true, "description": "Expiration month of the payment card.", "default": null, "constraints": ["value >= 1.0, <= 12.0"]}, {"name": "cvv_number", "type": "integer", "required": true, "description": "A 3-digit CVV number of the payment card.", "default": null, "constraints": ["value >= 100.0, < 1000.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_card_id": 1}, "failure": {"message": "string"}}}, {"api_name": "update_playlist_review", "description": "Update a playlist review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the playlist review.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": false, "description": "Playlist rating for this review.", "default": null, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "title", "type": "string", "required": false, "description": "Title of the review.", "default": null, "constraints": []}, {"name": "text", "type": "string", "required": false, "description": "Text content of the review.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "like_album", "description": "Like a album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to like.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_song_review", "description": "Show a song review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "The song review id to retrieve.", "default": null, "constraints": []}], "response_schemas": {"success": {"song_review_id": 1, "song_id": 1, "rating": 1.0, "title": "string", "text": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}, {"api_name": "review_song", "description": "Rate or review a song.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "ID of the song to review.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": true, "description": "Song rating for this review.", "default": null, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "Title of the review.", "default": "", "constraints": []}, {"name": "text", "type": "string", "required": false, "description": "Text content of the review.", "default": "", "constraints": []}], "response_schemas": {"success": {"message": "string", "song_review_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_payment_cards", "description": "Get a list of users payment cards.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"payment_card_id": 1, "card_name": "string", "owner_name": "string", "card_number": 1000000000000000.0, "expiry_year": 1, "expiry_month": 1.0, "cvv_number": 100.0}], "failure": {"message": "string"}}}, {"api_name": "set_volume", "description": "Set the volume level of the music player.", "parameters": [{"name": "volume", "type": "integer", "required": true, "description": "Volume level to set.", "default": null, "constraints": ["value >= 0.0, <= 10.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_album_library", "description": "Get a list of albums in the user's album library.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"album_id": 1, "title": "string", "genre": "string", "artists": [{"id": 1, "name": "string"}], "rating": 0.0, "like_count": 1, "review_count": 1, "release_date": "2019-01-01T00:00:00", "song_ids": [1], "added_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "send_verification_code", "description": "Send account verification code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "file_system": [{"api_name": "decompress_file", "description": "Decompress a compressed file.", "parameters": [{"name": "compressed_file_path", "type": "string", "required": true, "description": "Path of the compressed file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. Must have an extension: zip or tar.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "decompressed_directory_path", "type": "string", "required": false, "description": "Path of the directory to save decompressed files. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If not passed, it'll be saved in the same directory as the compressed file.", "default": null, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the decompressed files should retain the created and updated dates of the files in the compressed file.", "default": true, "constraints": []}, {"name": "delete_compressed_file", "type": "boolean", "required": false, "description": "Whether to delete the compressed file after decompression.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "decompressed_directory_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "compress_directory", "description": "Compress a directory.", "parameters": [{"name": "directory_path", "type": "string", "required": true, "description": "Path of the directory to compress. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "compressed_file_path", "type": "string", "required": false, "description": "Path of the compressed file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If passed, must have an extension: zip or tar. If not passed, it'll be stored as a zip file with the base name of directory_path in directory_path's parent directory.", "default": null, "constraints": []}, {"name": "delete_directory", "type": "boolean", "required": false, "description": "Whether to delete the directory after compression.", "default": false, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the compressed file if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "compressed_file_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "file_exists", "description": "Check if a file exists.", "parameters": [{"name": "file_path", "type": "string", "required": true, "description": "Path of the file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"exists": true}, "failure": {"message": "string"}}}]} |
8 | {"todoist": [{"api_name": "update_project", "description": "Update project information.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project. You can use 0 for your Inbox project.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "name", "type": "string", "required": false, "description": "The updated name of the project.", "default": null, "constraints": ["length >= 1"]}, {"name": "color", "type": "string", "required": false, "description": "The updated color of the project.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the project.", "default": null, "constraints": []}, {"name": "is_favorite", "type": "boolean", "required": false, "description": "Whether the project is marked as favorite.", "default": null, "constraints": []}, {"name": "is_archived", "type": "boolean", "required": false, "description": "Whether the project is marked as archived.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_verification_code", "description": "Send account verification code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "search_users", "description": "Search Todoist users by name or email address.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "Search query string.", "default": "", "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "verify_account", "description": "Verify your account using the verification code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "verification_code", "type": "string", "required": true, "description": "The verification code sent to your email address.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_tasks", "description": "Get a list of tasks within a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project. You can use 0 for your Inbox project.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "section_id", "type": "integer", "required": false, "description": "The ID of the section to filter tasks by. Set it to 0 for tasks without a section.", "default": null, "constraints": []}, {"name": "assignee_email", "type": "string", "required": false, "description": "Email address of the assignee to filter tasks by.", "default": null, "constraints": ["value is email address"]}, {"name": "assigner_email", "type": "string", "required": false, "description": "Email address of the assigner to filter tasks by.", "default": null, "constraints": ["value is email address"]}, {"name": "priority", "type": "string", "required": false, "description": "The priority to filter tasks by.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "Completion status to filter by.", "default": null, "constraints": []}, {"name": "due_today", "type": "boolean", "required": false, "description": "If true, only tasks due today will be returned. If false, all tasks will be returned.", "default": false, "constraints": []}, {"name": "label_id", "type": "integer", "required": false, "description": "The ID of the label to filter tasks by.", "default": null, "constraints": []}, {"name": "overdue", "type": "boolean", "required": false, "description": "If true, only tasks that are overdue will be returned. If false, all tasks will be returned.", "default": false, "constraints": []}, {"name": "min_due_date", "type": "string", "required": false, "description": "Only tasks with a due date greater than or equal to this date will be returned. Date should be in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_due_date", "type": "string", "required": false, "description": "Only tasks with a due date less than or equal to this date will be returned. Date should be in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the tasks by prefixed with +/- to reflect ascending/descending. Valid attributes: order_index, due_date and priority.", "default": "+order_index", "constraints": []}], "response_schemas": {"success": {"project_id": 1, "no_section_tasks": [{"order_index": 1, "task_id": 1, "title": "string", "description": "string", "num_sub_tasks": 1, "is_completed": true, "due_date": "2019-01-01T00:00:00", "priority": "high", "duration": 0.0, "duration_unit": "minutes", "assignee_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}]}], "sections": [{"section_id": 1, "tasks": [{"order_index": 1, "task_id": 1, "title": "string", "description": "string", "num_sub_tasks": 1, "is_completed": true, "due_date": "2019-01-01T00:00:00", "priority": "high", "duration": 0.0, "duration_unit": "minutes", "assignee_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}]}]}]}, "failure": {"message": "string"}}}, {"api_name": "show_account", "description": "Show your account information. Unlike show_profile, this includes private information.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00", "last_logged_in": "2019-01-01T00:00:00", "verified": true}, "failure": {"message": "string"}}}], "spotify": [{"api_name": "show_song_queue", "description": "Get the music player song queue. Songs are played in the order of the queue in a cycle.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "position": 1, "is_playing": true, "is_current": true}], "failure": {"message": "string"}}}, {"api_name": "remove_song_from_library", "description": "Remove a song from the user's song library.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song id to remove.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "add_song_to_playlist", "description": "Add a song to a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to add the song to.", "default": null, "constraints": []}, {"name": "song_id", "type": "integer", "required": true, "description": "The song id to add.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_premium_subscriptions", "description": "Show your premium subscription history.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"premium_subscription_id": 1, "start_date": "2019-01-01T00:00:00", "end_date": "2019-01-01T00:00:00", "payment_card_digits": "string", "paid_amount": 0.0}], "failure": {"message": "string"}}}, {"api_name": "download_song", "description": "Download a song.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song id to download.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
9 | {"phone": [{"api_name": "create_alarm", "description": "Create a new alarm.", "parameters": [{"name": "time", "type": "string", "required": true, "description": "The time of the alarm in HH:MM format.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "repeat_days", "type": "list[string]", "required": false, "description": "Days on which the alarm repeats.", "default": null, "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label for the alarm.", "default": null, "constraints": []}, {"name": "enabled", "type": "boolean", "required": false, "description": "Whether the alarm is enabled or not.", "default": true, "constraints": []}, {"name": "snooze_minutes", "type": "integer", "required": false, "description": "The duration of snooze in minutes. Use 0 for no snooze.", "default": 15, "constraints": ["value >= 0.0"]}, {"name": "vibration", "type": "boolean", "required": false, "description": "Whether the alarm should vibrate or not.", "default": true, "constraints": []}], "response_schemas": {"success": {"message": "string", "alarm_id": 1}, "failure": {"message": "string"}}}, {"api_name": "search_text_messages", "description": "Show or search your text messages.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "phone_number", "type": "string", "required": false, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "only_latest_per_contact", "type": "boolean", "required": false, "description": "If set to true, only the latest message from each contact will be shown.", "default": false, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the messages by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page. If both query and sort_by are not given, null, or empty, sort_by will default to -created_at.", "default": null, "constraints": []}], "response_schemas": {"success": [{"text_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "get_current_date_and_time", "description": "Show current date and time.", "parameters": [], "response_schemas": {"success": {"date": "string", "time": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_voice_message", "description": "Send a voice message on the given phone number.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to send the voice message to.", "default": null, "constraints": []}, {"name": "message", "type": "string", "required": true, "description": "The message text of the voice_message.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "voice_message_id": 1}, "failure": {"message": "string"}}}, {"api_name": "send_password_reset_code", "description": "Send password reset code to your phone number.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "Your phone number.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_profile", "description": "Show public profile information of a user.", "parameters": [{"name": "phone_number", "type": "string", "required": false, "description": "Phone number of the person you want to see the profile information of.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "phone_number": "string", "registered_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "show_account", "description": "Show your account information. Unlike show_profile, this includes private information.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "phone_number": "string", "registered_at": "2019-01-01T00:00:00", "last_logged_in": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}], "simple_note": [{"api_name": "show_account", "description": "Show your account information. Unlike show_profile, this includes private information.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00", "last_logged_in": "2019-01-01T00:00:00", "verified": true}, "failure": {"message": "string"}}}, {"api_name": "delete_note", "description": "Delete a note.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to be deleted.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_note", "description": "Create a new note.", "parameters": [{"name": "title", "type": "string", "required": true, "description": "Title of the note", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": true, "description": "Content of the note", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Pinned status of the note.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "note_id": 1}, "failure": {"message": "string"}}}]} |
10 | {"todoist": [{"api_name": "show_sub_tasks", "description": "Get a list of sub_tasks within a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"task_id": 1, "title": "string", "description": "string", "due_date": "2019-01-01T00:00:00", "priority": "high", "is_completed": true, "duration": 0.0, "duration_unit": "minutes", "order_index": 0.0, "created_at": "2019-01-01T00:00:00", "sub_task_id": 1}], "failure": {"message": "string"}}}, {"api_name": "post_task_comment", "description": "Post a comment on a task, optionally with a file attachment.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "content", "type": "string", "required": true, "description": "The content of the comment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "attachment_file_paths", "type": "list[string]", "required": false, "description": "Paths to files to be attached in this comment.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login. Only needed if comment has a file attachment.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "task_comment_id": 1}, "failure": {"message": "string"}}}], "file_system": [{"api_name": "logout", "description": "Logout from your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "move_file", "description": "Move a file to another location.", "parameters": [{"name": "source_file_path", "type": "string", "required": true, "description": "Path of the source file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_file_path", "type": "string", "required": true, "description": "Path of the destination file. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the file if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the moved file should retain the original file's created and updated dates.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_file_path": "string"}, "failure": {"message": "string"}}}]} |
11 | {"amazon": [{"api_name": "show_product_questions", "description": "Get a list of product questions.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to show questions for.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "Email of the user who posted the question", "default": null, "constraints": ["value is email address"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the questions by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page.", "default": null, "constraints": []}], "response_schemas": {"success": [{"product_id": 1, "question_id": 1, "question": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "show_account", "description": "Show your account information. Unlike show_profile, this includes private information.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00", "last_logged_in": "2019-01-01T00:00:00", "verified": true, "is_prime": true}, "failure": {"message": "string"}}}, {"api_name": "login", "description": "Login to your account.", "parameters": [{"name": "username", "type": "string", "required": true, "description": "Your account email.", "default": null, "constraints": []}, {"name": "password", "type": "string", "required": true, "description": "Your account password.", "default": null, "constraints": []}], "response_schemas": {"success": {"access_token": "string", "token_type": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_prime_subscriptions", "description": "Show your prime subscription history.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"prime_subscription_id": 1, "start_date": "2019-01-01T00:00:00", "end_date": "2019-01-01T00:00:00", "payment_card_digits": "string", "paid_amount": 0.0}], "failure": {"message": "string"}}}, {"api_name": "subscribe_prime", "description": "Subscribe to prime membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy prime subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the prime subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "prime_subscription_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_return", "description": "Show product return status.", "parameters": [{"name": "return_id", "type": "integer", "required": true, "description": "ID of the product return.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"return_id": 1, "order_id": 1, "product_id": 1, "product_name": "string", "quantity": 1.0, "deliverer_id": 1, "deliverer_name": "UPS", "refund_amount": 0.0, "initiated_at": "2019-01-01T00:00:00", "returned_at": "2019-01-01T00:00:00", "confirmation_code": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_addresses", "description": "Get a list of your addresses.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": [{"address_id": 1, "name": "string", "street_address": "string", "city": "string", "state": "string", "country": "string", "zip_code": 10000.0}], "failure": {"message": "string"}}}, {"api_name": "send_password_reset_code", "description": "Send password reset code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "simple_note": [{"api_name": "add_content_to_note", "description": "Append or prepend content to a note.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to add content to.", "default": null, "constraints": []}, {"name": "append_or_prepend", "type": "string", "required": true, "description": "Whether to append or prepend the content.", "default": null, "constraints": ["value in ['append', 'prepend']"]}, {"name": "added_content", "type": "string", "required": true, "description": "Content to append or prepend on the note's existing content. It will add a new line between the existing content and the added content.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "search_notes", "description": "Search your notes. This will not show contents of the notes. Pinned notes will be shown first by default, except when dont_reorder_pinned is true.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "Search query for the notes.", "default": "", "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Tags to filter the notes by. Notes not having any of these tags will be filtered out.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Filter notes by pinned status.", "default": null, "constraints": []}, {"name": "dont_reorder_pinned", "type": "boolean", "required": false, "description": "If true, pinned notes will not be reordered to be shown at the top.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the notes by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at and updated_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page. If both query and sort_by are not given, null, or empty, sort_by will default to -updated_at.", "default": null, "constraints": []}], "response_schemas": {"success": [{"note_id": 1, "title": "string", "tags": ["string"], "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "pinned": true}], "failure": {"message": "string"}}}, {"api_name": "update_note", "description": "Update a note's title, content, tags, and/or pinned status.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "Updated title of the note.", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": false, "description": "Updated content of the note.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Updated tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Updated pinned status of the note.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_note", "description": "Create a new note.", "parameters": [{"name": "title", "type": "string", "required": true, "description": "Title of the note", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": true, "description": "Content of the note", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Pinned status of the note.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "note_id": 1}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your email address.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_password_reset_code", "description": "Send password reset code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
12 | {"amazon": [{"api_name": "move_product_from_wish_list_to_cart", "description": "Move product from the wish list to the cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to move to cart.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": false, "description": "Quantity of product to move to cart.", "default": 1, "constraints": ["value >= 1.0"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "write_product_question", "description": "Post a question about a product.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to ask a question about.", "default": null, "constraints": []}, {"name": "question", "type": "string", "required": true, "description": "Question to be written for the product.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "question_id": 1}, "failure": {"message": "string"}}}, {"api_name": "remove_gift_wrapping_from_product", "description": "Remove gift wrapping from a product in your cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product in your cart to be gift wrapped.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_product_reviews", "description": "Get a list of product reviews.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to show reviews for.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "Email of the user to filter reviews by.", "default": null, "constraints": ["value is email address"]}, {"name": "min_rating", "type": "integer", "required": false, "description": "The minimum rating for a review.", "default": 1, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "max_rating", "type": "integer", "required": false, "description": "The maximum rating for a review.", "default": 5, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "is_verified", "type": "boolean", "required": false, "description": "Filter reviews by whether they from a verified purchaser or not.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the product reviews by prefixed with +/- to reflect ascending/descending. Valid attributes: rating and created_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page.", "default": null, "constraints": []}], "response_schemas": {"success": [{"review_id": 1, "product_id": 1, "is_verified": true, "rating": 1.0, "title": "string", "text": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "delete_product_question", "description": "Delete a product question.", "parameters": [{"name": "question_id", "type": "integer", "required": true, "description": "ID of the question to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_product_question_answers", "description": "Get a list of answers to a product question.", "parameters": [{"name": "question_id", "type": "integer", "required": true, "description": "ID of the product question.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "Email of the user who posted the answer", "default": null, "constraints": ["value is email address"]}, {"name": "is_verified", "type": "boolean", "required": false, "description": "Filter answers by whether they from a verified purchaser or not.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the question answers by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page.", "default": null, "constraints": []}], "response_schemas": {"success": [{"question_answer_id": 1, "question_id": 1, "is_verified": true, "answer": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "delete_product_from_cart", "description": "Remove a product from your cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be deleted from the cart.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "logout", "description": "Logout from your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "simple_note": [{"api_name": "send_password_reset_code", "description": "Send password reset code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "logout", "description": "Logout from your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_account", "description": "Delete your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "login", "description": "Login to your account.", "parameters": [{"name": "username", "type": "string", "required": true, "description": "Your account email.", "default": null, "constraints": []}, {"name": "password", "type": "string", "required": true, "description": "Your account password.", "default": null, "constraints": []}], "response_schemas": {"success": {"access_token": "string", "token_type": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_note", "description": "Update a note's title, content, tags, and/or pinned status.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "Updated title of the note.", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": false, "description": "Updated content of the note.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Updated tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Updated pinned status of the note.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_verification_code", "description": "Send account verification code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
13 | {"gmail": [{"api_name": "delete_email_in_thread", "description": "Delete an email in a thread.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to delete an email from.", "default": null, "constraints": []}, {"name": "email_id", "type": "integer", "required": true, "description": "The ID of the email to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your email address.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_draft", "description": "Show detailed draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to show.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"draft_id": 1, "subject": "string", "body": "string", "belongs_to_email_thread_id": 1, "response_to_email_id": 1, "scheduled_send_at": "2019-01-01T00:00:00", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "recipients": [{"name": "string", "email": "[email protected]"}], "attachments": [{"id": 1, "file_name": "string"}]}, "failure": {"message": "string"}}}], "phone": [{"api_name": "update_alarm", "description": "Update an alarm's settings.", "parameters": [{"name": "alarm_id", "type": "integer", "required": true, "description": "ID of the alarm to be updated.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "time", "type": "string", "required": false, "description": "The updated time of the alarm in HH:MM format.", "default": null, "constraints": []}, {"name": "repeat_days", "type": "list[string]", "required": false, "description": "The updated days on which the alarm should repeat.", "default": null, "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The updated label for the alarm.", "default": null, "constraints": []}, {"name": "enabled", "type": "boolean", "required": false, "description": "Whether the alarm is enabled or not.", "default": null, "constraints": []}, {"name": "snooze_minutes", "type": "integer", "required": false, "description": "The updated duration of snooze in minutes. Use 0 for no snooze.", "default": null, "constraints": ["value >= 0.0"]}, {"name": "vibration", "type": "boolean", "required": false, "description": "Whether the alarm should vibrate or not.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "signup", "description": "Sign up to create account.", "parameters": [{"name": "first_name", "type": "string", "required": true, "description": "Your first name", "default": null, "constraints": ["length >= 1"]}, {"name": "last_name", "type": "string", "required": true, "description": "Your last name", "default": null, "constraints": ["length >= 1"]}, {"name": "phone_number", "type": "string", "required": true, "description": "Your 10-digit phone number.", "default": null, "constraints": ["length >= 10, <= 10"]}, {"name": "password", "type": "string", "required": true, "description": "Your password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_account", "description": "Show your account information. Unlike show_profile, this includes private information.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "phone_number": "string", "registered_at": "2019-01-01T00:00:00", "last_logged_in": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "Your phone number.", "default": null, "constraints": []}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your phone number.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "login", "description": "Login to your account.", "parameters": [{"name": "username", "type": "string", "required": true, "description": "Your account phone_number.", "default": null, "constraints": []}, {"name": "password", "type": "string", "required": true, "description": "Your account password.", "default": null, "constraints": []}], "response_schemas": {"success": {"access_token": "string", "token_type": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_contact", "description": "Update contact information.", "parameters": [{"name": "contact_id", "type": "integer", "required": true, "description": "ID of the contact to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "first_name", "type": "string", "required": false, "description": "Updated first name of the contact.", "default": null, "constraints": []}, {"name": "last_name", "type": "string", "required": false, "description": "Updated last name of the contact.", "default": null, "constraints": []}, {"name": "phone_number", "type": "string", "required": false, "description": "Updated phone number of the contact.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": false, "description": "Updated email of the contact.", "default": null, "constraints": ["value is email address"]}, {"name": "relationships", "type": "list[string]", "required": false, "description": "Updated relationship with the contact.", "default": null, "constraints": []}, {"name": "birthday", "type": "string", "required": false, "description": "Updated birthday of the contact in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "home_address", "type": "string", "required": false, "description": "Updated home address of the contact.", "default": null, "constraints": []}, {"name": "work_address", "type": "string", "required": false, "description": "Updated work address of the contact.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_contact_relationships", "description": "Get a list of all relationships available in your contact book.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": ["string"], "failure": {"message": "string"}}}, {"api_name": "show_voice_message_window", "description": "Show voice messages with a contact around a given date and time.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "min_datetime", "type": "string", "required": false, "description": "The minimum datetime to show messages on or after in YYYY-MM-DD|HH:MM:SS format.", "default": "1500-01-01|00:00:00", "constraints": []}, {"name": "max_datetime", "type": "string", "required": false, "description": "The maximum datetime to show messages on or before in YYYY-MM-DD|HH:MM:SS format.", "default": "3000-01-01|00:00:00", "constraints": []}, {"name": "pagination_order", "type": "string", "required": false, "description": "If set to ascending, as page_index increases, the results will have newer messages. If set to descending, as page_index increases, the results will have older messages. The messages within each page will always be oldest to newest.", "default": "descending", "constraints": ["value in ['ascending', 'descending']"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"voice_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "search_text_messages", "description": "Show or search your text messages.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "phone_number", "type": "string", "required": false, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "only_latest_per_contact", "type": "boolean", "required": false, "description": "If set to true, only the latest message from each contact will be shown.", "default": false, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the messages by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page. If both query and sort_by are not given, null, or empty, sort_by will default to -created_at.", "default": null, "constraints": []}], "response_schemas": {"success": [{"text_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "send_voice_message", "description": "Send a voice message on the given phone number.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to send the voice message to.", "default": null, "constraints": []}, {"name": "message", "type": "string", "required": true, "description": "The message text of the voice_message.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "voice_message_id": 1}, "failure": {"message": "string"}}}]} |
14 | {"simple_note": [{"api_name": "show_profile", "description": "Show public profile information of a user.", "parameters": [{"name": "email", "type": "string", "required": false, "description": "Email of the person you want to see the profile information of.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your email address.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_account_name", "description": "Update your first or last name in the account profile.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "first_name", "type": "string", "required": false, "description": "Your updated first name.", "default": null, "constraints": ["length >= 1"]}, {"name": "last_name", "type": "string", "required": false, "description": "Your updated last name.", "default": null, "constraints": ["length >= 1"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "login", "description": "Login to your account.", "parameters": [{"name": "username", "type": "string", "required": true, "description": "Your account email.", "default": null, "constraints": []}, {"name": "password", "type": "string", "required": true, "description": "Your account password.", "default": null, "constraints": []}], "response_schemas": {"success": {"access_token": "string", "token_type": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_note", "description": "Update a note's title, content, tags, and/or pinned status.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "Updated title of the note.", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": false, "description": "Updated content of the note.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Updated tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Updated pinned status of the note.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "signup", "description": "Sign up to create account.", "parameters": [{"name": "first_name", "type": "string", "required": true, "description": "Your first name", "default": null, "constraints": ["length >= 1"]}, {"name": "last_name", "type": "string", "required": true, "description": "Your last name", "default": null, "constraints": ["length >= 1"]}, {"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password", "type": "string", "required": true, "description": "Your password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_verification_code", "description": "Send account verification code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "logout", "description": "Logout from your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "amazon": [{"api_name": "delete_product_question", "description": "Delete a product question.", "parameters": [{"name": "question_id", "type": "integer", "required": true, "description": "ID of the question to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_payment_card", "description": "Delete payment card information.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to be deleted.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_profile", "description": "Show public profile information of a user.", "parameters": [{"name": "email", "type": "string", "required": false, "description": "Email of the person you want to see the profile information of.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "place_order", "description": "Place an order for all the items in your cart.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for this order.", "default": null, "constraints": []}, {"name": "address_id", "type": "integer", "required": true, "description": "ID of the address used for shipping this order.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "order_id": 1}, "failure": {"message": "string"}}}]} |
15 | {"simple_note": [{"api_name": "delete_account", "description": "Delete your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "add_content_to_note", "description": "Append or prepend content to a note.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to add content to.", "default": null, "constraints": []}, {"name": "append_or_prepend", "type": "string", "required": true, "description": "Whether to append or prepend the content.", "default": null, "constraints": ["value in ['append', 'prepend']"]}, {"name": "added_content", "type": "string", "required": true, "description": "Content to append or prepend on the note's existing content. It will add a new line between the existing content and the added content.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "splitwise": [{"api_name": "delete_payment", "description": "Mark the payment you are involved in as deleted. Anyone involved in the payment or a member of its group can undelete it later.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_group", "description": "Show group details based on its ID.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"group_id": 1, "name": "string", "description": "string", "created_at": "2019-01-01T00:00:00", "deleted": true, "creator": {"name": "string", "email": "[email protected]"}, "members": [{"name": "string", "email": "[email protected]"}], "invitation_code": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_group_balance", "description": "For the given group, show the detailed breakdown of amounts different members owe to each other. If group_id is not passed, show the amounts you owe to others and vice-versa for non-grouped expenses/payments.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "group_id", "type": "integer", "required": false, "description": "The ID of the group to show balance of. If not passed, it will show balance from non-grouped expenses/payments.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": false, "description": "If passed, only balance of this member of the group will be shown. Otherwise, balance of all members will be shown. If group_id is not passed, email can only be your own email or None.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": [{"source": {"name": "string", "email": "[email protected]"}, "source_owes_to_targets": {"total": 0.0, "breakdown": [{"email": "[email protected]", "name": "string", "amount": 0.0}]}, "targets_owe_to_source": {"total": 0.0, "breakdown": [{"email": "[email protected]", "name": "string", "amount": 0.0}]}}], "failure": {"message": "string"}}}]} |
16 | {"spotify": [{"api_name": "unlike_playlist", "description": "Unlike a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to unlike.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_playlist", "description": "Delete a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "venmo": [{"api_name": "add_to_venmo_balance", "description": "Add money to your Venmo balance.", "parameters": [{"name": "amount", "type": "number", "required": true, "description": "Amount to add to Venmo balance.", "default": null, "constraints": ["value > 0.0"]}, {"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for adding balance.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "bank_transfer_id": 1}, "failure": {"message": "string"}}}, {"api_name": "update_payment_request", "description": "Update payment request information.", "parameters": [{"name": "payment_request_id", "type": "integer", "required": true, "description": "ID of the payment request to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "amount", "type": "number", "required": false, "description": "Updated amount of the payment request.", "default": null, "constraints": ["value > 0.0"]}, {"name": "description", "type": "string", "required": false, "description": "Updated description of or note about the payment request.", "default": null, "constraints": []}, {"name": "private", "type": "boolean", "required": false, "description": "Updated privacy of the transaction on payment request approval.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
17 | {"venmo": [{"api_name": "add_to_venmo_balance", "description": "Add money to your Venmo balance.", "parameters": [{"name": "amount", "type": "number", "required": true, "description": "Amount to add to Venmo balance.", "default": null, "constraints": ["value > 0.0"]}, {"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for adding balance.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "bank_transfer_id": 1}, "failure": {"message": "string"}}}, {"api_name": "withdraw_from_venmo_balance", "description": "Withdraw money from your Venmo balance.", "parameters": [{"name": "amount", "type": "number", "required": true, "description": "Amount to withdraw from Venmo balance.", "default": null, "constraints": ["value > 0.0"]}, {"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to credit the withdrawn amount to.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "bank_transfer_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_notifications_count", "description": "Get the count of your notifications.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Count notifications by read status. Will count all if not passed.", "default": null, "constraints": []}], "response_schemas": {"success": {"notifications_count": 0.0}, "failure": {"message": "string"}}}, {"api_name": "verify_account", "description": "Verify your account using the verification code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "verification_code", "type": "string", "required": true, "description": "The verification code sent to your email address.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "download_transaction_receipt", "description": "Download the receipt of a transaction (money sent from one user to another).", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "download_to_file_path", "type": "string", "required": false, "description": "The file path to download the receipt file to in file system app. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'. If not passed, it will be saved in your ~/downloads directory.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the file if it already exists.", "default": false, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "file_path": "string"}, "failure": {"message": "string"}}}], "phone": [{"api_name": "signup", "description": "Sign up to create account.", "parameters": [{"name": "first_name", "type": "string", "required": true, "description": "Your first name", "default": null, "constraints": ["length >= 1"]}, {"name": "last_name", "type": "string", "required": true, "description": "Your last name", "default": null, "constraints": ["length >= 1"]}, {"name": "phone_number", "type": "string", "required": true, "description": "Your 10-digit phone number.", "default": null, "constraints": ["length >= 10, <= 10"]}, {"name": "password", "type": "string", "required": true, "description": "Your password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_account", "description": "Show your account information. Unlike show_profile, this includes private information.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "phone_number": "string", "registered_at": "2019-01-01T00:00:00", "last_logged_in": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "add_contact", "description": "Add a new contact.", "parameters": [{"name": "first_name", "type": "string", "required": true, "description": "First name of the contact.", "default": null, "constraints": []}, {"name": "last_name", "type": "string", "required": true, "description": "Last name of the contact.", "default": null, "constraints": []}, {"name": "phone_number", "type": "string", "required": true, "description": "Phone number of the contact.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": false, "description": "Email of the contact.", "default": null, "constraints": ["value is email address"]}, {"name": "relationships", "type": "list[string]", "required": false, "description": "Relationship with the contact.", "default": null, "constraints": []}, {"name": "birthday", "type": "string", "required": false, "description": "Birthday of the contact in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "home_address", "type": "string", "required": false, "description": "Home address of the contact.", "default": null, "constraints": []}, {"name": "work_address", "type": "string", "required": false, "description": "Work address of the contact.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "contact_id": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_alarm", "description": "Delete an alarm.", "parameters": [{"name": "alarm_id", "type": "integer", "required": true, "description": "ID of the alarm to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_voice_message_window", "description": "Show voice messages with a contact around a given date and time.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to show messages with.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "min_datetime", "type": "string", "required": false, "description": "The minimum datetime to show messages on or after in YYYY-MM-DD|HH:MM:SS format.", "default": "1500-01-01|00:00:00", "constraints": []}, {"name": "max_datetime", "type": "string", "required": false, "description": "The maximum datetime to show messages on or before in YYYY-MM-DD|HH:MM:SS format.", "default": "3000-01-01|00:00:00", "constraints": []}, {"name": "pagination_order", "type": "string", "required": false, "description": "If set to ascending, as page_index increases, the results will have newer messages. If set to descending, as page_index increases, the results will have older messages. The messages within each page will always be oldest to newest.", "default": "descending", "constraints": ["value in ['ascending', 'descending']"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"voice_message_id": 1, "sender": {"contact_id": 1, "name": "string", "phone_number": "string"}, "receiver": {"contact_id": 1, "name": "string", "phone_number": "string"}, "message": "string", "sent_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}]} |
18 | {"simple_note": [{"api_name": "show_profile", "description": "Show public profile information of a user.", "parameters": [{"name": "email", "type": "string", "required": false, "description": "Email of the person you want to see the profile information of.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "update_note", "description": "Update a note's title, content, tags, and/or pinned status.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "Updated title of the note.", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": false, "description": "Updated content of the note.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Updated tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Updated pinned status of the note.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "login", "description": "Login to your account.", "parameters": [{"name": "username", "type": "string", "required": true, "description": "Your account email.", "default": null, "constraints": []}, {"name": "password", "type": "string", "required": true, "description": "Your account password.", "default": null, "constraints": []}], "response_schemas": {"success": {"access_token": "string", "token_type": "string"}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your email address.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "search_notes", "description": "Search your notes. This will not show contents of the notes. Pinned notes will be shown first by default, except when dont_reorder_pinned is true.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "Search query for the notes.", "default": "", "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Tags to filter the notes by. Notes not having any of these tags will be filtered out.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Filter notes by pinned status.", "default": null, "constraints": []}, {"name": "dont_reorder_pinned", "type": "boolean", "required": false, "description": "If true, pinned notes will not be reordered to be shown at the top.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the notes by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at and updated_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page. If both query and sort_by are not given, null, or empty, sort_by will default to -updated_at.", "default": null, "constraints": []}], "response_schemas": {"success": [{"note_id": 1, "title": "string", "tags": ["string"], "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "pinned": true}], "failure": {"message": "string"}}}, {"api_name": "signup", "description": "Sign up to create account.", "parameters": [{"name": "first_name", "type": "string", "required": true, "description": "Your first name", "default": null, "constraints": ["length >= 1"]}, {"name": "last_name", "type": "string", "required": true, "description": "Your last name", "default": null, "constraints": ["length >= 1"]}, {"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}, {"name": "password", "type": "string", "required": true, "description": "Your password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "todoist": [{"api_name": "show_tasks", "description": "Get a list of tasks within a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project. You can use 0 for your Inbox project.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "section_id", "type": "integer", "required": false, "description": "The ID of the section to filter tasks by. Set it to 0 for tasks without a section.", "default": null, "constraints": []}, {"name": "assignee_email", "type": "string", "required": false, "description": "Email address of the assignee to filter tasks by.", "default": null, "constraints": ["value is email address"]}, {"name": "assigner_email", "type": "string", "required": false, "description": "Email address of the assigner to filter tasks by.", "default": null, "constraints": ["value is email address"]}, {"name": "priority", "type": "string", "required": false, "description": "The priority to filter tasks by.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "Completion status to filter by.", "default": null, "constraints": []}, {"name": "due_today", "type": "boolean", "required": false, "description": "If true, only tasks due today will be returned. If false, all tasks will be returned.", "default": false, "constraints": []}, {"name": "label_id", "type": "integer", "required": false, "description": "The ID of the label to filter tasks by.", "default": null, "constraints": []}, {"name": "overdue", "type": "boolean", "required": false, "description": "If true, only tasks that are overdue will be returned. If false, all tasks will be returned.", "default": false, "constraints": []}, {"name": "min_due_date", "type": "string", "required": false, "description": "Only tasks with a due date greater than or equal to this date will be returned. Date should be in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_due_date", "type": "string", "required": false, "description": "Only tasks with a due date less than or equal to this date will be returned. Date should be in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the tasks by prefixed with +/- to reflect ascending/descending. Valid attributes: order_index, due_date and priority.", "default": "+order_index", "constraints": []}], "response_schemas": {"success": {"project_id": 1, "no_section_tasks": [{"order_index": 1, "task_id": 1, "title": "string", "description": "string", "num_sub_tasks": 1, "is_completed": true, "due_date": "2019-01-01T00:00:00", "priority": "high", "duration": 0.0, "duration_unit": "minutes", "assignee_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}]}], "sections": [{"section_id": 1, "tasks": [{"order_index": 1, "task_id": 1, "title": "string", "description": "string", "num_sub_tasks": 1, "is_completed": true, "due_date": "2019-01-01T00:00:00", "priority": "high", "duration": 0.0, "duration_unit": "minutes", "assignee_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}]}]}]}, "failure": {"message": "string"}}}, {"api_name": "update_label", "description": "Update label information.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "name", "type": "string", "required": false, "description": "The updated name of the label.", "default": null, "constraints": ["length >= 1"]}, {"name": "color", "type": "string", "required": false, "description": "The updated color of the label.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_notifications", "description": "Get a list of your notifications.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter notifications by read status. Will skip filtering if not passed.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"notification_id": 1, "type": "collaborator_added", "title": "string", "message": "string", "read": true, "created_at": "2019-01-01T00:00:00", "data": {}}], "failure": {"message": "string"}}}, {"api_name": "delete_project_invite", "description": "Delete a project invite that you sent or received.", "parameters": [{"name": "invite_code", "type": "string", "required": true, "description": "The invite code sent to you by a project collaborator.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_project", "description": "Create a new project.", "parameters": [{"name": "name", "type": "string", "required": true, "description": "The name of the project.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "Color of the project.", "default": "charcoal", "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "description", "type": "string", "required": false, "description": "The description of the project.", "default": "", "constraints": []}, {"name": "is_favorite", "type": "boolean", "required": false, "description": "Whether the project is marked as favorite.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "project_id": 1}, "failure": {"message": "string"}}}]} |
19 | {"gmail": [{"api_name": "reply_to_email", "description": "Reply to an existing email in a thread.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to reply to.", "default": null, "constraints": []}, {"name": "email_id", "type": "integer", "required": true, "description": "The ID of the email to reply to.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": true, "description": "The body of the reply email.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "email_addresses", "type": "list[string]", "required": false, "description": "List of recipient email addresses. If passed, it'll reply to all recipients in the list, otherwise, to the sender.", "default": null, "constraints": []}, {"name": "attachment_file_paths", "type": "list[string]", "required": false, "description": "List of absolute file paths (starting with /) from the file_system app to attach to the email.", "default": null, "constraints": []}, {"name": "file_system_access_token", "type": "string", "required": false, "description": "Access token obtained from file_system app login. Only needed for attachments.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "sent_email_id": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_thread", "description": "Delete an email thread.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_password_reset_code", "description": "Send password reset code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "spotify": [{"api_name": "seek_song", "description": "Seek the current song to the given number of seconds.", "parameters": [{"name": "seek_seconds", "type": "integer", "required": true, "description": "The number of seconds to seek.", "default": null, "constraints": ["value >= 0.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_playlist_reviews", "description": "Show a list of reviews for your playlist or others' public playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to retrieve reviews for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "Email of the user to filter reviews by.", "default": null, "constraints": ["value is email address"]}, {"name": "min_rating", "type": "integer", "required": false, "description": "The minimum rating for a review.", "default": 1, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "max_rating", "type": "integer", "required": false, "description": "The maximum rating for a review.", "default": 5, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the playlist reviews by prefixed with +/- to reflect ascending/descending. Valid attributes: rating and created_at. If both query and sort_by are given and non-empty, results will be first ranked by query relevance, then paginated, and will then be sorted by the given attribute within each page.", "default": null, "constraints": []}], "response_schemas": {"success": [{"playlist_review_id": 1, "playlist_id": 1, "rating": 1.0, "title": "string", "text": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}]} |
20 | {"phone": [{"api_name": "update_alarm", "description": "Update an alarm's settings.", "parameters": [{"name": "alarm_id", "type": "integer", "required": true, "description": "ID of the alarm to be updated.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}, {"name": "time", "type": "string", "required": false, "description": "The updated time of the alarm in HH:MM format.", "default": null, "constraints": []}, {"name": "repeat_days", "type": "list[string]", "required": false, "description": "The updated days on which the alarm should repeat.", "default": null, "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The updated label for the alarm.", "default": null, "constraints": []}, {"name": "enabled", "type": "boolean", "required": false, "description": "Whether the alarm is enabled or not.", "default": null, "constraints": []}, {"name": "snooze_minutes", "type": "integer", "required": false, "description": "The updated duration of snooze in minutes. Use 0 for no snooze.", "default": null, "constraints": ["value >= 0.0"]}, {"name": "vibration", "type": "boolean", "required": false, "description": "Whether the alarm should vibrate or not.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "reset_password", "description": "Reset your password using the password reset code sent to your email address.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "Your phone number.", "default": null, "constraints": []}, {"name": "password_reset_code", "type": "string", "required": true, "description": "The password reset code sent to your phone number.", "default": null, "constraints": []}, {"name": "new_password", "type": "string", "required": true, "description": "Your new password.", "default": null, "constraints": ["length >= 5"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "simple_note": [{"api_name": "logout", "description": "Logout from your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_password_reset_code", "description": "Send password reset code to your email address.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "Your email address.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_note", "description": "Update a note's title, content, tags, and/or pinned status.", "parameters": [{"name": "note_id", "type": "integer", "required": true, "description": "ID of the note to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from simple_note app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "Updated title of the note.", "default": null, "constraints": ["length >= 1"]}, {"name": "content", "type": "string", "required": false, "description": "Updated content of the note.", "default": null, "constraints": []}, {"name": "tags", "type": "list[string]", "required": false, "description": "Updated tags for the note.", "default": null, "constraints": []}, {"name": "pinned", "type": "boolean", "required": false, "description": "Updated pinned status of the note.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
21 | {"venmo": [{"api_name": "like_transaction_comment", "description": "Like a transaction comment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "ID of the transaction comment to like.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_transaction_comments", "description": "Get a list of transaction comments.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to retrieve comments for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "page_index", "type": "integer", "required": false, "description": "The index of the page to return.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "page_limit", "type": "integer", "required": false, "description": "The maximum number of results to return per page.", "default": 5, "constraints": ["value >= 1.0, <= 20.0"]}], "response_schemas": {"success": [{"transaction_id": 1, "comment": "string", "created_at": "2019-01-01T00:00:00", "like_count": 1, "comment_id": 1, "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "update_transaction", "description": "Update transaction information.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to update.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": true, "description": "Updated description of or note about the transaction.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "private", "type": "boolean", "required": false, "description": "Updated privacy of the transaction.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "phone": [{"api_name": "send_voice_message", "description": "Send a voice message on the given phone number.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to send the voice message to.", "default": null, "constraints": []}, {"name": "message", "type": "string", "required": true, "description": "The message text of the voice_message.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "voice_message_id": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_account", "description": "Delete your account.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_voice_message", "description": "Delete a voice message.", "parameters": [{"name": "voice_message_id", "type": "integer", "required": true, "description": "The ID of the voice message to delete.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "send_password_reset_code", "description": "Send password reset code to your phone number.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "Your phone number.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]} |
End of preview. Expand
in Data Studio
README.md exists but content is empty.
- Downloads last month
- 93