docs: ai assistance

Flared · Aug 28, 2024 · b7054c1 · b7054c1
1 parent c9cdc6e
commit b7054c1
Show file tree

Hide file tree

Showing 7 changed files with 391 additions and 76 deletions.
diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json
diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json
diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json
@@ -439,6 +439,14 @@
                             "type": "string"
                         }
                     },
+                    {
+                        "description": "The `next` parameter is used to paginate through results.  \n\nTo get the first page of results, omit this parameter. Afterward, include the `next` parameter in your next request with the latest response's `next` value to get the next page of results.",
+                        "in": "query",
+                        "name": "next",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
                     {
                         "description": "User defined tags used to filter search results",
                         "explode": true,
@@ -461,7 +469,7 @@
                         }
                     },
                     {
-                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, listing, blog_post, seller, stealer_log, forum_post, bot, forum_profile, forum_topic, chat_message, financial_data\n- open_web: service, stack_exchange, google, source_code_files, bucket, social_media, paste, source_code_secrets, bucket_object\n- leaks: leak\n- domains: domain\n",
+                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, listing, ransomleak, stealer_log, forum_topic, financial_data, chat_message, blog_post, seller, bot, forum_post\n- open_web: bucket_object, social_media, service, source_code_secrets, google, source_code_files, paste, stack_exchange, bucket\n- leaks: leak\n- domains: domain\n",
                         "explode": true,
                         "in": "query",
                         "name": "types[]",
@@ -750,6 +758,14 @@
                             "type": "string"
                         }
                     },
+                    {
+                        "description": "The `next` parameter is used to paginate through results.  \n\nTo get the first page of results, omit this parameter. Afterward, include the `next` parameter in your next request with the latest response's `next` value to get the next page of results.",
+                        "in": "query",
+                        "name": "next",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
                     {
                         "description": "User defined tags used to filter search results",
                         "explode": true,
@@ -772,7 +788,7 @@
                         }
                     },
                     {
-                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, listing, blog_post, seller, stealer_log, forum_post, bot, forum_profile, forum_topic, chat_message, financial_data\n- open_web: service, stack_exchange, google, source_code_files, bucket, social_media, paste, source_code_secrets, bucket_object\n- leaks: leak\n- domains: domain\n",
+                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, listing, ransomleak, stealer_log, forum_topic, financial_data, chat_message, blog_post, seller, bot, forum_post\n- open_web: bucket_object, social_media, service, source_code_secrets, google, source_code_files, paste, stack_exchange, bucket\n- leaks: leak\n- domains: domain\n",
                         "explode": true,
                         "in": "query",
                         "name": "types[]",
@@ -1184,7 +1200,9 @@
                                 "recent",
                                 "interest",
                                 "resolves",
-                                "reachable"
+                                "reachable",
+                                "unresolvable",
+                                "unreachable"
                             ],
                             "items": {
                                 "type": "string"
@@ -1571,7 +1589,9 @@
                                 "recent",
                                 "interest",
                                 "resolves",
-                                "reachable"
+                                "reachable",
+                                "unresolvable",
+                                "unreachable"
                             ],
                             "items": {
                                 "type": "string"

diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json
@@ -1118,6 +1118,12 @@
             "name": "search_after",
             "type": "string"
           },
+          {
+            "description": "The `next` parameter is used to paginate through results.  \n\nTo get the first page of results, omit this parameter. Afterward, include the `next` parameter in your next request with the latest response's `next` value to get the next page of results.",
+            "in": "query",
+            "name": "next",
+            "type": "string"
+          },
           {
             "collectionFormat": "multi",
             "description": "User defined tags used to filter search results",
@@ -1136,7 +1142,7 @@
           },
           {
             "collectionFormat": "multi",
-            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, listing, blog_post, seller, stealer_log, forum_post, bot, forum_profile, forum_topic, chat_message, financial_data\n- open_web: service, stack_exchange, google, source_code_files, bucket, social_media, paste, source_code_secrets, bucket_object\n- leaks: leak\n- domains: domain\n",
+            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, listing, ransomleak, stealer_log, forum_topic, financial_data, chat_message, blog_post, seller, bot, forum_post\n- open_web: bucket_object, social_media, service, source_code_secrets, google, source_code_files, paste, stack_exchange, bucket\n- leaks: leak\n- domains: domain\n",
             "enum": [
               "attachment",
               "listing",
@@ -1375,6 +1381,12 @@
             "name": "search_after",
             "type": "string"
           },
+          {
+            "description": "The `next` parameter is used to paginate through results.  \n\nTo get the first page of results, omit this parameter. Afterward, include the `next` parameter in your next request with the latest response's `next` value to get the next page of results.",
+            "in": "query",
+            "name": "next",
+            "type": "string"
+          },
           {
             "collectionFormat": "multi",
             "description": "User defined tags used to filter search results",
@@ -1393,7 +1405,7 @@
           },
           {
             "collectionFormat": "multi",
-            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, listing, blog_post, seller, stealer_log, forum_post, bot, forum_profile, forum_topic, chat_message, financial_data\n- open_web: service, stack_exchange, google, source_code_files, bucket, social_media, paste, source_code_secrets, bucket_object\n- leaks: leak\n- domains: domain\n",
+            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media_profile, social_media_post, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, ad, ads, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, listing, ransomleak, stealer_log, forum_topic, financial_data, chat_message, blog_post, seller, bot, forum_post\n- open_web: bucket_object, social_media, service, source_code_secrets, google, source_code_files, paste, stack_exchange, bucket\n- leaks: leak\n- domains: domain\n",
             "enum": [
               "attachment",
               "listing",
@@ -1738,7 +1750,9 @@
               "recent",
               "interest",
               "resolves",
-              "reachable"
+              "reachable",
+              "unresolvable",
+              "unreachable"
             ],
             "in": "query",
             "items": {
@@ -2047,7 +2061,9 @@
               "recent",
               "interest",
               "resolves",
-              "reachable"
+              "reachable",
+              "unresolvable",
+              "unreachable"
             ],
             "in": "query",
             "items": {

diff --git a/docs/api-reference/v2/endpoints/activities/get-activities--ai_assistance.mdx b/docs/api-reference/v2/endpoints/activities/get-activities--ai_assistance.mdx
@@ -0,0 +1,4 @@
+---
+openapi: get /activities/{index}/{source}/{id}/ai_assistance
+title: "Retrieve Event AI Assistance"
+---
diff --git a/docs/api-reference/v2/endpoints/me/post-mefeedcredentials.mdx b/docs/api-reference/v2/endpoints/me/post-mefeedcredentials.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /me/feed/credentials
+---
diff --git a/docs/mint.json b/docs/mint.json
@@ -170,6 +170,12 @@
             "api-reference/v2/endpoints/identifiers/delete-assetsgroups"
           ]
         },
+        {
+          "group": "Events",
+          "pages": [
+            "api-reference/v2/endpoints/activities/get-activities--ai_assistance"
+          ]
+        },
         {
           "group": "Event Feeds",
           "pages": [