Datasets:
ai2-adapt-dev
/
appworld-api-cross-apps

Dataset card Data Studio Files Community
id
int64
0
30k
tools
stringlengths
1.42k
24k
300
{"amazon": [{"api_name": "show_returns", "description": "Get a list of your product returns.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "order_id", "type": "integer", "required": false, "description": "ID of the order to filter returns by.", "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 returns by prefixed with +/- to reflect ascending/descending. Valid attributes: quantity, initiated_at and returned_at.", "default": "-initiated_at", "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": "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"}}}], "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": "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"}}}]}
301
{"amazon": [{"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": "write_product_review", "description": "Write a product review.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to review.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": true, "description": "Product rating for this review.", "default": null, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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", "product_review_id": 1}, "failure": {"message": "string"}}}, {"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"}}}], "gmail": [{"api_name": "mark_thread_read", "description": "Mark an email thread as read.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to mark as read.", "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_drafts", "description": "Show a list of user drafts.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "recipient_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter drafts by attachment status.", "default": null, "constraints": []}, {"name": "scheduled", "type": "boolean", "required": false, "description": "Filter drafts by whether they are scheduled to be sent in the future.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "Filter drafts by email thread ID that the draft belongs to.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "Filter drafts by email ID that the draft responds to.", "default": null, "constraints": []}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter drafts by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter drafts by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 drafts 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": [{"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": "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": "mark_thread_unstarred", "description": "Mark an email thread as unstarred.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unstar.", "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": "upload_attachments_to_draft", "description": "Upload attachments to a draft.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to upload the attachment to.", "default": null, "constraints": []}, {"name": "attachment_file_paths", "type": "list[string]", "required": true, "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": 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": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the attachment if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "attachment_ids": [1]}, "failure": {"message": "string"}}}]}
302
{"splitwise": [{"api_name": "remove_member_from_group", "description": "Remove a member from a group.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group.", "default": null, "constraints": []}, {"name": "user_email", "type": "string", "required": true, "description": "Email of the user to remove from the group.", "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": []}], "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 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"}}}], "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": "delete_address", "description": "Delete address information.", "parameters": [{"name": "address_id", "type": "integer", "required": true, "description": "ID of the address 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_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"}}}]}
303
{"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": "delete_account", "description": "Delete your account.", "parameters": [{"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"}}}], "gmail": [{"api_name": "show_email", "description": "Show detailed information about a given email.", "parameters": [{"name": "email_id", "type": "integer", "required": true, "description": "The ID of the email 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_id": 1, "subject": "string", "body": "string", "response_to_email_id": 1, "created_at": "2019-01-01T00:00:00", "sender": {"name": "string", "email": "[email protected]"}, "recipients": [{"name": "string", "email": "[email protected]"}], "attachments": [{"id": 1, "file_name": "string"}]}, "failure": {"message": "string"}}}, {"api_name": "delete_draft", "description": "Delete draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft 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"}}}]}
304
{"gmail": [{"api_name": "mark_thread_unstarred", "description": "Mark an email thread as unstarred.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unstar.", "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": "mark_thread_archived", "description": "Mark an email thread as archived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to archive.", "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"}}}], "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": "follow_artist", "description": "Follow an artist.", "parameters": [{"name": "artist_id", "type": "integer", "required": true, "description": "The artist id to follow.", "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": "logout", "description": "Logout from your account.", "parameters": [{"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_to_queue", "description": "Add a song, album or playlist to the music player song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "song_id", "type": "integer", "required": false, "description": "ID of the song to add to queue.", "default": null, "constraints": []}, {"name": "album_id", "type": "integer", "required": false, "description": "ID of the album to add to queue.", "default": null, "constraints": []}, {"name": "playlist_id", "type": "integer", "required": false, "description": "ID of the playlist to add to queue.", "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": "create_playlist", "description": "Create a new playlist.", "parameters": [{"name": "title", "type": "string", "required": true, "description": "The title of the playlist.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "is_public", "type": "boolean", "required": false, "description": "Whether the playlist is public or not.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "playlist_id": 1}, "failure": {"message": "string"}}}, {"api_name": "review_playlist", "description": "Rate or review a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "ID of the playlist to review.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": true, "description": "Playlist 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", "playlist_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"}}}]}
305
{"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": "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": "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": "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": "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": "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": "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"}}}], "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": "update_group", "description": "Update group information.", "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": []}, {"name": "name", "type": "string", "required": false, "description": "The updated name of the group.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the group.", "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 splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "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"}}}]}
306
{"phone": [{"api_name": "delete_text_message", "description": "Delete a text message.", "parameters": [{"name": "text_message_id", "type": "integer", "required": true, "description": "ID of the text message 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"}}}, {"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": "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": "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": "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": "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": "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"}}}], "splitwise": [{"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": "regenerate_invitation_code", "description": "Regenerate the invitation code for a group. Anyone with this code can join the group. The old code will be invalidated.", "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": {"message": "string", "invitation_code": "string"}, "failure": {"message": "string"}}}, {"api_name": "attach_expense_receipt_file", "description": "Attach a receipt file to an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to attach receipt file to.", "default": null, "constraints": []}, {"name": "receipt_file_path", "type": "string", "required": true, "description": "Absolute file path (starting with /) from the file_system app to attach as a receipt for this expense.", "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": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the existing receipt file if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
307
{"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": "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"}}}], "file_system": [{"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_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 file_system 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": "show_file", "description": "Show a file's content and other details, if it 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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"file_id": 1, "path": "string", "content": "string", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"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_directory", "description": "Move a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the moved directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_directory", "description": "Create a directory if it does not exist, optionally recursively.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "recursive", "type": "boolean", "required": false, "description": "If True, it will create all parent directories recursively if they don't exist.", "default": false, "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": "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": "copy_directory", "description": "Copy a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the copied directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "string"}, "failure": {"message": "string"}}}]}
308
{"amazon": [{"api_name": "show_order", "description": "Get details of a past order.", "parameters": [{"name": "order_id", "type": "integer", "required": true, "description": "ID of the order to be shown.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"order_id": 1, "address_id": 1, "payment_card_id": 1, "name": "string", "tax": 0.0, "delivery_fee": 0.0, "gift_wrap_fee": 0.0, "discount": 0.0, "created_at": "2019-01-01T00:00:00", "address_text": "string", "payment_card_digits": "string", "paid_amount": 0.0, "order_items": [{"product_id": 1, "ordered_quantity": 1, "returned_quantity": 1, "gift_wrap_quantity": 1, "price": 0.0, "expected_delivery_at": "2019-01-01T00:00:00", "delivered_at": "2019-01-01T00:00:00"}]}, "failure": {"message": "string"}}}, {"api_name": "search_products", "description": "Search for products with a query and various filtering criteria.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "product_type", "type": "string", "required": false, "description": "The type of product to search for.", "default": null, "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of product to search for.", "default": null, "constraints": []}, {"name": "relative_size", "type": "string", "required": false, "description": "The relative size of product to search for.", "default": null, "constraints": ["value in ['extra-small', 'small', 'medium', 'large', 'extra-large']"]}, {"name": "min_price", "type": "number", "required": false, "description": "The minimum price for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_price", "type": "number", "required": false, "description": "The maximum price for search results.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "min_product_rating", "type": "number", "required": false, "description": "The minimum product rating for search results.", "default": 0, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "max_product_rating", "type": "number", "required": false, "description": "The maximum product rating for search results.", "default": 5, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "min_seller_rating", "type": "number", "required": false, "description": "The minimum seller rating for search results.", "default": 0, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "max_seller_rating", "type": "number", "required": false, "description": "The maximum seller rating for search results.", "default": 5, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "seller_id", "type": "integer", "required": false, "description": "ID of the seller to search for.", "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 products by prefixed with +/- to reflect ascending/descending. Valid attributes: rating, price and delivery_days. 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, "seller_id": 1, "product_type": "string", "name": "string", "description": "string", "price": 0.0, "delivery_days": 1.0, "inventory_quantity": 0.0, "weight": 0.0, "length": 0.0, "width": 0.0, "height": 0.0, "color": "string", "relative_size": "extra-small", "rating": 0.0, "num_product_reviews": 1, "num_product_questions": 1, "variations": [{"product_id": 1, "relative_size": "extra-small", "color": "string"}]}], "failure": {"message": "string"}}}], "gmail": [{"api_name": "update_draft", "description": "Update draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to update.", "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.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": false, "description": "The updated subject of the draft.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": false, "description": "The updated body of the draft.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "The updated ID of the email thread that the draft should belong to. Must be passed if it's a reply to an email.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "The updated ID of the email in the thread that the draft is a response to.", "default": null, "constraints": []}, {"name": "scheduled_send_at", "type": "string", "required": false, "description": "The updated time at which the draft should be sent in YYYY-MM-DD|HH:MM:SS format.To remove the scheduled delivery, pass 'None' string, as leaving it empty or null is for when you don't want to update it.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "mark_thread_archived", "description": "Mark an email thread as archived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to archive.", "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": "mark_thread_not_spam", "description": "Mark an email thread as not spam.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to mark as not 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"}}}]}
309
{"gmail": [{"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": "show_spam_threads", "description": "Show or search email threads that have been marked as spam. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "archived", "type": "boolean", "required": false, "description": "Filter emails by archived status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by attachment status.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "failure": {"message": "string"}}}, {"api_name": "update_draft", "description": "Update draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to update.", "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.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": false, "description": "The updated subject of the draft.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": false, "description": "The updated body of the draft.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "The updated ID of the email thread that the draft should belong to. Must be passed if it's a reply to an email.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "The updated ID of the email in the thread that the draft is a response to.", "default": null, "constraints": []}, {"name": "scheduled_send_at", "type": "string", "required": false, "description": "The updated time at which the draft should be sent in YYYY-MM-DD|HH:MM:SS format.To remove the scheduled delivery, pass 'None' string, as leaving it empty or null is for when you don't want to update it.", "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"}}}, {"api_name": "show_drafts", "description": "Show a list of user drafts.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "recipient_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter drafts by attachment status.", "default": null, "constraints": []}, {"name": "scheduled", "type": "boolean", "required": false, "description": "Filter drafts by whether they are scheduled to be sent in the future.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "Filter drafts by email thread ID that the draft belongs to.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "Filter drafts by email ID that the draft responds to.", "default": null, "constraints": []}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter drafts by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter drafts by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 drafts 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": [{"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": "send_text_message", "description": "Send a text message on the given phone number.", "parameters": [{"name": "phone_number", "type": "string", "required": true, "description": "The phone number of the contact to send the message to.", "default": null, "constraints": []}, {"name": "message", "type": "string", "required": true, "description": "The content of the text 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", "text_message_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": "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": "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": "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": "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_alarms", "description": "Get a list of alarms.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone 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": [{"alarm_id": 1, "time": "string", "repeat_days": ["monday"], "label": "string", "enabled": true, "snooze_minutes": 0.0, "vibration": true, "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "phone_number": "string"}}], "failure": {"message": "string"}}}]}
310
{"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": "create_file", "description": "Create a new file with the given content.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "content", "type": "string", "required": false, "description": "The content of the file.", "default": "", "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_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 file_system 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": "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": "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": "show_no_group_payments", "description": "Show payments you are involved in that are not part of any group.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "participant_email", "type": "string", "required": false, "description": "Email of the payer or receiver to filter payments.", "default": null, "constraints": ["value is email address"]}, {"name": "min_amount", "type": "number", "required": false, "description": "Filter expenses by minimum amount.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_amount", "type": "number", "required": false, "description": "Filter expenses by maximum amount.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "deleted", "type": "boolean", "required": false, "description": "Filter payments by deleted status.", "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 payments by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at 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. 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": [{"payment_id": 1, "group_id": 1, "description": "string", "deleted": true, "receipt_file_name": "string", "created_at": "2019-01-01T00:00:00", "creator": {"name": "string", "email": "[email protected]"}, "payer": {"name": "string", "email": "[email protected]"}, "receiver": {"name": "string", "email": "[email protected]"}, "paid_amount": 0.0}], "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"}}}]}
311
{"splitwise": [{"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": "update_payment", "description": "Update payment information.", "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": []}, {"name": "amount", "type": "number", "required": false, "description": "The updated amount of the payment.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The updated note or description of the payment.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID 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": "show_activity", "description": "Show a history of your expenses and payments combined.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "show_expenses", "type": "boolean", "required": false, "description": "Whether to show expenses in the history.", "default": true, "constraints": []}, {"name": "show_payments", "type": "boolean", "required": false, "description": "Whether to show payments in the history.", "default": true, "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 expenses/payments by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at.", "default": "-created_at", "constraints": []}], "response_schemas": {"success": [{"record_type": "expense", "amount": 0.0, "paid_by": {"name": "string", "email": "[email protected]"}, "owed_by": [{"name": "string", "email": "[email protected]", "amount": 0.0}], "description": "string", "group_id": 1, "group_name": "string", "created_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}], "todoist": [{"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 todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_sub_task", "description": "Update sub_task information.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "The updated title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the sub_task.", "default": null, "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The updated due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The updated priority of the sub_task.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "The updated completion status of the sub_task. True if completed, False otherwise.", "default": null, "constraints": []}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated index at which this sub_task should be inserted in the current list of sub_tasks.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_task_comments", "description": "Get a list of task comments.", "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": []}, {"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": [{"task_id": 1, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["string"]}], "failure": {"message": "string"}}}, {"api_name": "update_task_comment", "description": "Update a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "content", "type": "string", "required": false, "description": "The updated content of the comment.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_label", "description": "Show label details based on its ID.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}]}
312
{"todoist": [{"api_name": "create_task", "description": "Create a new task within a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project. If set to 0, the task will be created in your default/inbox project.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": true, "description": "The title of the task.", "default": null, "constraints": ["length >= 1"]}, {"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 within the project.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the task.", "default": "", "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The due date of the task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "duration", "type": "number", "required": false, "description": "The duration of the task.", "default": null, "constraints": []}, {"name": "duration_unit", "type": "string", "required": false, "description": "The unit of the task duration.", "default": null, "constraints": ["value in ['minutes', 'hours', 'days']"]}, {"name": "order_index", "type": "integer", "required": false, "description": "Index at which this task should be inserted in the current list of tasks. 0 to insert at the top of the list, 1 to insert below the first task, etc. You can also use a negative value to insert from the end: -1 to insert at the end, -2 to insert just above the last task, etc.", "default": -1, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The priority of the task.", "default": "medium", "constraints": ["value in ['high', 'medium', 'low']"]}], "response_schemas": {"success": {"message": "string", "task_id": 1}, "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": "create_label", "description": "Create a new label.", "parameters": [{"name": "name", "type": "string", "required": true, "description": "The name of the label.", "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": "The color of the label.", "default": "charcoal", "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}], "response_schemas": {"success": {"message": "string", "label_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_project", "description": "Show project details based on its ID.", "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": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "is_inbox": true, "description": "string", "is_favorite": true, "is_archived": true, "created_at": "2019-01-01T00:00:00", "project_id": 1, "creator": {"name": "string", "email": "[email protected]"}, "num_tasks": 1, "sections": [{"id": 1, "name": "string", "num_tasks": 1}], "collaborators": [{"name": "string", "email": "[email protected]"}], "pending_invites": [{"invite_code": "string", "invitee": {"name": "string", "email": "[email protected]"}, "inviter": {"name": "string", "email": "[email protected]"}}], "is_shared": true}, "failure": {"message": "string"}}}, {"api_name": "mark_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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"}}}], "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": "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": "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"}}}]}
313
{"spotify": [{"api_name": "subscribe_premium", "description": "Subscribe to premium membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy premium subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the premium subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "premium_subscription_id": 1}, "failure": {"message": "string"}}}, {"api_name": "pause_music", "description": "Pause the currently playing song.", "parameters": [{"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": "review_playlist", "description": "Rate or review a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "ID of the playlist to review.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": true, "description": "Playlist 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", "playlist_review_id": 1}, "failure": {"message": "string"}}}, {"api_name": "remove_album_from_library", "description": "Remove an album from the user's album library.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album 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": "show_liked_songs", "description": "Get a list of songs 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 songs by prefixed with +/- to reflect ascending/descending. Valid attributes: liked_at, play_count and title.", "default": "-liked_at", "constraints": []}], "response_schemas": {"success": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "liked_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}], "venmo": [{"api_name": "delete_payment_request", "description": "Delete a payment request.", "parameters": [{"name": "payment_request_id", "type": "integer", "required": true, "description": "ID of the payment request 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": "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"}}}]}
314
{"gmail": [{"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": "unlabel_thread", "description": "Remove label from an email thread.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unlabel.", "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": "search_users", "description": "Search Gmail 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": "remove_attachment_from_draft", "description": "Delete an attachment from a draft.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to delete the attachment from.", "default": null, "constraints": []}, {"name": "attachment_id", "type": "integer", "required": true, "description": "The ID of the attachment 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": "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"}}}], "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": "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": "show_cart", "description": "show your cart.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"delivery_fee": 0.0, "base_cost": 0.0, "tax": 0.0, "gift_wrap_fee": 0.0, "discount": 0.0, "total_cost": 0.0, "promo_code": "string", "promo_valid": true, "cart_items": [{"product_id": 1, "product_name": "string", "delivery_days": 1, "quantity": 1, "price": 0.0, "gift_wrap_quantity": 1}]}, "failure": {"message": "string"}}}, {"api_name": "update_address", "description": "Update address information.", "parameters": [{"name": "address_id", "type": "integer", "required": true, "description": "ID of the address to update", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "name", "type": "string", "required": false, "description": "New name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "street_address", "type": "string", "required": false, "description": "New street address line.", "default": null, "constraints": ["length >= 1"]}, {"name": "city", "type": "string", "required": false, "description": "New city name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "state", "type": "string", "required": false, "description": "New state name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "country", "type": "string", "required": false, "description": "New country name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "zip_code", "type": "integer", "required": false, "description": "New ZIP code for the address", "default": null, "constraints": ["value >= 10000.0, <= 99999.0"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "clear_wish_list", "description": "Clear wish list.", "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"}}}, {"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": "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": "update_payment_card", "description": "Update payment card information.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to update.", "default": null, "constraints": []}, {"name": "card_name", "type": "string", "required": true, "description": "Name of the payment card to update.", "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"}, "failure": {"message": "string"}}}, {"api_name": "delete_product_question_answer", "description": "Delete a answer to a product question.", "parameters": [{"name": "question_answer_id", "type": "integer", "required": true, "description": "ID of the question answer 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": "write_product_review", "description": "Write a product review.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to review.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": true, "description": "Product rating for this review.", "default": null, "constraints": ["value >= 1.0, <= 5.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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", "product_review_id": 1}, "failure": {"message": "string"}}}]}
315
{"spotify": [{"api_name": "show_following_artists", "description": "Get a list of artists the user is following.", "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": [{"artist_id": 1, "name": "string", "genre": "string", "follower_count": 1, "created_at": "2019-01-01T00:00:00", "followed_at": "2019-01-01T00:00:00"}], "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"}}}], "phone": [{"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": "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"}}}]}
316
{"file_system": [{"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": "delete_account", "description": "Delete 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"}}}], "spotify": [{"api_name": "play_music", "description": "Play music based on various criteria. You can pass, at most, any one of queue_position, song_id, album_id or playlist_id. If one of song_id, album_id or playlist_id is passed, that song, album or playlist will be added to the queue and played. Otherwise, the queue will remain unchanged. If queue_position is passed, the song at that position in the queue will be played. If none is passed, the current song in the queue will be played.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "song_id", "type": "integer", "required": false, "description": "ID of the song to play.", "default": null, "constraints": []}, {"name": "album_id", "type": "integer", "required": false, "description": "ID of the album to play.", "default": null, "constraints": []}, {"name": "playlist_id", "type": "integer", "required": false, "description": "ID of the playlist to play.", "default": null, "constraints": []}, {"name": "queue_position", "type": "integer", "required": false, "description": "Position of the song in the queue to play.", "default": null, "constraints": ["value >= 0.0"]}], "response_schemas": {"success": {"message": "string", "song_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_album_reviews", "description": "Get a list of reviews for an album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve 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": "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 album 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": [{"album_review_id": 1, "album_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": "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"}}}, {"api_name": "loop_song", "description": "Set whether to loop the current song.", "parameters": [{"name": "loop", "type": "boolean", "required": true, "description": "Whether to loop the current song.", "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": "subscribe_premium", "description": "Subscribe to premium membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy premium subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the premium subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "premium_subscription_id": 1}, "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": "search_albums", "description": "Search for albums with a query.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "min_rating", "type": "number", "required": false, "description": "The minimum rating for search results.", "default": 0, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "max_rating", "type": "number", "required": false, "description": "The maximum rating for search results.", "default": 5, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "min_release_date", "type": "string", "required": false, "description": "The minimum release date for search results in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_release_date", "type": "string", "required": false, "description": "The maximum release date for search results in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "min_like_count", "type": "integer", "required": false, "description": "The minimum like count for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_like_count", "type": "integer", "required": false, "description": "The maximum like count for search results.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "genre", "type": "string", "required": false, "description": "The genre to filter the albums by.", "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 albums by prefixed with +/- to reflect ascending/descending. Valid attributes: rating and release_date. 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": [{"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]}], "failure": {"message": "string"}}}, {"api_name": "show_album_privates", "description": "Show information about the album that is private to the user.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"liked": true, "reviewed": true, "in_album_library": true}, "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 spotify 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"}}}]}
317
{"spotify": [{"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": "logout", "description": "Logout from your account.", "parameters": [{"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"}}}], "simple_note": [{"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": "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"}}}, {"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_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": "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": "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"}}}]}
318
{"amazon": [{"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": "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"}}}], "todoist": [{"api_name": "show_task_comment", "description": "Show a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment.", "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, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["string"]}, "failure": {"message": "string"}}}, {"api_name": "download_attachment", "description": "Download the attachment of a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the comment to download the attachment from.", "default": null, "constraints": []}, {"name": "attachment_file_name", "type": "string", "required": true, "description": "Name of the file attached to the task comment.", "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 todoist app login.", "default": null, "constraints": []}, {"name": "download_to_file_path", "type": "string", "required": false, "description": "The file path to download the file 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": "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": "update_section", "description": "Update section information.", "parameters": [{"name": "section_id", "type": "integer", "required": true, "description": "The ID of the section.", "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 section.", "default": null, "constraints": ["length >= 1"]}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated order index of this section in the list of project sections.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
319
{"amazon": [{"api_name": "delete_product_from_wish_list", "description": "Remove product from the user wish list.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be deleted from the wish list.", "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": "download_order_receipt", "description": "Download the receipt of a past order.", "parameters": [{"name": "order_id", "type": "integer", "required": true, "description": "ID of the order to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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"}}}, {"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": "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": "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": "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": "update_product_quantity_in_cart", "description": "Update product quantity in the user cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be updated in the cart.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "The new quantity of the product to be updated in the cart.", "default": null, "constraints": ["value >= 0.0"]}, {"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_product_question_answer", "description": "Delete a answer to a product question.", "parameters": [{"name": "question_answer_id", "type": "integer", "required": true, "description": "ID of the question answer 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_product_review", "description": "Delete a product review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the product review.", "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"}}}], "venmo": [{"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 venmo 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": "add_friend", "description": "Add a friend to your friend list.", "parameters": [{"name": "user_email", "type": "string", "required": true, "description": "Email address of the friend to add.", "default": null, "constraints": ["value is email address"]}, {"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", "description": "Show transaction details.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "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"}}}, {"api_name": "show_social_feed", "description": "Show your social feed (transactions of your friends).", "parameters": [{"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, "amount": 0.0, "description": "string", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00", "private": true, "like_count": 1, "comment_count": 1, "sender": {"name": "string", "email": "[email protected]"}, "receiver": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "unlike_transaction", "description": "Unlike a transaction.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to unlike.", "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": "approve_payment_request", "description": "Approve a payment request.", "parameters": [{"name": "payment_request_id", "type": "integer", "required": true, "description": "ID of the payment request to approve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "payment_card_id", "type": "integer", "required": false, "description": "ID of the payment card to use for approving the payment request. If not passed, Venmo balance will be used.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
320
{"spotify": [{"api_name": "review_playlist", "description": "Rate or review a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "ID of the playlist to review.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": true, "description": "Playlist 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", "playlist_review_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_premium_plans", "description": "Show information about premium plans available.", "parameters": [], "response_schemas": {"success": {"monthly": 1, "yearly": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_album_review", "description": "Delete an album review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the album review.", "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_privates", "description": "Show information about the song that is private to the user.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"liked": true, "reviewed": true, "in_song_library": true, "downloaded": true}, "failure": {"message": "string"}}}, {"api_name": "subscribe_premium", "description": "Subscribe to premium membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy premium subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the premium subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "premium_subscription_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_album", "description": "Get details of a specific album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve.", "default": null, "constraints": []}], "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", "shareable_link": "string", "songs": [{"id": 1, "title": "string", "artist_ids": [1]}]}, "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": "add_to_queue", "description": "Add a song, album or playlist to the music player song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "song_id", "type": "integer", "required": false, "description": "ID of the song to add to queue.", "default": null, "constraints": []}, {"name": "album_id", "type": "integer", "required": false, "description": "ID of the album to add to queue.", "default": null, "constraints": []}, {"name": "playlist_id", "type": "integer", "required": false, "description": "ID of the playlist to add to queue.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "unfollow_artist", "description": "Unfollow an artist.", "parameters": [{"name": "artist_id", "type": "integer", "required": true, "description": "The artist id to unfollow.", "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": "remove_song_from_playlist", "description": "Remove a song from a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to remove the song from.", "default": null, "constraints": []}, {"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": "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"}}}], "amazon": [{"api_name": "add_product_to_cart", "description": "Add product by id and quantities to your cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be added to the 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": "The quantity of the product to be added to the cart.", "default": 1, "constraints": ["value >= 1.0"]}, {"name": "clear_cart_first", "type": "boolean", "required": false, "description": "If true, the cart will be cleared before adding the product to the cart.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_product_quantity_in_cart", "description": "Update product quantity in the user cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be updated in the cart.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "The new quantity of the product to be updated in the cart.", "default": null, "constraints": ["value >= 0.0"]}, {"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"}}}]}
321
{"spotify": [{"api_name": "unlike_song", "description": "Unlike a song.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song 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": "show_album_reviews", "description": "Get a list of reviews for an album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve 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": "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 album 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": [{"album_review_id": 1, "album_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"}}}], "file_system": [{"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 file_system 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": "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"}}}, {"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": "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": "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"}}}, {"api_name": "create_directory", "description": "Create a directory if it does not exist, optionally recursively.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "recursive", "type": "boolean", "required": false, "description": "If True, it will create all parent directories recursively if they don't exist.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "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": "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 file_system 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": "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": "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"}}}]}
322
{"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": "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": "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"}}}], "phone": [{"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": "delete_text_message", "description": "Delete a text message.", "parameters": [{"name": "text_message_id", "type": "integer", "required": true, "description": "ID of the text message 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"}}}, {"api_name": "search_voice_messages", "description": "Show or search text voice_messages between the user and a contact.", "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 voice_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 voice 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": [{"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"}}}]}
323
{"gmail": [{"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 gmail 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": "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_read", "description": "Mark an email thread as read.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to mark as read.", "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": "mark_thread_archived", "description": "Mark an email thread as archived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to archive.", "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_spam_threads", "description": "Show or search email threads that have been marked as spam. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "archived", "type": "boolean", "required": false, "description": "Filter emails by archived status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by attachment status.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "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"}}}], "splitwise": [{"api_name": "show_expense_comments", "description": "Get a list of expense comments.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise 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": [{"expense_comment_id": 1, "expense_id": 1, "comment": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "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": "download_expense_receipt_file", "description": "Download a receipt file attachment for an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to download receipt for.", "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": []}, {"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"}}}, {"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": "show_activity", "description": "Show a history of your expenses and payments combined.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "show_expenses", "type": "boolean", "required": false, "description": "Whether to show expenses in the history.", "default": true, "constraints": []}, {"name": "show_payments", "type": "boolean", "required": false, "description": "Whether to show payments in the history.", "default": true, "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 expenses/payments by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at.", "default": "-created_at", "constraints": []}], "response_schemas": {"success": [{"record_type": "expense", "amount": 0.0, "paid_by": {"name": "string", "email": "[email protected]"}, "owed_by": [{"name": "string", "email": "[email protected]", "amount": 0.0}], "description": "string", "group_id": 1, "group_name": "string", "created_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "undelete_expense", "description": "Restore a previously deleted expense you are involved in.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to undelete.", "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_expense_comment", "description": "Get information about a comment posted on an expense.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the expense comment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"expense_comment_id": 1, "expense_id": 1, "comment": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}, "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"}}}]}
324
{"todoist": [{"api_name": "assign_or_unassign_task", "description": "Assign or unassign a task to a user. If assignee_email is null, the task will be unassigned.", "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": []}, {"name": "assignee_email", "type": "string", "required": false, "description": "Email of the user to assign the task to.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_sub_task", "description": "Create a new sub_task within a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": true, "description": "The title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the sub_task.", "default": "", "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The priority of the sub_task.", "default": "medium", "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "order_index", "type": "integer", "required": false, "description": "Index at which this sub_task should be inserted in the current list of sub_tasks. 0 to insert at the top of the list, 1 to insert below the first sub_task, etc. You can also use a negative value to insert from the end: -1 to insert at the end, -2 to insert just above the last sub_task, etc.", "default": -1, "constraints": []}], "response_schemas": {"success": {"message": "string", "sub_task_id": 1}, "failure": {"message": "string"}}}, {"api_name": "update_sub_task", "description": "Update sub_task information.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "The updated title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the sub_task.", "default": null, "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The updated due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The updated priority of the sub_task.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "The updated completion status of the sub_task. True if completed, False otherwise.", "default": null, "constraints": []}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated index at which this sub_task should be inserted in the current list of sub_tasks.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "mark_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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": "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 todoist app login.", "default": null, "constraints": []}], "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 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"}}}, {"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 todoist 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": "create_label", "description": "Create a new label.", "parameters": [{"name": "name", "type": "string", "required": true, "description": "The name of the label.", "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": "The color of the label.", "default": "charcoal", "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}], "response_schemas": {"success": {"message": "string", "label_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_task_comment", "description": "Show a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment.", "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, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["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": "delete_section", "description": "Delete a section within a project.", "parameters": [{"name": "section_id", "type": "integer", "required": true, "description": "The ID of the section to delete.", "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"}}}], "amazon": [{"api_name": "update_product_question_answer", "description": "Update answer to a product question.", "parameters": [{"name": "question_answer_id", "type": "integer", "required": true, "description": "ID of the question answer to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "answer", "type": "string", "required": false, "description": "The updated answer for the question.", "default": null, "constraints": ["length >= 1"]}], "response_schemas": {"success": {"message": "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": "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"}}}]}
325
{"todoist": [{"api_name": "delete_section", "description": "Delete a section within a project.", "parameters": [{"name": "section_id", "type": "integer", "required": true, "description": "The ID of the section to delete.", "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": "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"}}}, {"api_name": "mark_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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": "show_label", "description": "Show label details based on its ID.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}], "phone": [{"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": "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"}}}]}
326
{"phone": [{"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": "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": "get_current_date_and_time", "description": "Show current date and time.", "parameters": [], "response_schemas": {"success": {"date": "string", "time": "string"}, "failure": {"message": "string"}}}], "todoist": [{"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 todoist 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": "show_task_comment", "description": "Show a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment.", "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, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["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": "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": "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": "create_sub_task", "description": "Create a new sub_task within a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": true, "description": "The title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the sub_task.", "default": "", "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The priority of the sub_task.", "default": "medium", "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "order_index", "type": "integer", "required": false, "description": "Index at which this sub_task should be inserted in the current list of sub_tasks. 0 to insert at the top of the list, 1 to insert below the first sub_task, etc. You can also use a negative value to insert from the end: -1 to insert at the end, -2 to insert just above the last sub_task, etc.", "default": -1, "constraints": []}], "response_schemas": {"success": {"message": "string", "sub_task_id": 1}, "failure": {"message": "string"}}}, {"api_name": "send_project_invite", "description": "Invite a collaborator to join a project. They will be notified via email.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to invite as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "invite_code": "string"}, "failure": {"message": "string"}}}]}
327
{"splitwise": [{"api_name": "delete_payment_comment", "description": "Delete a comment you posted on a payment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment 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": "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"}}}], "spotify": [{"api_name": "update_album_review", "description": "Update an album review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the album 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": "Album 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": "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": "delete_album_review", "description": "Delete an album review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the album review.", "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", "description": "Get details of a specific song.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song id to retrieve.", "default": null, "constraints": []}], "response_schemas": {"success": {"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "release_date": "2019-01-01T00:00:00", "genre": "string", "play_count": 0.0, "rating": 0.0, "like_count": 1, "review_count": 1, "shareable_link": "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 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": "subscribe_premium", "description": "Subscribe to premium membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy premium subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the premium subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "premium_subscription_id": 1}, "failure": {"message": "string"}}}, {"api_name": "clear_song_queue", "description": "Clear the music player song queue.", "parameters": [{"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"}}}]}
328
{"venmo": [{"api_name": "create_transaction", "description": "Send money to a user.", "parameters": [{"name": "receiver_email", "type": "string", "required": true, "description": "Email address of the receiver.", "default": null, "constraints": ["value is email address"]}, {"name": "amount", "type": "number", "required": true, "description": "Amount of the transaction.", "default": null, "constraints": ["value > 0.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "Description of or note about the transaction.", "default": "", "constraints": []}, {"name": "payment_card_id", "type": "integer", "required": false, "description": "ID of the payment card to use for the transaction. If not passed, Venmo balance will be used.", "default": null, "constraints": []}, {"name": "private", "type": "boolean", "required": false, "description": "Whether the transaction is private or not.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "transaction_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"}}}], "file_system": [{"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": "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"}}}]}
329
{"phone": [{"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 phone 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": "search_contacts", "description": "Search your contact book for relatives' information.", "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": "Search query for the contacts list.", "default": "", "constraints": []}, {"name": "relationship", "type": "string", "required": false, "description": "Relationship with the person in the contacts list to filter by.", "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": [{"contact_id": 1, "first_name": "string", "last_name": "string", "email": "[email protected]", "phone_number": "string", "relationships": ["string"], "birthday": "string", "home_address": "string", "work_address": "string", "created_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}], "todoist": [{"api_name": "delete_attachment", "description": "Delete an attachment of a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment to delete the attachment from.", "default": null, "constraints": []}, {"name": "attachment_file_name", "type": "string", "required": true, "description": "Name of the file attached to the task comment.", "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": "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": "delete_notifications", "description": "Delete all of your notifications.", "parameters": [{"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"}}}]}
330
{"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": "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"}}}], "file_system": [{"api_name": "create_directory", "description": "Create a directory if it does not exist, optionally recursively.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "recursive", "type": "boolean", "required": false, "description": "If True, it will create all parent directories recursively if they don't exist.", "default": false, "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"}}}]}
331
{"splitwise": [{"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"}}}, {"api_name": "update_payment_comment", "description": "Update a payment comment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment comment to update.", "default": null, "constraints": []}, {"name": "comment", "type": "string", "required": true, "description": "The updated comment for the payment.", "default": null, "constraints": ["length >= 1"]}, {"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_comment", "description": "Get information about a comment posted on a payment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment comment.", "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"}}}], "todoist": [{"api_name": "create_sub_task", "description": "Create a new sub_task within a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": true, "description": "The title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the sub_task.", "default": "", "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The priority of the sub_task.", "default": "medium", "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "order_index", "type": "integer", "required": false, "description": "Index at which this sub_task should be inserted in the current list of sub_tasks. 0 to insert at the top of the list, 1 to insert below the first sub_task, etc. You can also use a negative value to insert from the end: -1 to insert at the end, -2 to insert just above the last sub_task, etc.", "default": -1, "constraints": []}], "response_schemas": {"success": {"message": "string", "sub_task_id": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_notifications", "description": "Delete all of your notifications.", "parameters": [{"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": "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_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"}}}, {"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 todoist 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": "create_label", "description": "Create a new label.", "parameters": [{"name": "name", "type": "string", "required": true, "description": "The name of the label.", "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": "The color of the label.", "default": "charcoal", "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}], "response_schemas": {"success": {"message": "string", "label_id": 1}, "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": "delete_label", "description": "Delete a label.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to delete.", "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": "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": "remove_label_from_task", "description": "Remove a label from a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to remove from 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": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_sub_task", "description": "Delete a sub_task.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task to delete.", "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"}}}]}
332
{"amazon": [{"api_name": "search_products", "description": "Search for products with a query and various filtering criteria.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "product_type", "type": "string", "required": false, "description": "The type of product to search for.", "default": null, "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of product to search for.", "default": null, "constraints": []}, {"name": "relative_size", "type": "string", "required": false, "description": "The relative size of product to search for.", "default": null, "constraints": ["value in ['extra-small', 'small', 'medium', 'large', 'extra-large']"]}, {"name": "min_price", "type": "number", "required": false, "description": "The minimum price for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_price", "type": "number", "required": false, "description": "The maximum price for search results.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "min_product_rating", "type": "number", "required": false, "description": "The minimum product rating for search results.", "default": 0, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "max_product_rating", "type": "number", "required": false, "description": "The maximum product rating for search results.", "default": 5, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "min_seller_rating", "type": "number", "required": false, "description": "The minimum seller rating for search results.", "default": 0, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "max_seller_rating", "type": "number", "required": false, "description": "The maximum seller rating for search results.", "default": 5, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "seller_id", "type": "integer", "required": false, "description": "ID of the seller to search for.", "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 products by prefixed with +/- to reflect ascending/descending. Valid attributes: rating, price and delivery_days. 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, "seller_id": 1, "product_type": "string", "name": "string", "description": "string", "price": 0.0, "delivery_days": 1.0, "inventory_quantity": 0.0, "weight": 0.0, "length": 0.0, "width": 0.0, "height": 0.0, "color": "string", "relative_size": "extra-small", "rating": 0.0, "num_product_reviews": 1, "num_product_questions": 1, "variations": [{"product_id": 1, "relative_size": "extra-small", "color": "string"}]}], "failure": {"message": "string"}}}, {"api_name": "remove_promo_code_from_cart", "description": "Remove a promo code from your cart.", "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"}}}], "gmail": [{"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": "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"}}}]}
333
{"file_system": [{"api_name": "move_directory", "description": "Move a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the moved directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_file", "description": "Create a new file with the given content.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "content", "type": "string", "required": false, "description": "The content of the file.", "default": "", "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"}}}], "phone": [{"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": "show_voice_message", "description": "Show voice message details.", "parameters": [{"name": "voice_message_id", "type": "integer", "required": true, "description": "ID of the voice message to show.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "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": "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"}}}]}
334
{"file_system": [{"api_name": "move_directory", "description": "Move a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the moved directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_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"}}}], "splitwise": [{"api_name": "delete_group", "description": "Delete a group you are a member of. Any member can undelete it later.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group 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": "exit_group", "description": "Exit from a group you are a part of.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group to exit.", "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_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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_expense_comments", "description": "Get a list of expense comments.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise 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": [{"expense_comment_id": 1, "expense_id": 1, "comment": "string", "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "show_people_balance", "description": "Show the aggregate amounts you owe to each person and they owe to you.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"you_owe_others": 0.0, "others_owe_you": 0.0, "breakdown": [{"email": "[email protected]", "name": "string", "direction": "you_owe_them", "amount": 0.0}]}, "failure": {"message": "string"}}}, {"api_name": "delete_payment_comment", "description": "Delete a comment you posted on a payment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment 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": "accept_group_invitation", "description": "Accept a group invitation shared with you by one of its members.", "parameters": [{"name": "invitation_code", "type": "string", "required": true, "description": "The group invitation shared with you by one of its members.", "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"}}}]}
335
{"spotify": [{"api_name": "unfollow_artist", "description": "Unfollow an artist.", "parameters": [{"name": "artist_id", "type": "integer", "required": true, "description": "The artist id to unfollow.", "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": "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_liked_songs", "description": "Get a list of songs 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 songs by prefixed with +/- to reflect ascending/descending. Valid attributes: liked_at, play_count and title.", "default": "-liked_at", "constraints": []}], "response_schemas": {"success": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "liked_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "show_following_artists", "description": "Get a list of artists the user is following.", "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": [{"artist_id": 1, "name": "string", "genre": "string", "follower_count": 1, "created_at": "2019-01-01T00:00:00", "followed_at": "2019-01-01T00:00:00"}], "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": "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_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 gmail 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": "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"}}}]}
336
{"simple_note": [{"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": "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"}}}], "phone": [{"api_name": "search_voice_messages", "description": "Show or search text voice_messages between the user and a contact.", "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 voice_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 voice 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": [{"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": "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": "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"}}}]}
337
{"simple_note": [{"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": "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": "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"}}}, {"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"}}}], "todoist": [{"api_name": "search_labels", "description": "Search your or task labels.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "task_id", "type": "integer", "required": false, "description": "The ID of the task to filter by.", "default": null, "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of the label to filter by.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "task_attached", "type": "boolean", "required": false, "description": "If true, and task_id is passed, labels attached to the task will be returned. If false, and task_id is passed, your labels that are not already attached to the task will be returned. It will be ignored if task_id is not passed.", "default": true, "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, <= 9.223372036854776e+18"]}], "response_schemas": {"success": [{"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}], "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"}}}]}
338
{"phone": [{"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_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"}}}], "gmail": [{"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 gmail 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": "show_archived_threads", "description": "Show or search email threads you have archived. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "spam", "type": "boolean", "required": false, "description": "Filter emails by spam status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by attachment status.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "failure": {"message": "string"}}}, {"api_name": "show_email", "description": "Show detailed information about a given email.", "parameters": [{"name": "email_id", "type": "integer", "required": true, "description": "The ID of the email 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_id": 1, "subject": "string", "body": "string", "response_to_email_id": 1, "created_at": "2019-01-01T00:00:00", "sender": {"name": "string", "email": "[email protected]"}, "recipients": [{"name": "string", "email": "[email protected]"}], "attachments": [{"id": 1, "file_name": "string"}]}, "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": "show_inbox_threads", "description": "Show or search email threads you have received. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "archived", "type": "boolean", "required": false, "description": "Filter emails by archived status.", "default": false, "constraints": []}, {"name": "spam", "type": "boolean", "required": false, "description": "Filter emails by spam status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by whether they have an attachment or not.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "failure": {"message": "string"}}}]}
339
{"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": "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": "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 spotify 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": "add_song_to_library", "description": "Add a song to the user's song library.", "parameters": [{"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_album_review", "description": "Show an album review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "The album review id to retrieve.", "default": null, "constraints": []}], "response_schemas": {"success": {"album_review_id": 1, "album_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": "update_song_review", "description": "Update a song review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the song 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": "Song 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": "show_playlist", "description": "Get detailed information about a specific playlist. You can view your own playlists or others' playlists if they are public.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "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", "shareable_link": "string", "songs": [{"id": 1, "title": "string", "artist_ids": [1]}]}, "failure": {"message": "string"}}}, {"api_name": "show_playlist_privates", "description": "Show information about the playlist that is private to the user.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"liked": true, "reviewed": true, "in_playlist_library": true}, "failure": {"message": "string"}}}, {"api_name": "unlike_song", "description": "Unlike a song.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song 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"}}}], "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": "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": "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"}}}, {"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": "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_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"}}}]}
340
{"amazon": [{"api_name": "delete_product_review", "description": "Delete a product review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the product review.", "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": "update_product_quantity_in_cart", "description": "Update product quantity in the user cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be updated in the cart.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "The new quantity of the product to be updated in the cart.", "default": null, "constraints": ["value >= 0.0"]}, {"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_returns", "description": "Get a list of your product returns.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "order_id", "type": "integer", "required": false, "description": "ID of the order to filter returns by.", "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 returns by prefixed with +/- to reflect ascending/descending. Valid attributes: quantity, initiated_at and returned_at.", "default": "-initiated_at", "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": "add_address", "description": "Add a new address.", "parameters": [{"name": "name", "type": "string", "required": true, "description": "Name of the address, for example 'Home' or 'Work'.", "default": null, "constraints": ["length >= 1"]}, {"name": "street_address", "type": "string", "required": true, "description": "Street address line.", "default": null, "constraints": ["length >= 1"]}, {"name": "city", "type": "string", "required": true, "description": "Name of the city.", "default": null, "constraints": ["length >= 1"]}, {"name": "state", "type": "string", "required": true, "description": "Name of the state.", "default": null, "constraints": ["length >= 1"]}, {"name": "country", "type": "string", "required": true, "description": "Name of the country.", "default": null, "constraints": ["length >= 1"]}, {"name": "zip_code", "type": "integer", "required": true, "description": "5-digit zip code of the address.", "default": null, "constraints": ["value >= 10000.0, < 100000.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "address_id": 1}, "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": "download_prime_subscription_receipt", "description": "Download the receipt for a prime subscription.", "parameters": [{"name": "prime_subscription_id", "type": "integer", "required": true, "description": "ID of the prime subscription to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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"}}}, {"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": "clear_cart", "description": "Clear your cart.", "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"}}}], "file_system": [{"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"}}}, {"api_name": "update_file", "description": "Update a file's content.", "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": []}, {"name": "content", "type": "string", "required": true, "description": "The updated content of the file.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "file_path": "string"}, "failure": {"message": "string"}}}]}
341
{"venmo": [{"api_name": "show_profile", "description": "Show public profile information of a user, including your friendship status with them.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"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", "friends_since": "2019-01-01T00:00:00"}, "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"}}}], "splitwise": [{"api_name": "download_expense_receipt_file", "description": "Download a receipt file attachment for an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to download receipt for.", "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": []}, {"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"}}}, {"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_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID 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_payment_receipt_file", "description": "Delete the receipt file from a payment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to delete receipt for.", "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"}}}]}
342
{"venmo": [{"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 venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_card_id": 1}, "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": "search_users", "description": "Search Venmo users by name or email address.", "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": "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", "friends_since": "2019-01-01T00:00:00"}], "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_notifications", "description": "Get a list 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": "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": "payment_request_approved", "title": "string", "message": "string", "read": true, "created_at": "2019-01-01T00:00:00", "data": {}}], "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": "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"}}}]}
343
{"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": "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": "copy_directory", "description": "Copy a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the copied directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "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"}}}], "amazon": [{"api_name": "write_product_question_answer", "description": "Write a answer to a product question.", "parameters": [{"name": "question_id", "type": "integer", "required": true, "description": "ID of the product question this is an answer to.", "default": null, "constraints": []}, {"name": "answer", "type": "string", "required": true, "description": "Answer to the question.", "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_answer_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_product", "description": "Show product information based on its ID.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "The ID of the product.", "default": null, "constraints": []}], "response_schemas": {"success": {"product_id": 1, "seller_id": 1, "product_type": "string", "name": "string", "description": "string", "price": 0.0, "delivery_days": 1.0, "inventory_quantity": 0.0, "weight": 0.0, "length": 0.0, "width": 0.0, "height": 0.0, "color": "string", "relative_size": "extra-small", "rating": 0.0, "num_product_reviews": 1, "num_product_questions": 1, "variations": [{"product_id": 1, "relative_size": "extra-small", "color": "string"}]}, "failure": {"message": "string"}}}, {"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_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": "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"}}}]}
344
{"phone": [{"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": "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_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": "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"}}}], "amazon": [{"api_name": "initiate_return", "description": "Initiate a product return.", "parameters": [{"name": "order_id", "type": "integer", "required": true, "description": "ID of the order to be returned.", "default": null, "constraints": []}, {"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be returned.", "default": null, "constraints": []}, {"name": "deliverer_id", "type": "integer", "required": true, "description": "ID of the deliverer assigned to the return.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "Quantity of the product to be returned.", "default": null, "constraints": ["value >= 1.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "return_id": 1}, "failure": {"message": "string"}}}, {"api_name": "update_product_review", "description": "Update a product review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the product review.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": false, "description": "Product 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": "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": "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": "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": "search_product_types", "description": "Search product types present in the database.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The 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, <= 9.223372036854776e+18"]}], "response_schemas": {"success": ["string"], "failure": {"message": "string"}}}, {"api_name": "update_payment_card", "description": "Update payment card information.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to update.", "default": null, "constraints": []}, {"name": "card_name", "type": "string", "required": true, "description": "Name of the payment card to update.", "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"}, "failure": {"message": "string"}}}, {"api_name": "add_product_to_wish_list", "description": "Add product by id and quantities to your wish list.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be added to the wish list.", "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": "The quantity of the product to be added to the wish list.", "default": 1, "constraints": ["value >= 1.0"]}, {"name": "clear_wish_list_first", "type": "boolean", "required": false, "description": "If true, the wish list will be cleared before adding the product to the wish list.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_prime_plans", "description": "Show information about prime plans available. Delivery fee is waived for prime members.", "parameters": [], "response_schemas": {"success": {"monthly": 1, "yearly": 1}, "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"}}}]}
345
{"amazon": [{"api_name": "download_prime_subscription_receipt", "description": "Download the receipt for a prime subscription.", "parameters": [{"name": "prime_subscription_id", "type": "integer", "required": true, "description": "ID of the prime subscription to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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"}}}, {"api_name": "delete_account", "description": "Delete 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"}}}], "file_system": [{"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": "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"}}}]}
346
{"splitwise": [{"api_name": "mark_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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_no_group_expenses", "description": "Show or search your expenses that are not part of any group based on various criteria.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "participant_email", "type": "string", "required": false, "description": "Email of the payer or debtors to filter expenses.", "default": null, "constraints": ["value is email address"]}, {"name": "min_amount", "type": "number", "required": false, "description": "Filter expenses by minimum amount.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_amount", "type": "number", "required": false, "description": "Filter expenses by maximum amount.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "deleted", "type": "boolean", "required": false, "description": "Whether to limit the results to expenses marked as deleted or not.", "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 expenses 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": [{"expense_id": 1, "group_id": 1, "description": "string", "deleted": true, "receipt_file_name": "string", "created_at": "2019-01-01T00:00:00", "shares": [{"debtor": {"name": "string", "email": "[email protected]"}, "debt_amount": 0.0}], "creator": {"name": "string", "email": "[email protected]"}, "payer": {"name": "string", "email": "[email protected]"}, "paid_amount": 0.0}], "failure": {"message": "string"}}}, {"api_name": "undelete_group", "description": "Undelete a group you are a member of.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group to undelete.", "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": "exit_group", "description": "Exit from a group you are a part of.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group to exit.", "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"}}}], "phone": [{"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": "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": "get_current_date_and_time", "description": "Show current date and time.", "parameters": [], "response_schemas": {"success": {"date": "string", "time": "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"}}}]}
347
{"phone": [{"api_name": "delete_text_message", "description": "Delete a text message.", "parameters": [{"name": "text_message_id", "type": "integer", "required": true, "description": "ID of the text message 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"}}}, {"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_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 phone 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": "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": "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"}}}], "splitwise": [{"api_name": "update_expense_comment", "description": "Update a comment you posted on an expense.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the expense comment to update.", "default": null, "constraints": []}, {"name": "comment", "type": "string", "required": true, "description": "The updated comment for the expense.", "default": null, "constraints": ["length >= 1"]}, {"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_person_balance", "description": "Show the amounts you and a given person owe to each other, broken down by group. The non-grouped expenses/payments will be shown as a group with ID None.", "parameters": [{"name": "email", "type": "string", "required": true, "description": "The email of the person to show your 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": []}], "response_schemas": {"success": {"direction": "you_owe_them", "total": 0.0, "breakdown": [{"group_id": 1, "group_name": "string", "direction": "you_owe_them", "amount": 0.0}]}, "failure": {"message": "string"}}}, {"api_name": "add_member_to_group", "description": "Add a member to a group.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group.", "default": null, "constraints": []}, {"name": "user_email", "type": "string", "required": true, "description": "Email of the user to add to the group.", "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": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_payment_comment", "description": "Delete a comment you posted on a payment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment 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": "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"}}}, {"api_name": "download_expense_receipt_file", "description": "Download a receipt file attachment for an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to download receipt for.", "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": []}, {"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"}}}, {"api_name": "attach_payment_receipt_file", "description": "Attach a receipt file to a payment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to attach receipt to.", "default": null, "constraints": []}, {"name": "receipt_file_path", "type": "string", "required": true, "description": "The file path of the receipt file to attach to this payment.", "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": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the existing receipt file if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_payment", "description": "Update payment information.", "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": []}, {"name": "amount", "type": "number", "required": false, "description": "The updated amount of the payment.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The updated note or description of the payment.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
348
{"todoist": [{"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": "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": "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": "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_task", "description": "Update task information.", "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": []}, {"name": "title", "type": "string", "required": false, "description": "The updated title of the task.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the task.", "default": null, "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The updated due date of the task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "duration", "type": "number", "required": false, "description": "The updated duration of the task.", "default": null, "constraints": []}, {"name": "duration_unit", "type": "string", "required": false, "description": "The updated unit of the task duration.", "default": null, "constraints": ["value in ['minutes', 'hours', 'days']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "Whether the task is completed.", "default": null, "constraints": []}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated order index of this task in the list of section tasks.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The updated priority of the task.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_attachment", "description": "Delete an attachment of a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment to delete the attachment from.", "default": null, "constraints": []}, {"name": "attachment_file_name", "type": "string", "required": true, "description": "Name of the file attached to the task comment.", "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"}}}], "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": "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": "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": "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"}}}, {"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": "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"}}}]}
349
{"todoist": [{"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 todoist 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": "mark_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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": "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": "update_section", "description": "Update section information.", "parameters": [{"name": "section_id", "type": "integer", "required": true, "description": "The ID of the section.", "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 section.", "default": null, "constraints": ["length >= 1"]}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated order index of this section in the list of project sections.", "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 todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "gmail": [{"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 gmail 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": "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": "create_draft", "description": "Create a new draft.", "parameters": [{"name": "recipient_email_addresses", "type": "list[string]", "required": true, "description": "List of recipient email addresses.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": true, "description": "The body of the draft.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": false, "description": "The subject of the draft. Must be None if it's a reply to an email.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "The ID of the email thread that the draft should belong to. Must be passed if it's a reply to or forward of an email.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "The ID of the email in the thread that the draft should responds to.", "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 draft.", "default": null, "constraints": []}, {"name": "scheduled_send_at", "type": "string", "required": false, "description": "If set, the draft will be sent at the specified future time in YYYY-MM-DD|HH:MM:SS format. Otherwise, it will not be sent until you manually send it.", "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", "draft_id": 1}, "failure": {"message": "string"}}}, {"api_name": "forward_email_from_thread", "description": "Forward an email from an 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_id", "type": "integer", "required": true, "description": "The ID of the email 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": "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": "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"}}}, {"api_name": "show_drafts", "description": "Show a list of user drafts.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "recipient_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter drafts by attachment status.", "default": null, "constraints": []}, {"name": "scheduled", "type": "boolean", "required": false, "description": "Filter drafts by whether they are scheduled to be sent in the future.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "Filter drafts by email thread ID that the draft belongs to.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "Filter drafts by email ID that the draft responds to.", "default": null, "constraints": []}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter drafts by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter drafts by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 drafts 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": [{"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": "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"}}}]}
350
{"file_system": [{"api_name": "show_file", "description": "Show a file's content and other details, if it 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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"file_id": 1, "path": "string", "content": "string", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00"}, "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"}}}, {"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": "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"}}}], "todoist": [{"api_name": "show_task_comment", "description": "Show a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment.", "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, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["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"}}}, {"api_name": "search_labels", "description": "Search your or task labels.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "task_id", "type": "integer", "required": false, "description": "The ID of the task to filter by.", "default": null, "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of the label to filter by.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "task_attached", "type": "boolean", "required": false, "description": "If true, and task_id is passed, labels attached to the task will be returned. If false, and task_id is passed, your labels that are not already attached to the task will be returned. It will be ignored if task_id is not passed.", "default": true, "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, <= 9.223372036854776e+18"]}], "response_schemas": {"success": [{"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}], "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 todoist 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": "show_task_comments", "description": "Get a list of task comments.", "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": []}, {"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": [{"task_id": 1, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["string"]}], "failure": {"message": "string"}}}, {"api_name": "update_task_comment", "description": "Update a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "content", "type": "string", "required": false, "description": "The updated content of the comment.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "upload_attachment", "description": "Upload an attachment to a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the task comment to attach the file to.", "default": null, "constraints": []}, {"name": "upload_from_file_path", "type": "string", "required": true, "description": "The file path in file system app to upload as an attachment.", "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 todoist app login.", "default": null, "constraints": []}, {"name": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the attachment if one with the same name already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "attachment_file_name": "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 todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
351
{"simple_note": [{"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": "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": "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": "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_product", "description": "Show product information based on its ID.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "The ID of the product.", "default": null, "constraints": []}], "response_schemas": {"success": {"product_id": 1, "seller_id": 1, "product_type": "string", "name": "string", "description": "string", "price": 0.0, "delivery_days": 1.0, "inventory_quantity": 0.0, "weight": 0.0, "length": 0.0, "width": 0.0, "height": 0.0, "color": "string", "relative_size": "extra-small", "rating": 0.0, "num_product_reviews": 1, "num_product_questions": 1, "variations": [{"product_id": 1, "relative_size": "extra-small", "color": "string"}]}, "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"}}}]}
352
{"gmail": [{"api_name": "mark_thread_archived", "description": "Mark an email thread as archived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to archive.", "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": "remove_attachment_from_draft", "description": "Delete an attachment from a draft.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to delete the attachment from.", "default": null, "constraints": []}, {"name": "attachment_id", "type": "integer", "required": true, "description": "The ID of the attachment 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": "show_inbox_threads", "description": "Show or search email threads you have received. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "archived", "type": "boolean", "required": false, "description": "Filter emails by archived status.", "default": false, "constraints": []}, {"name": "spam", "type": "boolean", "required": false, "description": "Filter emails by spam status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by whether they have an attachment or not.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "failure": {"message": "string"}}}, {"api_name": "delete_draft", "description": "Delete draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft 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": "show_archived_threads", "description": "Show or search email threads you have archived. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "spam", "type": "boolean", "required": false, "description": "Filter emails by spam status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by attachment status.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "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": "add_member_to_group", "description": "Add a member to a group.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group.", "default": null, "constraints": []}, {"name": "user_email", "type": "string", "required": true, "description": "Email of the user to add to the group.", "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": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_payment", "description": "Show payment details based on its ID.", "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_id": 1, "group_id": 1, "description": "string", "deleted": true, "receipt_file_name": "string", "created_at": "2019-01-01T00:00:00", "creator": {"name": "string", "email": "[email protected]"}, "payer": {"name": "string", "email": "[email protected]"}, "receiver": {"name": "string", "email": "[email protected]"}, "paid_amount": 0.0}, "failure": {"message": "string"}}}]}
353
{"file_system": [{"api_name": "show_file", "description": "Show a file's content and other details, if it 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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"file_id": 1, "path": "string", "content": "string", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00"}, "failure": {"message": "string"}}}, {"api_name": "delete_file", "description": "Delete a file.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "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"}}}], "simple_note": [{"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"}}}, {"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_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": "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_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": "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": "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": "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": "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": "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": "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"}}}]}
354
{"amazon": [{"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": "search_sellers", "description": "Search for sellers with a query.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The 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": [{"seller_id": 1, "name": "string"}], "failure": {"message": "string"}}}, {"api_name": "apply_promo_code_to_cart", "description": "Apply a promo code to your cart.", "parameters": [{"name": "promo_code", "type": "string", "required": true, "description": "The promo code to be applied to 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": "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": "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_payment_cards", "description": "Get a list of your payment_cards.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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_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"}}}], "todoist": [{"api_name": "delete_label", "description": "Delete a label.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to delete.", "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": "remove_collaborator_from_project", "description": "Remove a collaborator (or self) from a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to remove as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"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": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID of the notification to delete.", "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": "delete_notifications", "description": "Delete all of your notifications.", "parameters": [{"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"}}}]}
355
{"spotify": [{"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"}}}, {"api_name": "loop_song", "description": "Set whether to loop the current song.", "parameters": [{"name": "loop", "type": "boolean", "required": true, "description": "Whether to loop the current song.", "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": "unlike_song", "description": "Unlike a song.", "parameters": [{"name": "song_id", "type": "integer", "required": true, "description": "The song 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"}}}], "amazon": [{"api_name": "initiate_return", "description": "Initiate a product return.", "parameters": [{"name": "order_id", "type": "integer", "required": true, "description": "ID of the order to be returned.", "default": null, "constraints": []}, {"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be returned.", "default": null, "constraints": []}, {"name": "deliverer_id", "type": "integer", "required": true, "description": "ID of the deliverer assigned to the return.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "Quantity of the product to be returned.", "default": null, "constraints": ["value >= 1.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "return_id": 1}, "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"}}}, {"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": "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": "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"}}}, {"api_name": "delete_account", "description": "Delete 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"}}}]}
356
{"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": "copy_directory", "description": "Copy a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the copied directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "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 file_system 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": "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"}}}], "todoist": [{"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"}}}, {"api_name": "search_labels", "description": "Search your or task labels.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "task_id", "type": "integer", "required": false, "description": "The ID of the task to filter by.", "default": null, "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of the label to filter by.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "task_attached", "type": "boolean", "required": false, "description": "If true, and task_id is passed, labels attached to the task will be returned. If false, and task_id is passed, your labels that are not already attached to the task will be returned. It will be ignored if task_id is not passed.", "default": true, "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, <= 9.223372036854776e+18"]}], "response_schemas": {"success": [{"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}], "failure": {"message": "string"}}}, {"api_name": "show_task", "description": "Show detailed information about the 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": {"project_id": 1, "section_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, "assignee_id": 1, "assigner_id": 1, "created_at": "2019-01-01T00:00:00", "task_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}], "creator": {"name": "string", "email": "[email protected]"}, "num_sub_tasks": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_label", "description": "Delete a label.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to delete.", "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": "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": "update_sub_task", "description": "Update sub_task information.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "The updated title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the sub_task.", "default": null, "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The updated due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The updated priority of the sub_task.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "The updated completion status of the sub_task. True if completed, False otherwise.", "default": null, "constraints": []}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated index at which this sub_task should be inserted in the current list of sub_tasks.", "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": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID of the notification to delete.", "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": "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"}}}, {"api_name": "remove_collaborator_from_project", "description": "Remove a collaborator (or self) from a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to remove as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"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"}}}]}
357
{"venmo": [{"api_name": "unlike_transaction", "description": "Unlike a transaction.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to unlike.", "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": "approve_payment_request", "description": "Approve a payment request.", "parameters": [{"name": "payment_request_id", "type": "integer", "required": true, "description": "ID of the payment request to approve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "payment_card_id", "type": "integer", "required": false, "description": "ID of the payment card to use for approving the payment request. If not passed, Venmo balance will be used.", "default": null, "constraints": []}], "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 venmo 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": "payment_request_approved", "title": "string", "message": "string", "read": true, "created_at": "2019-01-01T00:00:00", "data": {}}], "failure": {"message": "string"}}}], "amazon": [{"api_name": "search_sellers", "description": "Search for sellers with a query.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The 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": [{"seller_id": 1, "name": "string"}], "failure": {"message": "string"}}}, {"api_name": "show_order", "description": "Get details of a past order.", "parameters": [{"name": "order_id", "type": "integer", "required": true, "description": "ID of the order to be shown.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"order_id": 1, "address_id": 1, "payment_card_id": 1, "name": "string", "tax": 0.0, "delivery_fee": 0.0, "gift_wrap_fee": 0.0, "discount": 0.0, "created_at": "2019-01-01T00:00:00", "address_text": "string", "payment_card_digits": "string", "paid_amount": 0.0, "order_items": [{"product_id": 1, "ordered_quantity": 1, "returned_quantity": 1, "gift_wrap_quantity": 1, "price": 0.0, "expected_delivery_at": "2019-01-01T00:00:00", "delivered_at": "2019-01-01T00:00:00"}]}, "failure": {"message": "string"}}}, {"api_name": "download_prime_subscription_receipt", "description": "Download the receipt for a prime subscription.", "parameters": [{"name": "prime_subscription_id", "type": "integer", "required": true, "description": "ID of the prime subscription to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon 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"}}}, {"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"}}}, {"api_name": "add_product_to_cart", "description": "Add product by id and quantities to your cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be added to the 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": "The quantity of the product to be added to the cart.", "default": 1, "constraints": ["value >= 1.0"]}, {"name": "clear_cart_first", "type": "boolean", "required": false, "description": "If true, the cart will be cleared before adding the product to the cart.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "update_product_review", "description": "Update a product review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the product review.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "rating", "type": "integer", "required": false, "description": "Product 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": "show_product_feature_choices", "description": "Show the choices of colors, relative sizes and sellers aggregated over all products of the given product type. Because it's an aggregation, the choices may not be available for all products. If product type is not passed, it will return the choices for all products in the database.", "parameters": [{"name": "product_type", "type": "string", "required": false, "description": "The product type to obtain feature choices for.", "default": null, "constraints": []}], "response_schemas": {"success": {"colors": ["string"], "relative_sizes": ["extra-small"], "sellers": [{"seller_id": 1, "name": "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"}}}]}
358
{"spotify": [{"api_name": "previous_song", "description": "Go to the previous song in the song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "song_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_playlist_privates", "description": "Show information about the playlist that is private to the user.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"liked": true, "reviewed": true, "in_playlist_library": true}, "failure": {"message": "string"}}}, {"api_name": "show_genres", "description": "Show the list of all music genres.", "parameters": [], "response_schemas": {"success": ["string"], "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": "subscribe_premium", "description": "Subscribe to premium membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy premium subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the premium subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "premium_subscription_id": 1}, "failure": {"message": "string"}}}], "gmail": [{"api_name": "mark_thread_unarchived", "description": "Mark an email thread as unarchived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unarchive.", "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": "mark_thread_unstarred", "description": "Mark an email thread as unstarred.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unstar.", "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_email", "description": "Show detailed information about a given email.", "parameters": [{"name": "email_id", "type": "integer", "required": true, "description": "The ID of the email 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_id": 1, "subject": "string", "body": "string", "response_to_email_id": 1, "created_at": "2019-01-01T00:00:00", "sender": {"name": "string", "email": "[email protected]"}, "recipients": [{"name": "string", "email": "[email protected]"}], "attachments": [{"id": 1, "file_name": "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 gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "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": "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": "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": "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_draft", "description": "Update draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to update.", "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.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": false, "description": "The updated subject of the draft.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": false, "description": "The updated body of the draft.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "The updated ID of the email thread that the draft should belong to. Must be passed if it's a reply to an email.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "The updated ID of the email in the thread that the draft is a response to.", "default": null, "constraints": []}, {"name": "scheduled_send_at", "type": "string", "required": false, "description": "The updated time at which the draft should be sent in YYYY-MM-DD|HH:MM:SS format.To remove the scheduled delivery, pass 'None' string, as leaving it empty or null is for when you don't want to update it.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
359
{"gmail": [{"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": "mark_thread_unstarred", "description": "Mark an email thread as unstarred.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unstar.", "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"}}}], "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": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID 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"}}}]}
360
{"amazon": [{"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"}}}, {"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": "show_orders", "description": "Show or search your past orders", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"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"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the orders 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": [{"order_id": 1, "address_id": 1, "payment_card_id": 1, "name": "string", "tax": 0.0, "delivery_fee": 0.0, "gift_wrap_fee": 0.0, "discount": 0.0, "created_at": "2019-01-01T00:00:00", "address_text": "string", "payment_card_digits": "string", "paid_amount": 0.0, "order_items": [{"product_id": 1, "ordered_quantity": 1, "returned_quantity": 1, "gift_wrap_quantity": 1, "price": 0.0, "expected_delivery_at": "2019-01-01T00:00:00", "delivered_at": "2019-01-01T00:00:00"}]}], "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": "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 venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_card_id": 1}, "failure": {"message": "string"}}}]}
361
{"venmo": [{"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"}}}, {"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"}}}, {"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": "unlike_transaction_comment", "description": "Unlike a previously liked 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": "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"}}}], "amazon": [{"api_name": "update_product_question_answer", "description": "Update answer to a product question.", "parameters": [{"name": "question_answer_id", "type": "integer", "required": true, "description": "ID of the question answer to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "answer", "type": "string", "required": false, "description": "The updated answer for the question.", "default": null, "constraints": ["length >= 1"]}], "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": "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": "clear_cart", "description": "Clear your cart.", "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"}}}]}
362
{"splitwise": [{"api_name": "delete_payment_comment", "description": "Delete a comment you posted on a payment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment 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_notification", "description": "Mark a notification as read or unread.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "ID of the notification to mark.", "default": null, "constraints": []}, {"name": "read", "type": "boolean", "required": true, "description": "Mark the notification as read or unread.", "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": "move_directory", "description": "Move a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the moved directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "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"}}}, {"api_name": "update_file", "description": "Update a file's content.", "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": []}, {"name": "content", "type": "string", "required": true, "description": "The updated content of the file.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "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": "create_directory", "description": "Create a directory if it does not exist, optionally recursively.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "recursive", "type": "boolean", "required": false, "description": "If True, it will create all parent directories recursively if they don't exist.", "default": false, "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"}}}]}
363
{"splitwise": [{"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"}}}, {"api_name": "download_expense_receipt_file", "description": "Download a receipt file attachment for an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to download receipt for.", "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": []}, {"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"}}}, {"api_name": "delete_payment_receipt_file", "description": "Delete the receipt file from a payment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to delete receipt for.", "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"}}}], "todoist": [{"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": "remove_collaborator_from_project", "description": "Remove a collaborator (or self) from a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to remove as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"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": "send_project_invite", "description": "Invite a collaborator to join a project. They will be notified via email.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to invite as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "invite_code": "string"}, "failure": {"message": "string"}}}, {"api_name": "assign_or_unassign_task", "description": "Assign or unassign a task to a user. If assignee_email is null, the task will be unassigned.", "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": []}, {"name": "assignee_email", "type": "string", "required": false, "description": "Email of the user to assign the task to.", "default": null, "constraints": ["value is email address"]}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_projects", "description": "Show or search a list of your projects.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query for projects.", "default": "", "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of the project to filter by.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "is_favorite", "type": "boolean", "required": false, "description": "Project's favorite status to filter by.", "default": null, "constraints": []}, {"name": "is_archived", "type": "boolean", "required": false, "description": "Project's archival status to filter by.", "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, <= 9.223372036854776e+18"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the projects 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": [{"name": "string", "color": "charcoal", "is_inbox": true, "description": "string", "is_favorite": true, "is_archived": true, "created_at": "2019-01-01T00:00:00", "project_id": 1, "creator": {"name": "string", "email": "[email protected]"}, "num_tasks": 1, "sections": [{"id": 1, "name": "string", "num_tasks": 1}], "collaborators": [{"name": "string", "email": "[email protected]"}], "pending_invites": [{"invite_code": "string", "invitee": {"name": "string", "email": "[email protected]"}, "inviter": {"name": "string", "email": "[email protected]"}}], "is_shared": true}], "failure": {"message": "string"}}}]}
364
{"phone": [{"api_name": "delete_text_message", "description": "Delete a text message.", "parameters": [{"name": "text_message_id", "type": "integer", "required": true, "description": "ID of the text message 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"}}}, {"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"}}}, {"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"}}}], "gmail": [{"api_name": "show_email", "description": "Show detailed information about a given email.", "parameters": [{"name": "email_id", "type": "integer", "required": true, "description": "The ID of the email 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_id": 1, "subject": "string", "body": "string", "response_to_email_id": 1, "created_at": "2019-01-01T00:00:00", "sender": {"name": "string", "email": "[email protected]"}, "recipients": [{"name": "string", "email": "[email protected]"}], "attachments": [{"id": 1, "file_name": "string"}]}, "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": "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"}}}]}
365
{"simple_note": [{"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"}}}, {"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"}}}, {"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"}}}], "spotify": [{"api_name": "subscribe_premium", "description": "Subscribe to premium membership.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to use for buy premium subscription.", "default": null, "constraints": []}, {"name": "duration", "type": "string", "required": true, "description": "Duration of the premium subscription.", "default": null, "constraints": ["value in ['monthly', 'yearly']"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "premium_subscription_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_liked_songs", "description": "Get a list of songs 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 songs by prefixed with +/- to reflect ascending/descending. Valid attributes: liked_at, play_count and title.", "default": "-liked_at", "constraints": []}], "response_schemas": {"success": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "liked_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "delete_account", "description": "Delete your account.", "parameters": [{"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_downloaded_songs", "description": "Get a list of downloaded songs.", "parameters": [{"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": "min_downloaded_at", "type": "string", "required": false, "description": "Filter songs by minimum downloaded_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_downloaded_at", "type": "string", "required": false, "description": "Filter songs by maximum downloaded_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 downloaded songs by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at and downloaded_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 -downloaded_at.", "default": null, "constraints": []}], "response_schemas": {"success": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "downloaded_at": "2019-01-01T00:00:00"}], "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": "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_playlist_privates", "description": "Show information about the playlist that is private to the user.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"liked": true, "reviewed": true, "in_playlist_library": true}, "failure": {"message": "string"}}}, {"api_name": "next_song", "description": "Go to the next song in the song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "song_id": 1}, "failure": {"message": "string"}}}, {"api_name": "remove_song_from_playlist", "description": "Remove a song from a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist id to remove the song from.", "default": null, "constraints": []}, {"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": "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"}}}]}
366
{"spotify": [{"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": "show_artist_following", "description": "Show if the user is following the artist.", "parameters": [{"name": "artist_id", "type": "integer", "required": true, "description": "The artist id to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"following": true}, "failure": {"message": "string"}}}, {"api_name": "add_to_queue", "description": "Add a song, album or playlist to the music player song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "song_id", "type": "integer", "required": false, "description": "ID of the song to add to queue.", "default": null, "constraints": []}, {"name": "album_id", "type": "integer", "required": false, "description": "ID of the album to add to queue.", "default": null, "constraints": []}, {"name": "playlist_id", "type": "integer", "required": false, "description": "ID of the playlist to add to queue.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "next_song", "description": "Go to the next song in the song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "song_id": 1}, "failure": {"message": "string"}}}, {"api_name": "pause_music", "description": "Pause the currently playing song.", "parameters": [{"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": "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"}}}, {"api_name": "show_volume", "description": "Get the volume level of the music player.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"volume": 1}, "failure": {"message": "string"}}}], "gmail": [{"api_name": "show_archived_threads", "description": "Show or search email threads you have archived. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "spam", "type": "boolean", "required": false, "description": "Filter emails by spam status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by attachment status.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "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": "delete_draft", "description": "Delete draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft 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"}}}]}
367
{"todoist": [{"api_name": "delete_label", "description": "Delete a label.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to delete.", "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": "delete_project", "description": "Delete a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project to delete.", "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"}}}], "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": "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": "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": "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"}}}, {"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": "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"}}}, {"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"}}}]}
368
{"venmo": [{"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": "search_friends", "description": "Search your or others' friends by name or email address.", "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 friends by name or email address.", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "Email address of the user whose friends you want to see. If not passed, your friends will be returned.", "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"]}], "response_schemas": {"success": [{"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00", "friends_since": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}], "todoist": [{"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 todoist 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": "update_section", "description": "Update section information.", "parameters": [{"name": "section_id", "type": "integer", "required": true, "description": "The ID of the section.", "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 section.", "default": null, "constraints": ["length >= 1"]}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated order index of this section in the list of project sections.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}]}
369
{"simple_note": [{"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": "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"}}}], "file_system": [{"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": "show_file", "description": "Show a file's content and other details, if it 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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"file_id": 1, "path": "string", "content": "string", "created_at": "2019-01-01T00:00:00", "updated_at": "2019-01-01T00:00:00"}, "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"}}}]}
370
{"gmail": [{"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": "delete_account", "description": "Delete your account.", "parameters": [{"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": "delete_draft", "description": "Delete draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft 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": "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": "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"}}}], "spotify": [{"api_name": "move_song_in_queue", "description": "Move a song in the queue to a new position.", "parameters": [{"name": "current_position", "type": "integer", "required": true, "description": "The current position of the song in the queue.", "default": null, "constraints": ["value >= 0.0"]}, {"name": "new_position", "type": "integer", "required": true, "description": "The new position of the song in the queue.", "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": "loop_song", "description": "Set whether to loop the current song.", "parameters": [{"name": "loop", "type": "boolean", "required": true, "description": "Whether to loop the current song.", "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_following_artists", "description": "Get a list of artists the user is following.", "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": [{"artist_id": 1, "name": "string", "genre": "string", "follower_count": 1, "created_at": "2019-01-01T00:00:00", "followed_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}]}
371
{"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": "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": "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"}}}], "spotify": [{"api_name": "update_album_review", "description": "Update an album review.", "parameters": [{"name": "review_id", "type": "integer", "required": true, "description": "ID of the album 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": "Album 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": "update_payment_card", "description": "Update payment card information.", "parameters": [{"name": "payment_card_id", "type": "integer", "required": true, "description": "ID of the payment card to update.", "default": null, "constraints": []}, {"name": "card_name", "type": "string", "required": true, "description": "Name of the payment card to update.", "default": null, "constraints": ["length >= 1"]}, {"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": "search_songs", "description": "Search for songs with a query.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "artist_id", "type": "integer", "required": false, "description": "The artist id to filter the search results by.", "default": null, "constraints": []}, {"name": "album_id", "type": "integer", "required": false, "description": "The album id to filter the search results by.", "default": null, "constraints": []}, {"name": "genre", "type": "string", "required": false, "description": "The genre to filter the albums by.", "default": null, "constraints": []}, {"name": "min_release_date", "type": "string", "required": false, "description": "The minimum release date for search results in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_release_date", "type": "string", "required": false, "description": "The maximum release date for search results in YYYY-MM-DD format.", "default": "3000-01-01", "constraints": []}, {"name": "min_duration", "type": "integer", "required": false, "description": "The minimum duration in seconds for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_duration", "type": "integer", "required": false, "description": "The maximum duration in seconds for search results.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "min_rating", "type": "number", "required": false, "description": "The minimum rating for search results.", "default": 0, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "max_rating", "type": "number", "required": false, "description": "The maximum rating for search results.", "default": 5, "constraints": ["value >= 0.0, <= 5.0"]}, {"name": "min_like_count", "type": "integer", "required": false, "description": "The minimum like count for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_like_count", "type": "integer", "required": false, "description": "The maximum like count for search results.", "default": 9223372036854775807, "constraints": ["value >= 0.0"]}, {"name": "min_play_count", "type": "integer", "required": false, "description": "The minimum play count for search results.", "default": 0, "constraints": ["value >= 0.0"]}, {"name": "max_play_count", "type": "integer", "required": false, "description": "The maximum play count 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 songs by prefixed with +/- to reflect ascending/descending. Valid attributes: rating, like_count and play_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": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "release_date": "2019-01-01T00:00:00", "genre": "string", "play_count": 0.0, "rating": 0.0, "like_count": 1, "review_count": 1, "shareable_link": "string"}], "failure": {"message": "string"}}}, {"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": "download_premium_subscription_receipt", "description": "Download the receipt for a premium subscription.", "parameters": [{"name": "premium_subscription_id", "type": "integer", "required": true, "description": "ID of the premium subscription to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify 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"}}}]}
372
{"venmo": [{"api_name": "show_transaction", "description": "Show transaction details.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to retrieve.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "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"}}}, {"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": "unlike_transaction", "description": "Unlike a transaction.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to unlike.", "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": "create_transaction_comment", "description": "Create a new transaction comment.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to comment on.", "default": null, "constraints": []}, {"name": "comment", "type": "string", "required": true, "description": "Comment on the transaction.", "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", "comment_id": 1}, "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"}}}], "simple_note": [{"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": "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": "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"}}}]}
373
{"todoist": [{"api_name": "show_sections", "description": "Get a list of sections 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": []}], "response_schemas": {"success": [{"project_id": 1, "name": "string", "order_index": 0.0, "created_at": "2019-01-01T00:00:00", "section_id": 1, "num_tasks": 1}], "failure": {"message": "string"}}}, {"api_name": "update_sub_task", "description": "Update sub_task information.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": false, "description": "The updated title of the sub_task.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the sub_task.", "default": null, "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The updated due date of the sub_task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The updated priority of the sub_task.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "The updated completion status of the sub_task. True if completed, False otherwise.", "default": null, "constraints": []}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated index at which this sub_task should be inserted in the current list of sub_tasks.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"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": "delete_account", "description": "Delete your account.", "parameters": [{"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": "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"}}}], "spotify": [{"api_name": "show_recommendations", "description": "Get personalized song recommendations for the user.", "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": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}]}], "failure": {"message": "string"}}}, {"api_name": "show_album_reviews", "description": "Get a list of reviews for an album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve 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": "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 album 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": [{"album_review_id": 1, "album_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"}}}]}
374
{"splitwise": [{"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": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID 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": "attach_payment_receipt_file", "description": "Attach a receipt file to a payment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to attach receipt to.", "default": null, "constraints": []}, {"name": "receipt_file_path", "type": "string", "required": true, "description": "The file path of the receipt file to attach to this payment.", "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": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the existing receipt file if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "show_people_balance", "description": "Show the aggregate amounts you owe to each person and they owe to you.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"you_owe_others": 0.0, "others_owe_you": 0.0, "breakdown": [{"email": "[email protected]", "name": "string", "direction": "you_owe_them", "amount": 0.0}]}, "failure": {"message": "string"}}}, {"api_name": "delete_payment_comment", "description": "Delete a comment you posted on a payment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "The ID of the payment 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": "record_expense", "description": "Record a new expense to share with others.", "parameters": [{"name": "description", "type": "string", "required": true, "description": "A short note or description of the expense.", "default": null, "constraints": []}, {"name": "paid_amount", "type": "number", "required": true, "description": "The total amount of the expense paid.", "default": null, "constraints": []}, {"name": "payer_email", "type": "string", "required": true, "description": "Email of the user who paid for the expense.", "default": null, "constraints": ["value is email address"]}, {"name": "debtor_emails", "type": "list[string]", "required": true, "description": "Emails of the users who owe a share of the expense.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "debt_amounts", "type": "list[number]", "required": false, "description": "The amounts owed by each debtor. If not passed, it is assumed that each debtor owes an equal share. If passed, the list must be of the same length as debtor_ids.", "default": null, "constraints": []}, {"name": "group_id", "type": "integer", "required": false, "description": "The ID of the group this expense should belong to. Keep it none if it should not belong to any group.", "default": null, "constraints": []}, {"name": "receipt_file_path", "type": "string", "required": false, "description": "Absolute file path (starting with /) from the file_system app to attach as a receipt for this expense.", "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", "expense_id": 1}, "failure": {"message": "string"}}}, {"api_name": "create_group", "description": "Create a new group of friends or family to share expenses with.", "parameters": [{"name": "name", "type": "string", "required": true, "description": "The name of the group.", "default": null, "constraints": ["length >= 1"]}, {"name": "member_emails", "type": "list[string]", "required": true, "description": "Emails of the users to add to the group besides yourself.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the group.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "group_id": 1}, "failure": {"message": "string"}}}, {"api_name": "update_group", "description": "Update group information.", "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": []}, {"name": "name", "type": "string", "required": false, "description": "The updated name of the group.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the group.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "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"}}}, {"api_name": "exit_group", "description": "Exit from a group you are a part of.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group to exit.", "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": "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"}}}, {"api_name": "show_groups_balance", "description": "Show the aggregate amounts you owe to others or others owe you for each group you are member of. The non-grouped expenses/payments will be shown as a group with group_id of None.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"you_owe_others": 0.0, "others_owe_you": 0.0, "breakdown": [{"group_id": 1, "group_name": "string", "you_owe_others": 0.0, "others_owe_you": 0.0}]}, "failure": {"message": "string"}}}], "todoist": [{"api_name": "show_label", "description": "Show label details based on its ID.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}, {"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"}}}]}
375
{"todoist": [{"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": "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"}}}], "simple_note": [{"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"}}}]}
376
{"venmo": [{"api_name": "download_bank_transfer_receipt", "description": "Download the receipt of money transfer from Venmo to payment card or vice versa.", "parameters": [{"name": "bank_transfer_id", "type": "integer", "required": true, "description": "ID of the bank transfer 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"}}}, {"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 venmo app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "payment_card_id": 1}, "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": "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"}}}], "gmail": [{"api_name": "logout", "description": "Logout from your account.", "parameters": [{"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", "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": "delete_draft", "description": "Delete draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft 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"}}}]}
377
{"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": "mark_thread_unarchived", "description": "Mark an email thread as unarchived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unarchive.", "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"}}}], "simple_note": [{"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": "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": "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"}}}]}
378
{"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": "upload_attachments_to_draft", "description": "Upload attachments to a draft.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to upload the attachment to.", "default": null, "constraints": []}, {"name": "attachment_file_paths", "type": "list[string]", "required": true, "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": 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": "overwrite", "type": "boolean", "required": false, "description": "Whether to overwrite the attachment if it already exists.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "attachment_ids": [1]}, "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 gmail 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"}, "failure": {"message": "string"}}}], "todoist": [{"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"}}}, {"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": "delete_label", "description": "Delete a label.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to delete.", "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": "update_section", "description": "Update section information.", "parameters": [{"name": "section_id", "type": "integer", "required": true, "description": "The ID of the section.", "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 section.", "default": null, "constraints": ["length >= 1"]}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated order index of this section in the list of project sections.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "remove_collaborator_from_project", "description": "Remove a collaborator (or self) from a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to remove as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"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_task", "description": "Create a new task within a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project. If set to 0, the task will be created in your default/inbox project.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": true, "description": "The title of the task.", "default": null, "constraints": ["length >= 1"]}, {"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 within the project.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the task.", "default": "", "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The due date of the task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "duration", "type": "number", "required": false, "description": "The duration of the task.", "default": null, "constraints": []}, {"name": "duration_unit", "type": "string", "required": false, "description": "The unit of the task duration.", "default": null, "constraints": ["value in ['minutes', 'hours', 'days']"]}, {"name": "order_index", "type": "integer", "required": false, "description": "Index at which this task should be inserted in the current list of tasks. 0 to insert at the top of the list, 1 to insert below the first task, etc. You can also use a negative value to insert from the end: -1 to insert at the end, -2 to insert just above the last task, etc.", "default": -1, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The priority of the task.", "default": "medium", "constraints": ["value in ['high', 'medium', 'low']"]}], "response_schemas": {"success": {"message": "string", "task_id": 1}, "failure": {"message": "string"}}}]}
379
{"spotify": [{"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": "unfollow_artist", "description": "Unfollow an artist.", "parameters": [{"name": "artist_id", "type": "integer", "required": true, "description": "The artist id to unfollow.", "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_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": "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 spotify app login.", "default": null, "constraints": []}], "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 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": "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": "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": "clear_song_queue", "description": "Clear the music player song queue.", "parameters": [{"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"}}}], "splitwise": [{"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": "show_expense", "description": "Show detailed expense information based on its ID.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"expense_id": 1, "group_id": 1, "description": "string", "deleted": true, "receipt_file_name": "string", "created_at": "2019-01-01T00:00:00", "shares": [{"debtor": {"name": "string", "email": "[email protected]"}, "debt_amount": 0.0}], "creator": {"name": "string", "email": "[email protected]"}, "payer": {"name": "string", "email": "[email protected]"}, "paid_amount": 0.0}, "failure": {"message": "string"}}}]}
380
{"venmo": [{"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": "remove_friend", "description": "Remove a friend from your friend list.", "parameters": [{"name": "user_email", "type": "string", "required": true, "description": "Email address of the friend to remove.", "default": null, "constraints": ["value is email address"]}, {"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"}}}], "simple_note": [{"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": "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": "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": "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"}}}]}
381
{"spotify": [{"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"}}}, {"api_name": "show_album", "description": "Get details of a specific album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve.", "default": null, "constraints": []}], "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", "shareable_link": "string", "songs": [{"id": 1, "title": "string", "artist_ids": [1]}]}, "failure": {"message": "string"}}}, {"api_name": "show_song_library", "description": "Get a list of songs in the user's song 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": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "added_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "unlike_album", "description": "Unlike a album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album 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": "add_to_queue", "description": "Add a song, album or playlist to the music player song queue.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify app login.", "default": null, "constraints": []}, {"name": "song_id", "type": "integer", "required": false, "description": "ID of the song to add to queue.", "default": null, "constraints": []}, {"name": "album_id", "type": "integer", "required": false, "description": "ID of the album to add to queue.", "default": null, "constraints": []}, {"name": "playlist_id", "type": "integer", "required": false, "description": "ID of the playlist to add to queue.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "todoist": [{"api_name": "remove_collaborator_from_project", "description": "Remove a collaborator (or self) from a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to remove as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"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": "show_label", "description": "Show label details based on its ID.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}, {"api_name": "remove_label_from_task", "description": "Remove a label from a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to remove from 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": {"message": "string"}, "failure": {"message": "string"}}}, {"api_name": "create_task", "description": "Create a new task within a project.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project. If set to 0, the task will be created in your default/inbox project.", "default": null, "constraints": []}, {"name": "title", "type": "string", "required": true, "description": "The title of the task.", "default": null, "constraints": ["length >= 1"]}, {"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 within the project.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "The description of the task.", "default": "", "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The due date of the task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "duration", "type": "number", "required": false, "description": "The duration of the task.", "default": null, "constraints": []}, {"name": "duration_unit", "type": "string", "required": false, "description": "The unit of the task duration.", "default": null, "constraints": ["value in ['minutes', 'hours', 'days']"]}, {"name": "order_index", "type": "integer", "required": false, "description": "Index at which this task should be inserted in the current list of tasks. 0 to insert at the top of the list, 1 to insert below the first task, etc. You can also use a negative value to insert from the end: -1 to insert at the end, -2 to insert just above the last task, etc.", "default": -1, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The priority of the task.", "default": "medium", "constraints": ["value in ['high', 'medium', 'low']"]}], "response_schemas": {"success": {"message": "string", "task_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_task", "description": "Show detailed information about the 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": {"project_id": 1, "section_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, "assignee_id": 1, "assigner_id": 1, "created_at": "2019-01-01T00:00:00", "task_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}], "creator": {"name": "string", "email": "[email protected]"}, "num_sub_tasks": 1}, "failure": {"message": "string"}}}, {"api_name": "accept_project_invite", "description": "Accept an invite to join a project using an invite code generated by a project collaborator.", "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", "project_id": 1}, "failure": {"message": "string"}}}]}
382
{"spotify": [{"api_name": "show_song_library", "description": "Get a list of songs in the user's song 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": [{"song_id": 1, "title": "string", "album_id": 1, "album_title": "string", "duration": 1, "artists": [{"id": 1, "name": "string"}], "added_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "show_album_reviews", "description": "Get a list of reviews for an album.", "parameters": [{"name": "album_id", "type": "integer", "required": true, "description": "The album id to retrieve 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": "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 album 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": [{"album_review_id": 1, "album_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"}}}], "gmail": [{"api_name": "mark_thread_archived", "description": "Mark an email thread as archived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to archive.", "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": "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_category_sizes", "description": "Show the number of email threads in each category of inbox, outbox, archived, spam, and the number of unscheduled and scheduled email drafts.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"inbox": 1, "outbox": 1, "archived": 1, "spam": 1, "unscheduled_drafts": 1, "scheduled_drafts": 1}, "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 gmail 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"}, "failure": {"message": "string"}}}]}
383
{"todoist": [{"api_name": "show_label", "description": "Show label details based on its ID.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}, {"api_name": "show_task_comments", "description": "Get a list of task comments.", "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": []}, {"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": [{"task_id": 1, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["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": "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": "delete_sub_task", "description": "Delete a sub_task.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task to delete.", "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": "show_task", "description": "Show detailed information about the 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": {"project_id": 1, "section_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, "assignee_id": 1, "assigner_id": 1, "created_at": "2019-01-01T00:00:00", "task_id": 1, "labels": [{"id": 1, "color": "string", "name": "string"}], "creator": {"name": "string", "email": "[email protected]"}, "num_sub_tasks": 1}, "failure": {"message": "string"}}}], "gmail": [{"api_name": "create_draft", "description": "Create a new draft.", "parameters": [{"name": "recipient_email_addresses", "type": "list[string]", "required": true, "description": "List of recipient email addresses.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": true, "description": "The body of the draft.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": false, "description": "The subject of the draft. Must be None if it's a reply to an email.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "The ID of the email thread that the draft should belong to. Must be passed if it's a reply to or forward of an email.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "The ID of the email in the thread that the draft should responds to.", "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 draft.", "default": null, "constraints": []}, {"name": "scheduled_send_at", "type": "string", "required": false, "description": "If set, the draft will be sent at the specified future time in YYYY-MM-DD|HH:MM:SS format. Otherwise, it will not be sent until you manually send it.", "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", "draft_id": 1}, "failure": {"message": "string"}}}, {"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": "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": "mark_thread_unstarred", "description": "Mark an email thread as unstarred.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unstar.", "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"}}}]}
384
{"splitwise": [{"api_name": "undelete_expense", "description": "Restore a previously deleted expense you are involved in.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to undelete.", "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_payment_receipt_file", "description": "Delete the receipt file from a payment.", "parameters": [{"name": "payment_id", "type": "integer", "required": true, "description": "The ID of the payment to delete receipt for.", "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_receipt_file", "description": "Delete the receipt file from an expense.", "parameters": [{"name": "expense_id", "type": "integer", "required": true, "description": "The ID of the expense to detach receipt file from.", "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"}}}], "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": "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"}}}]}
385
{"venmo": [{"api_name": "search_friends", "description": "Search your or others' friends by name or email address.", "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 friends by name or email address.", "default": "", "constraints": []}, {"name": "user_email", "type": "string", "required": false, "description": "Email address of the user whose friends you want to see. If not passed, your friends will be returned.", "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"]}], "response_schemas": {"success": [{"first_name": "string", "last_name": "string", "email": "[email protected]", "registered_at": "2019-01-01T00:00:00", "friends_since": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "create_transaction", "description": "Send money to a user.", "parameters": [{"name": "receiver_email", "type": "string", "required": true, "description": "Email address of the receiver.", "default": null, "constraints": ["value is email address"]}, {"name": "amount", "type": "number", "required": true, "description": "Amount of the transaction.", "default": null, "constraints": ["value > 0.0"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}, {"name": "description", "type": "string", "required": false, "description": "Description of or note about the transaction.", "default": "", "constraints": []}, {"name": "payment_card_id", "type": "integer", "required": false, "description": "ID of the payment card to use for the transaction. If not passed, Venmo balance will be used.", "default": null, "constraints": []}, {"name": "private", "type": "boolean", "required": false, "description": "Whether the transaction is private or not.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "transaction_id": 1}, "failure": {"message": "string"}}}, {"api_name": "add_friend", "description": "Add a friend to your friend list.", "parameters": [{"name": "user_email", "type": "string", "required": true, "description": "Email address of the friend to add.", "default": null, "constraints": ["value is email address"]}, {"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": "delete_notifications", "description": "Delete all of your notifications.", "parameters": [{"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"}}}], "amazon": [{"api_name": "show_product_feature_choices", "description": "Show the choices of colors, relative sizes and sellers aggregated over all products of the given product type. Because it's an aggregation, the choices may not be available for all products. If product type is not passed, it will return the choices for all products in the database.", "parameters": [{"name": "product_type", "type": "string", "required": false, "description": "The product type to obtain feature choices for.", "default": null, "constraints": []}], "response_schemas": {"success": {"colors": ["string"], "relative_sizes": ["extra-small"], "sellers": [{"seller_id": 1, "name": "string"}]}, "failure": {"message": "string"}}}, {"api_name": "show_order", "description": "Get details of a past order.", "parameters": [{"name": "order_id", "type": "integer", "required": true, "description": "ID of the order to be shown.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"order_id": 1, "address_id": 1, "payment_card_id": 1, "name": "string", "tax": 0.0, "delivery_fee": 0.0, "gift_wrap_fee": 0.0, "discount": 0.0, "created_at": "2019-01-01T00:00:00", "address_text": "string", "payment_card_digits": "string", "paid_amount": 0.0, "order_items": [{"product_id": 1, "ordered_quantity": 1, "returned_quantity": 1, "gift_wrap_quantity": 1, "price": 0.0, "expected_delivery_at": "2019-01-01T00:00:00", "delivered_at": "2019-01-01T00:00:00"}]}, "failure": {"message": "string"}}}, {"api_name": "update_address", "description": "Update address information.", "parameters": [{"name": "address_id", "type": "integer", "required": true, "description": "ID of the address to update", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "name", "type": "string", "required": false, "description": "New name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "street_address", "type": "string", "required": false, "description": "New street address line.", "default": null, "constraints": ["length >= 1"]}, {"name": "city", "type": "string", "required": false, "description": "New city name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "state", "type": "string", "required": false, "description": "New state name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "country", "type": "string", "required": false, "description": "New country name for the address", "default": null, "constraints": ["length >= 1"]}, {"name": "zip_code", "type": "integer", "required": false, "description": "New ZIP code for the address", "default": null, "constraints": ["value >= 10000.0, <= 99999.0"]}], "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 amazon 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": "update_product_question_answer", "description": "Update answer to a product question.", "parameters": [{"name": "question_answer_id", "type": "integer", "required": true, "description": "ID of the question answer to update.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from amazon app login.", "default": null, "constraints": []}, {"name": "answer", "type": "string", "required": false, "description": "The updated answer for the question.", "default": null, "constraints": ["length >= 1"]}], "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": "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": "delete_product_question_answer", "description": "Delete a answer to a product question.", "parameters": [{"name": "question_answer_id", "type": "integer", "required": true, "description": "ID of the question answer 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"}}}]}
386
{"file_system": [{"api_name": "create_file", "description": "Create a new file with the given content.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}, {"name": "content", "type": "string", "required": false, "description": "The content of the file.", "default": "", "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_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": "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": "update_file", "description": "Update a file's content.", "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": []}, {"name": "content", "type": "string", "required": true, "description": "The updated content of the file.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "file_path": "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": "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": "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": "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": "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_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"}}}, {"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": "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": "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": "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_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"}}}]}
387
{"phone": [{"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": "logout", "description": "Logout from 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": "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_alarm", "description": "Show alarm details.", "parameters": [{"name": "alarm_id", "type": "integer", "required": true, "description": "ID of the alarm to show.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from phone app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"alarm_id": 1, "time": "string", "repeat_days": ["monday"], "label": "string", "enabled": true, "snooze_minutes": 0.0, "vibration": true, "created_at": "2019-01-01T00:00:00", "user": {"name": "string", "phone_number": "string"}}, "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": "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": "search_voice_messages", "description": "Show or search text voice_messages between the user and a contact.", "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 voice_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 voice 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": [{"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_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": "get_current_date_and_time", "description": "Show current date and time.", "parameters": [], "response_schemas": {"success": {"date": "string", "time": "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 phone 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"}}}], "splitwise": [{"api_name": "delete_group", "description": "Delete a group you are a member of. Any member can undelete it later.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group 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": "undelete_group", "description": "Undelete a group you are a member of.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group to undelete.", "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"}}}]}
388
{"simple_note": [{"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": "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"}}}], "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": "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": "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 gmail 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": "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": "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": "delete_draft", "description": "Delete draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft 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": "show_spam_threads", "description": "Show or search email threads that have been marked as spam. This will not show detailed information about emails within the thread.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from gmail app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query string.", "default": "", "constraints": []}, {"name": "label", "type": "string", "required": false, "description": "The label to filter the emails by.", "default": null, "constraints": []}, {"name": "starred", "type": "boolean", "required": false, "description": "Filter emails by starred status.", "default": null, "constraints": []}, {"name": "archived", "type": "boolean", "required": false, "description": "Filter emails by archived status.", "default": false, "constraints": []}, {"name": "read", "type": "boolean", "required": false, "description": "Filter emails by read status.", "default": null, "constraints": []}, {"name": "attachment", "type": "boolean", "required": false, "description": "Filter emails by attachment status.", "default": null, "constraints": []}, {"name": "from_email", "type": "string", "required": false, "description": "Filter emails by sender email address.", "default": null, "constraints": ["value is email address"]}, {"name": "to_email", "type": "string", "required": false, "description": "Filter emails by recipient email address.", "default": null, "constraints": ["value is email address"]}, {"name": "min_created_at", "type": "string", "required": false, "description": "Filter emails by minimum created_at date in YYYY-MM-DD format.", "default": "1500-01-01", "constraints": []}, {"name": "max_created_at", "type": "string", "required": false, "description": "Filter emails by maximum created_at date in YYYY-MM-DD format.", "default": "3000-01-01", "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 email threads 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": [{"email_thread_id": 1, "email_ids": [1], "draft_ids": [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", "subject": "string", "participants": [{"name": "string", "email": "[email protected]"}]}], "failure": {"message": "string"}}}]}
389
{"venmo": [{"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_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"}}}, {"api_name": "add_friend", "description": "Add a friend to your friend list.", "parameters": [{"name": "user_email", "type": "string", "required": true, "description": "Email address of the friend to add.", "default": null, "constraints": ["value is email address"]}, {"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"}}}], "file_system": [{"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": "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": "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"}}}]}
390
{"todoist": [{"api_name": "delete_task", "description": "Delete a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task to delete.", "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": "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_task_comments", "description": "Get a list of task comments.", "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": []}, {"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": [{"task_id": 1, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["string"]}], "failure": {"message": "string"}}}], "file_system": [{"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": "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"}}}]}
391
{"gmail": [{"api_name": "mark_thread_read", "description": "Mark an email thread as read.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to mark as read.", "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": "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": "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": "delete_account", "description": "Delete your account.", "parameters": [{"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": "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": "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": "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"}}}], "todoist": [{"api_name": "delete_account", "description": "Delete your account.", "parameters": [{"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": "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": "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": "show_task_comments", "description": "Get a list of task comments.", "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": []}, {"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": [{"task_id": 1, "content": "string", "created_at": "2019-01-01T00:00:00", "task_comment_id": 1, "user": {"name": "string", "email": "[email protected]"}, "attachment_file_names": ["string"]}], "failure": {"message": "string"}}}]}
392
{"venmo": [{"api_name": "show_transaction_comment", "description": "Show detailed information about a transaction comment.", "parameters": [{"name": "comment_id", "type": "integer", "required": true, "description": "ID of the transaction comment to show details of.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from venmo app login.", "default": null, "constraints": []}], "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": "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": "logout", "description": "Logout from your account.", "parameters": [{"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": "delete_notification", "description": "Delete a notification.", "parameters": [{"name": "notification_id", "type": "integer", "required": true, "description": "The ID of the notification to delete.", "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": "delete_task_comment", "description": "Delete a task comment.", "parameters": [{"name": "task_comment_id", "type": "integer", "required": true, "description": "The ID of the comment to delete.", "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": "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": "delete_sub_task", "description": "Delete a sub_task.", "parameters": [{"name": "sub_task_id", "type": "integer", "required": true, "description": "The ID of the sub_task to delete.", "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": "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": "show_projects", "description": "Show or search a list of your projects.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}, {"name": "query", "type": "string", "required": false, "description": "The search query for projects.", "default": "", "constraints": []}, {"name": "color", "type": "string", "required": false, "description": "The color of the project to filter by.", "default": null, "constraints": ["value in ['charcoal', 'red', 'blue', 'green', 'orange', 'yellow']"]}, {"name": "is_favorite", "type": "boolean", "required": false, "description": "Project's favorite status to filter by.", "default": null, "constraints": []}, {"name": "is_archived", "type": "boolean", "required": false, "description": "Project's archival status to filter by.", "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, <= 9.223372036854776e+18"]}, {"name": "sort_by", "type": "string", "required": false, "description": "The attribute to sort the projects 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": [{"name": "string", "color": "charcoal", "is_inbox": true, "description": "string", "is_favorite": true, "is_archived": true, "created_at": "2019-01-01T00:00:00", "project_id": 1, "creator": {"name": "string", "email": "[email protected]"}, "num_tasks": 1, "sections": [{"id": 1, "name": "string", "num_tasks": 1}], "collaborators": [{"name": "string", "email": "[email protected]"}], "pending_invites": [{"invite_code": "string", "invitee": {"name": "string", "email": "[email protected]"}, "inviter": {"name": "string", "email": "[email protected]"}}], "is_shared": true}], "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_sections", "description": "Get a list of sections 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": []}], "response_schemas": {"success": [{"project_id": 1, "name": "string", "order_index": 0.0, "created_at": "2019-01-01T00:00:00", "section_id": 1, "num_tasks": 1}], "failure": {"message": "string"}}}, {"api_name": "send_project_invite", "description": "Invite a collaborator to join a project. They will be notified via email.", "parameters": [{"name": "project_id", "type": "integer", "required": true, "description": "The ID of the project.", "default": null, "constraints": []}, {"name": "email", "type": "string", "required": true, "description": "Email of the user to invite as a collaborator.", "default": null, "constraints": ["value is email address"]}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from todoist app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "invite_code": "string"}, "failure": {"message": "string"}}}, {"api_name": "assign_or_unassign_task", "description": "Assign or unassign a task to a user. If assignee_email is null, the task will be unassigned.", "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": []}, {"name": "assignee_email", "type": "string", "required": false, "description": "Email of the user to assign the task to.", "default": null, "constraints": ["value is email address"]}], "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 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"}}}]}
393
{"gmail": [{"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": "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": "logout", "description": "Logout from your account.", "parameters": [{"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": "mark_thread_unarchived", "description": "Mark an email thread as unarchived.", "parameters": [{"name": "email_thread_id", "type": "integer", "required": true, "description": "The ID of the email thread to unarchive.", "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": "forward_email_from_thread", "description": "Forward an email from an 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_id", "type": "integer", "required": true, "description": "The ID of the email 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": "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": "update_draft", "description": "Update draft information.", "parameters": [{"name": "draft_id", "type": "integer", "required": true, "description": "The ID of the draft to update.", "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.", "default": null, "constraints": []}, {"name": "subject", "type": "string", "required": false, "description": "The updated subject of the draft.", "default": null, "constraints": []}, {"name": "body", "type": "string", "required": false, "description": "The updated body of the draft.", "default": null, "constraints": []}, {"name": "belongs_to_email_thread_id", "type": "integer", "required": false, "description": "The updated ID of the email thread that the draft should belong to. Must be passed if it's a reply to an email.", "default": null, "constraints": []}, {"name": "response_to_email_id", "type": "integer", "required": false, "description": "The updated ID of the email in the thread that the draft is a response to.", "default": null, "constraints": []}, {"name": "scheduled_send_at", "type": "string", "required": false, "description": "The updated time at which the draft should be sent in YYYY-MM-DD|HH:MM:SS format.To remove the scheduled delivery, pass 'None' string, as leaving it empty or null is for when you don't want to update it.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string"}, "failure": {"message": "string"}}}], "splitwise": [{"api_name": "record_expense", "description": "Record a new expense to share with others.", "parameters": [{"name": "description", "type": "string", "required": true, "description": "A short note or description of the expense.", "default": null, "constraints": []}, {"name": "paid_amount", "type": "number", "required": true, "description": "The total amount of the expense paid.", "default": null, "constraints": []}, {"name": "payer_email", "type": "string", "required": true, "description": "Email of the user who paid for the expense.", "default": null, "constraints": ["value is email address"]}, {"name": "debtor_emails", "type": "list[string]", "required": true, "description": "Emails of the users who owe a share of the expense.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "debt_amounts", "type": "list[number]", "required": false, "description": "The amounts owed by each debtor. If not passed, it is assumed that each debtor owes an equal share. If passed, the list must be of the same length as debtor_ids.", "default": null, "constraints": []}, {"name": "group_id", "type": "integer", "required": false, "description": "The ID of the group this expense should belong to. Keep it none if it should not belong to any group.", "default": null, "constraints": []}, {"name": "receipt_file_path", "type": "string", "required": false, "description": "Absolute file path (starting with /) from the file_system app to attach as a receipt for this expense.", "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", "expense_id": 1}, "failure": {"message": "string"}}}, {"api_name": "show_people_balance", "description": "Show the aggregate amounts you owe to each person and they owe to you.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"you_owe_others": 0.0, "others_owe_you": 0.0, "breakdown": [{"email": "[email protected]", "name": "string", "direction": "you_owe_them", "amount": 0.0}]}, "failure": {"message": "string"}}}]}
394
{"spotify": [{"api_name": "show_liked_albums", "description": "Get a list of albums 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 albums by prefixed with +/- to reflect ascending/descending. Valid attributes: liked_at and title.", "default": "-liked_at", "constraints": []}], "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], "liked_at": "2019-01-01T00:00:00"}], "failure": {"message": "string"}}}, {"api_name": "like_playlist", "description": "Like a playlist.", "parameters": [{"name": "playlist_id", "type": "integer", "required": true, "description": "The playlist 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"}}}], "splitwise": [{"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": "show_groups_balance", "description": "Show the aggregate amounts you owe to others or others owe you for each group you are member of. The non-grouped expenses/payments will be shown as a group with group_id of None.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"you_owe_others": 0.0, "others_owe_you": 0.0, "breakdown": [{"group_id": 1, "group_name": "string", "you_owe_others": 0.0, "others_owe_you": 0.0}]}, "failure": {"message": "string"}}}, {"api_name": "show_activity", "description": "Show a history of your expenses and payments combined.", "parameters": [{"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from splitwise app login.", "default": null, "constraints": []}, {"name": "show_expenses", "type": "boolean", "required": false, "description": "Whether to show expenses in the history.", "default": true, "constraints": []}, {"name": "show_payments", "type": "boolean", "required": false, "description": "Whether to show payments in the history.", "default": true, "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 expenses/payments by prefixed with +/- to reflect ascending/descending. Valid attributes: created_at.", "default": "-created_at", "constraints": []}], "response_schemas": {"success": [{"record_type": "expense", "amount": 0.0, "paid_by": {"name": "string", "email": "[email protected]"}, "owed_by": [{"name": "string", "email": "[email protected]", "amount": 0.0}], "description": "string", "group_id": 1, "group_name": "string", "created_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"}}}, {"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_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": "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": "exit_group", "description": "Exit from a group you are a part of.", "parameters": [{"name": "group_id", "type": "integer", "required": true, "description": "The ID of the group to exit.", "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": "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 splitwise 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"}}}]}
395
{"spotify": [{"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": "download_premium_subscription_receipt", "description": "Download the receipt for a premium subscription.", "parameters": [{"name": "premium_subscription_id", "type": "integer", "required": true, "description": "ID of the premium subscription to download the receipt for.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from spotify 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"}}}], "file_system": [{"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 file_system 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": "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"}}}]}
396
{"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": "update_product_quantity_in_cart", "description": "Update product quantity in the user cart.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be updated in the cart.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "The new quantity of the product to be updated in the cart.", "default": null, "constraints": ["value >= 0.0"]}, {"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": "update_product_quantity_in_wish_list", "description": "Update product quantity in the user wish_list.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product being updated in the wish list.", "default": null, "constraints": []}, {"name": "quantity", "type": "integer", "required": true, "description": "The new quantity of the product to be updated in the wish list.", "default": null, "constraints": ["value >= 0.0"]}, {"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": "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_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"}}}, {"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": "search_sellers", "description": "Search for sellers with a query.", "parameters": [{"name": "query", "type": "string", "required": false, "description": "The 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": [{"seller_id": 1, "name": "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"}}}, {"api_name": "delete_product_from_wish_list", "description": "Remove product from the user wish list.", "parameters": [{"name": "product_id", "type": "integer", "required": true, "description": "ID of the product to be deleted from the wish list.", "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"}}}], "simple_note": [{"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": "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": "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"}}}]}
397
{"phone": [{"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": "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": "logout", "description": "Logout from 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": "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"}}}], "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": "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": "apply_promo_code_to_cart", "description": "Apply a promo code to your cart.", "parameters": [{"name": "promo_code", "type": "string", "required": true, "description": "The promo code to be applied to 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"}}}]}
398
{"venmo": [{"api_name": "create_transaction_comment", "description": "Create a new transaction comment.", "parameters": [{"name": "transaction_id", "type": "integer", "required": true, "description": "ID of the transaction to comment on.", "default": null, "constraints": []}, {"name": "comment", "type": "string", "required": true, "description": "Comment on the transaction.", "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", "comment_id": 1}, "failure": {"message": "string"}}}, {"api_name": "delete_payment_request", "description": "Delete a payment request.", "parameters": [{"name": "payment_request_id", "type": "integer", "required": true, "description": "ID of the payment request 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"}}}], "todoist": [{"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_label", "description": "Show label details based on its ID.", "parameters": [{"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label.", "default": null, "constraints": []}], "response_schemas": {"success": {"name": "string", "color": "charcoal", "label_id": 1, "creator": {"name": "string", "email": "[email protected]"}}, "failure": {"message": "string"}}}, {"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": "update_task", "description": "Update task information.", "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": []}, {"name": "title", "type": "string", "required": false, "description": "The updated title of the task.", "default": null, "constraints": ["length >= 1"]}, {"name": "description", "type": "string", "required": false, "description": "The updated description of the task.", "default": null, "constraints": []}, {"name": "due_date", "type": "string", "required": false, "description": "The updated due date of the task in YYYY-MM-DD format.", "default": null, "constraints": []}, {"name": "duration", "type": "number", "required": false, "description": "The updated duration of the task.", "default": null, "constraints": []}, {"name": "duration_unit", "type": "string", "required": false, "description": "The updated unit of the task duration.", "default": null, "constraints": ["value in ['minutes', 'hours', 'days']"]}, {"name": "is_completed", "type": "boolean", "required": false, "description": "Whether the task is completed.", "default": null, "constraints": []}, {"name": "order_index", "type": "integer", "required": false, "description": "The updated order index of this task in the list of section tasks.", "default": null, "constraints": []}, {"name": "priority", "type": "string", "required": false, "description": "The updated priority of the task.", "default": null, "constraints": ["value in ['high', 'medium', 'low']"]}], "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 todoist 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": "remove_label_from_task", "description": "Remove a label from a task.", "parameters": [{"name": "task_id", "type": "integer", "required": true, "description": "The ID of the task.", "default": null, "constraints": []}, {"name": "label_id", "type": "integer", "required": true, "description": "The ID of the label to remove from 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": {"message": "string"}, "failure": {"message": "string"}}}]}
399
{"simple_note": [{"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": "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"}}}], "file_system": [{"api_name": "update_file", "description": "Update a file's content.", "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": []}, {"name": "content", "type": "string", "required": true, "description": "The updated content of the file.", "default": null, "constraints": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "file_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": "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": "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": "show_file", "description": "Show a file's content and other details, if it 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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"file_id": 1, "path": "string", "content": "string", "created_at": "2019-01-01T00:00:00", "updated_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"}}}, {"api_name": "delete_account", "description": "Delete 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": "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": "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": "copy_directory", "description": "Copy a directory to another location.", "parameters": [{"name": "source_directory_path", "type": "string", "required": true, "description": "Path of the source directory. Path can be absolute, starting with '/', or relative to the user's home directory, starting with '~/'.", "default": null, "constraints": []}, {"name": "destination_directory_path", "type": "string", "required": true, "description": "Path of the destination directory. 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 directory if it already exists.", "default": false, "constraints": []}, {"name": "retain_dates", "type": "boolean", "required": false, "description": "Whether the files in the copied directory should retain the created and updated dates of the files in the original directory.", "default": false, "constraints": []}], "response_schemas": {"success": {"message": "string", "destination_directory_path": "string"}, "failure": {"message": "string"}}}, {"api_name": "delete_file", "description": "Delete a file.", "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": []}, {"name": "access_token", "type": "string", "required": true, "description": "Access token obtained from file_system app login.", "default": null, "constraints": []}], "response_schemas": {"success": {"message": "string", "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"}}}]}