Skip to content

README.md

Latest commit

 

History

History
1165 lines (1150 loc) · 102 KB

README.md

File metadata and controls

1165 lines (1150 loc) · 102 KB
Raw

RevEng.AI Python SDK

This is the Python SDK for the RevEng.AI API.

To use the SDK you will first need to obtain an API key from https://reveng.ai.

Installation

Once you have the API key you can install the SDK via pip:

pip install revengai

Usage

The following is an example of how to use the SDK to get the logs of an analysis:

import os
import revengai

configuration = revengai.Configuration(api_key={'APIKey': os.environ["API_KEY"]})

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AnalysesCoreApi(api_client)
    analysis_id = 715320

    try:
        # Gets the logs of an analysis
        api_response = api_instance.get_analysis_logs(analysis_id)
        print("The response of AnalysesCoreApi->get_analysis_logs:\n")
        print(api_response)
    except Exception as e:
        print("Exception when calling AnalysesCoreApi->get_analysis_logs: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.reveng.ai

Class Method HTTP request Description
AgentApi check_capabilities_task_status_v2_analyses_analysis_id_agent_capabilities_status_get GET /v2/analyses/{analysis_id}/agent/capabilities/status Check the status of a capabilities analysis workflow
AgentApi check_protocols_task_status_v2_analyses_analysis_id_agent_protocols_status_get GET /v2/analyses/{analysis_id}/agent/protocols/status Check the status of a protocols discovery workflow
AgentApi check_remediation_task_status_v2_analyses_analysis_id_agent_remediation_status_get GET /v2/analyses/{analysis_id}/agent/remediation/status Check the status of a remediation analysis workflow
AgentApi check_report_analysis_task_status_v2_analyses_analysis_id_agent_report_analysis_status_get GET /v2/analyses/{analysis_id}/agent/report-analysis/status Check the status of a report analysis workflow
AgentApi check_secrets_task_status_v2_analyses_analysis_id_agent_secrets_status_get GET /v2/analyses/{analysis_id}/agent/secrets/status Check the status of a secrets discovery workflow
AgentApi check_triage_task_status_v2_analyses_analysis_id_agent_triage_status_get GET /v2/analyses/{analysis_id}/agent/triage/status Check the status of a triage analysis workflow
AgentApi create_capabilities_task_v2_analyses_analysis_id_agent_capabilities_post POST /v2/analyses/{analysis_id}/agent/capabilities Queues a capabilities analysis workflow process
AgentApi create_protocols_task_v2_analyses_analysis_id_agent_protocols_post POST /v2/analyses/{analysis_id}/agent/protocols Queues a protocols discovery workflow process
AgentApi create_remediation_task_v2_analyses_analysis_id_agent_remediation_post POST /v2/analyses/{analysis_id}/agent/remediation Queues a remediation analysis workflow process
AgentApi create_report_analysis_task_v2_analyses_analysis_id_agent_report_analysis_post POST /v2/analyses/{analysis_id}/agent/report-analysis Queues a combined report analysis workflow process
AgentApi create_secrets_task_v2_analyses_analysis_id_agent_secrets_post POST /v2/analyses/{analysis_id}/agent/secrets Queues a secrets discovery workflow process
AgentApi create_triage_task_v2_analyses_analysis_id_agent_triage_post POST /v2/analyses/{analysis_id}/agent/triage Queues a triage analysis workflow process
AgentApi get_capabilities_result_v2_analyses_analysis_id_agent_capabilities_get GET /v2/analyses/{analysis_id}/agent/capabilities Get Capabilities Result
AgentApi get_protocols_result_v2_analyses_analysis_id_agent_protocols_get GET /v2/analyses/{analysis_id}/agent/protocols Get Protocols Result
AgentApi get_remediation_result_v2_analyses_analysis_id_agent_remediation_get GET /v2/analyses/{analysis_id}/agent/remediation Get Remediation Result
AgentApi get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get GET /v2/analyses/{analysis_id}/agent/report-analysis Get Report Analysis Result
AgentApi get_secrets_result_v2_analyses_analysis_id_agent_secrets_get GET /v2/analyses/{analysis_id}/agent/secrets Get Secrets Result
AgentApi get_triage_result_v2_analyses_analysis_id_agent_triage_get GET /v2/analyses/{analysis_id}/agent/triage Get Triage Result
AgentApi v3_cancel_rename_unnamed_functions POST /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/cancel Cancel the rename-unnamed-functions agent.
AgentApi v3_cancel_security_scan_operation POST /v3/operations/security-scan/{analysis_id}:cancel Cancel a security-scan operation.
AgentApi v3_get_binary_agent_feedback GET /v3/analyses/{analysis_id}/agents/{agent}/feedback Get the caller's feedback on an agent's output.
AgentApi v3_get_capabilities_operation GET /v3/operations/capabilities/{analysis_id} Get a capabilities operation.
AgentApi v3_get_crypto_explain_operation GET /v3/operations/crypto-explain/{function_id} Get a crypto-explain operation.
AgentApi v3_get_crypto_scan_operation GET /v3/operations/crypto-scan/{analysis_id} Get a crypto-scan operation.
AgentApi v3_get_cryptography_operation GET /v3/operations/cryptography/{analysis_id} Get a cryptography operation.
AgentApi v3_get_execution_explain_operation GET /v3/operations/execution-explain/{function_id} Get an execution-explain operation.
AgentApi v3_get_execution_scan_operation GET /v3/operations/execution-scan/{analysis_id} Get an execution-scan operation.
AgentApi v3_get_filesystem_analyse_operation GET /v3/operations/filesystem-analyse/{function_id} Get a filesystem-analyse operation.
AgentApi v3_get_filesystem_scan_operation GET /v3/operations/filesystem-scan/{analysis_id} Get a filesystem-scan operation.
AgentApi v3_get_networking_explain_operation GET /v3/operations/networking-explain/{function_id} Get a networking-explain operation.
AgentApi v3_get_networking_scan_operation GET /v3/operations/networking-scan/{analysis_id} Get a networking-scan operation.
AgentApi v3_get_protocols_operation GET /v3/operations/protocols/{analysis_id} Get a protocols operation.
AgentApi v3_get_remediation_operation GET /v3/operations/remediation/{analysis_id} Get a remediation operation.
AgentApi v3_get_rename_unnamed_functions_operation GET /v3/operations/rename-unnamed-functions/{analysis_id} Get a rename-unnamed-functions operation.
AgentApi v3_get_rename_unnamed_functions_result GET /v3/analyses/{analysis_id}/agents/rename-unnamed-functions Get rename-unnamed-functions agent result.
AgentApi v3_get_rename_unnamed_functions_status GET /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/status Get rename-unnamed-functions agent status.
AgentApi v3_get_report_analysis_operation GET /v3/operations/report-analysis/{analysis_id} Get a report-analysis operation.
AgentApi v3_get_secrets_operation GET /v3/operations/secrets/{analysis_id} Get a secrets operation.
AgentApi v3_get_security_scan_operation GET /v3/operations/security-scan/{analysis_id} Get a security-scan operation.
AgentApi v3_get_triage_operation GET /v3/operations/triage/{analysis_id} Get a triage operation.
AgentApi v3_list_operation_prerequisites GET /v3/operation-prerequisites List operation prerequisites.
AgentApi v3_run_capabilities POST /v3/analyses/{analysis_id}/capabilities:run Run the capabilities agent.
AgentApi v3_run_crypto_explain POST /v3/functions/{function_id}/crypto-explain:run Run the crypto-explain agent.
AgentApi v3_run_crypto_scan POST /v3/analyses/{analysis_id}/crypto-scan:run Run the crypto-scan agent.
AgentApi v3_run_cryptography POST /v3/analyses/{analysis_id}/cryptography:run Run the cryptography agent.
AgentApi v3_run_execution_explain POST /v3/functions/{function_id}/execution-explain:run Run the execution-explain agent.
AgentApi v3_run_execution_scan POST /v3/analyses/{analysis_id}/execution-scan:run Run the execution-scan agent.
AgentApi v3_run_filesystem_analyse POST /v3/functions/{function_id}/filesystem-analyse:run Run the filesystem-analyse agent.
AgentApi v3_run_filesystem_scan POST /v3/analyses/{analysis_id}/filesystem-scan:run Run the filesystem-scan agent.
AgentApi v3_run_networking_explain POST /v3/functions/{function_id}/networking-explain:run Run the networking-explain agent.
AgentApi v3_run_networking_scan POST /v3/analyses/{analysis_id}/networking-scan:run Run the networking-scan agent.
AgentApi v3_run_protocols POST /v3/analyses/{analysis_id}/protocols:run Run the protocols agent.
AgentApi v3_run_remediation POST /v3/analyses/{analysis_id}/remediation:run Run the remediation agent.
AgentApi v3_run_report_analysis POST /v3/analyses/{analysis_id}/report-analysis:run Run the report-analysis agent.
AgentApi v3_run_secrets POST /v3/analyses/{analysis_id}/secrets:run Run the secrets agent.
AgentApi v3_run_security_scan POST /v3/analyses/{analysis_id}/security-scan:run Run the security-scan agent.
AgentApi v3_run_triage POST /v3/analyses/{analysis_id}/triage:run Run the triage agent.
AgentApi v3_trigger_rename_unnamed_functions POST /v3/analyses/{analysis_id}/agents/rename-unnamed-functions Run the rename-unnamed-functions agent.
AgentApi v3_upsert_binary_agent_feedback PUT /v3/analyses/{analysis_id}/agents/{agent}/feedback Record feedback on an agent's output.
AnalysesBulkActionsApi bulk_add_analysis_tags PATCH /v2/analyses/tags/add Bulk Add Analysis Tags
AnalysesBulkActionsApi bulk_delete_analyses PATCH /v2/analyses/delete Bulk Delete Analyses
AnalysesBulkActionsApi v3_batch_add_analysis_tags POST /v3/analyses:batchAddTags Add tags to multiple analyses.
AnalysesBulkActionsApi v3_batch_delete_analyses POST /v3/analyses:batchDelete Delete multiple analyses.
AnalysesCommentsApi create_analysis_comment POST /v2/analyses/{analysis_id}/comments Create a comment for this analysis
AnalysesCommentsApi delete_analysis_comment DELETE /v2/analyses/{analysis_id}/comments/{comment_id} Delete a comment
AnalysesCommentsApi get_analysis_comments GET /v2/analyses/{analysis_id}/comments Get comments for this analysis
AnalysesCommentsApi update_analysis_comment PATCH /v2/analyses/{analysis_id}/comments/{comment_id} Update a comment
AnalysesCoreApi add_user_string_to_analysis POST /v3/analyses/{analysis_id}/user-provided-strings Add a user-provided string to an analysis.
AnalysesCoreApi create_analysis POST /v2/analyses Create Analysis
AnalysesCoreApi delete_analysis DELETE /v2/analyses/{analysis_id} Delete Analysis
AnalysesCoreApi get_analysis_basic_info GET /v2/analyses/{analysis_id}/basic Gets basic analysis information
AnalysesCoreApi get_analysis_basic_info_0 GET /v3/analyses/{analysis_id}/basic Get basic analysis information
AnalysesCoreApi get_analysis_bytes GET /v3/analyses/{analysis_id}/bytes Get the bytes of a binary
AnalysesCoreApi get_analysis_function_map GET /v2/analyses/{analysis_id}/func_maps Get Analysis Function Map
AnalysesCoreApi get_analysis_function_matches GET /v3/analyses/{analysis_id}/functions/matches Get function-matching results for an analysis
AnalysesCoreApi get_analysis_function_matching_status GET /v3/analyses/{analysis_id}/functions/matches/status Get function-matching status for an analysis
AnalysesCoreApi get_analysis_logs GET /v2/analyses/{analysis_id}/logs Gets the logs of an analysis
AnalysesCoreApi get_analysis_params GET /v2/analyses/{analysis_id}/params Gets analysis param information
AnalysesCoreApi get_analysis_status GET /v2/analyses/{analysis_id}/status Gets the status of an analysis
AnalysesCoreApi insert_analysis_log POST /v2/analyses/{analysis_id}/logs Insert a log entry for an analysis
AnalysesCoreApi list_analyses GET /v2/analyses/list Gets the most recent analyses
AnalysesCoreApi lookup_binary_id GET /v2/analyses/lookup/{binary_id} Gets the analysis ID from binary ID
AnalysesCoreApi put_analysis_strings PUT /v2/analyses/{analysis_id}/strings Add strings to the analysis
AnalysesCoreApi requeue_analysis POST /v2/analyses/{analysis_id}/requeue Requeue Analysis
AnalysesCoreApi start_analysis_function_matching POST /v3/analyses/{analysis_id}/functions/matches Start function matching for an analysis
AnalysesCoreApi update_analysis PATCH /v2/analyses/{analysis_id} Update Analysis
AnalysesCoreApi update_analysis_tags PATCH /v2/analyses/{analysis_id}/tags Update Analysis Tags
AnalysesCoreApi upload_file POST /v2/upload Upload File
AnalysesCoreApi v3_create_analysis POST /v3/analyses Create an analysis
AnalysesCoreApi v3_delete_analysis DELETE /v3/analyses/{analysis_id} Delete an analysis.
AnalysesCoreApi v3_download_binary_export GET /v3/analyses/{analysis_id}/binary-export Download a binary export
AnalysesCoreApi v3_get_analysis GET /v3/analyses/{analysis_id} Get an analysis.
AnalysesCoreApi v3_get_analysis_auto_unstrip_status GET /v3/analyses/{analysis_id}/auto-unstrip/status Get the auto-unstrip status for an analysis.
AnalysesCoreApi v3_get_analysis_functions_progress GET /v3/analyses/{analysis_id}/progress/functions Get function embedding progress for an analysis.
AnalysesCoreApi v3_get_analysis_global GET /v3/analyses/{analysis_id}/globals/{vaddr} Get one global variable.
AnalysesCoreApi v3_get_analysis_global_history GET /v3/analyses/{analysis_id}/globals/{vaddr}/history List a global variable's replaced values.
AnalysesCoreApi v3_get_analysis_logs GET /v3/analyses/{analysis_id}/logs Get the Analysis log
AnalysesCoreApi v3_get_analysis_operation GET /v3/operations/analyses/{analysis_id} Get an Analysis-creation operation
AnalysesCoreApi v3_get_analysis_strings GET /v3/analyses/{analysis_id}/functions/strings List strings for an analysis.
AnalysesCoreApi v3_get_analysis_strings_status GET /v3/analyses/{analysis_id}/functions/strings/status Get the string-extraction status for an analysis.
AnalysesCoreApi v3_get_binary_export_operation GET /v3/operations/binary-export/{task_id} Get a binary export operation
AnalysesCoreApi v3_get_dynamic_execution_artifact GET /v3/analyses/{analysis_id}/dynamic-execution/artifacts/{sha256} Download an artifact.
AnalysesCoreApi v3_get_dynamic_execution_logs_download GET /v3/analyses/{analysis_id}/dynamic-execution/logs/download Download the execution logs archive.
AnalysesCoreApi v3_get_dynamic_execution_memdump GET /v3/analyses/{analysis_id}/dynamic-execution/memdumps/{sha256} Download a memory dump.
AnalysesCoreApi v3_get_dynamic_execution_operation GET /v3/operations/dynamic-execution/{analysis_id} Get a dynamic execution operation.
AnalysesCoreApi v3_get_dynamic_execution_pcap GET /v3/analyses/{analysis_id}/dynamic-execution/pcap Download the network capture.
AnalysesCoreApi v3_get_dynamic_execution_report GET /v3/analyses/{analysis_id}/dynamic-execution/report Get the dynamic execution report.
AnalysesCoreApi v3_get_dynamic_execution_screenshot GET /v3/analyses/{analysis_id}/dynamic-execution/screenshots/{index} Download a screenshot.
AnalysesCoreApi v3_get_dynamic_execution_summary GET /v3/analyses/{analysis_id}/dynamic-execution/summary Get the dynamic execution summary.
AnalysesCoreApi v3_get_dynamic_execution_summary_operation GET /v3/operations/dynamic-execution-summary/{analysis_id} Get a dynamic execution summary operation.
AnalysesCoreApi v3_get_dynamic_execution_wireshark_keys GET /v3/analyses/{analysis_id}/dynamic-execution/wireshark-keys Download Wireshark TLS session keys.
AnalysesCoreApi v3_grant_analysis_access POST /v3/analyses/{analysis_id}/access-rules Share an analysis with a user or team
AnalysesCoreApi v3_list_analyses GET /v3/analyses List analyses
AnalysesCoreApi v3_list_analysis_access_rules GET /v3/analyses/{analysis_id}/access-rules List who an analysis is shared with
AnalysesCoreApi v3_list_analysis_globals GET /v3/analyses/{analysis_id}/globals List the global variables in an analysis.
AnalysesCoreApi v3_list_analysis_operations GET /v3/analyses/{analysis_id}/operations List the operations run on an analysis.
AnalysesCoreApi v3_list_dynamic_execution_screenshots GET /v3/analyses/{analysis_id}/dynamic-execution/screenshots List the screenshots captured during execution.
AnalysesCoreApi v3_list_example_analyses GET /v3/analyses/examples List example analyses
AnalysesCoreApi v3_list_global_functions GET /v3/analyses/{analysis_id}/globals/{vaddr}/functions List the functions referencing a global variable.
AnalysesCoreApi v3_lookup_analysis_by_binary_id GET /v3/analyses/lookup/{binary_id} Look up the most recent analysis for a binary.
AnalysesCoreApi v3_queue_binary_export POST /v3/analyses/{analysis_id}/binary-export Queue a binary export
AnalysesCoreApi v3_requeue_analysis POST /v3/analyses/{analysis_id}/requeue Requeue an analysis
AnalysesCoreApi v3_revoke_analysis_access DELETE /v3/analyses/{analysis_id}/access-rules Stop sharing an analysis with a user or team
AnalysesCoreApi v3_run_dynamic_execution POST /v3/analyses/{analysis_id}/dynamic-execution:run Trigger a dynamic execution run.
AnalysesCoreApi v3_run_dynamic_execution_summary POST /v3/analyses/{analysis_id}/dynamic-execution/summary:run Regenerate the dynamic execution summary.
AnalysesCoreApi v3_search_tags GET /v3/tags Search tags
AnalysesCoreApi v3_update_analysis PATCH /v3/analyses/{analysis_id} Update an analysis.
AnalysesCoreApi v3_update_analysis_global PATCH /v3/analyses/{analysis_id}/globals/{vaddr} Edit a global variable.
AnalysesCoreApi v3_update_analysis_tags PATCH /v3/analyses/{analysis_id}/tags Replace an analysis' tags.
AnalysesCoreApi v3_upgrade_analysis_model POST /v3/analyses/{analysis_id}/upgrade-model Re-analyse on the latest model
AnalysesResultsMetadataApi get_analysis_functions_paginated GET /v2/analyses/{analysis_id}/functions Get functions from analysis
AnalysesResultsMetadataApi get_capabilities GET /v2/analyses/{analysis_id}/capabilities Gets the capabilities from the analysis
AnalysesResultsMetadataApi get_functions_list GET /v2/analyses/{analysis_id}/functions/list Gets functions from analysis
AnalysesResultsMetadataApi get_tags GET /v2/analyses/{analysis_id}/tags Get function tags with maliciousness score
AnalysesResultsMetadataApi v3_get_analysis_xref GET /v3/analyses/{analysis_id}/xrefs/{vaddr} Look up xrefs by virtual address.
AnalysesResultsMetadataApi v3_list_analysis_capabilities GET /v3/analyses/{analysis_id}/capabilities List the capabilities found in an analysis.
AnalysesResultsMetadataApi v3_list_analysis_tags GET /v3/analyses/{analysis_id}/tags List the tags on an analysis.
AnalysesXRefsApi get_xref_by_vaddr GET /v2/analyses/{analysis_id}/xrefs/{vaddr} [Beta] Look up xrefs by virtual address
AuthenticationUsersApi get_user GET /v2/users/{user_id} Get a user's public information
AuthenticationUsersApi get_user_activity GET /v2/users/activity Get auth user activity
AuthenticationUsersApi submit_user_feedback POST /v2/users/feedback Submit feedback about the application
AuthenticationUsersApi v3_get_user GET /v3/users/{user_id} Get a user's public information
AuthenticationUsersApi v3_get_user_activity GET /v3/users/activity Get the caller's activity feed
AuthenticationUsersApi v3_list_principals GET /v3/principals Search users and teams
AuthenticationUsersApi v3_list_teams GET /v3/teams Search teams
AuthenticationUsersApi v3_list_users GET /v3/users Search users
AuthenticationUsersApi v3_submit_user_feedback POST /v3/users/feedback Submit feedback
BinariesApi download_zipped_binary GET /v2/binaries/{binary_id}/download-zipped Downloads a zipped binary with password protection
BinariesApi get_binary_additional_details GET /v2/binaries/{binary_id}/additional-details Gets the additional details of a binary
BinariesApi get_binary_additional_details_0 GET /v3/binaries/{binary_id}/additional-details Get additional details for a binary.
BinariesApi get_binary_additional_details_status GET /v2/binaries/{binary_id}/additional-details/status Gets the status of the additional details task for a binary
BinariesApi get_binary_additional_details_status_0 GET /v3/binaries/{binary_id}/additional-details/status Get the additional-details extraction status for a binary.
BinariesApi get_binary_details GET /v2/binaries/{binary_id}/details Gets the details of a binary
BinariesApi get_binary_die_info GET /v2/binaries/{binary_id}/die-info Gets the die info of a binary
BinariesApi get_binary_externals GET /v2/binaries/{binary_id}/externals Gets the external details of a binary
BinariesApi get_binary_related_status GET /v2/binaries/{binary_id}/related/status Gets the status of the unpack binary task for a binary
BinariesApi get_related_binaries GET /v2/binaries/{binary_id}/related Gets the related binaries of a binary.
BinariesApi v3_download_binary_zipped GET /v3/binaries/{binary_id}/download-zipped Download a binary as a password-protected zip.
BinariesApi v3_get_binary_die_info GET /v3/binaries/{binary_id}/die-info Get Detect It Easy matches for a binary.
BinariesApi v3_get_binary_externals GET /v3/binaries/{binary_id}/externals Get third-party threat-intel lookups for a binary.
BinariesApi v3_get_binary_related GET /v3/binaries/{binary_id}/related Get the binaries related to this one by unpacking.
BinariesApi v3_get_binary_related_status GET /v3/binaries/{binary_id}/related/status Get the archive-unpacking status for a binary.
BinariesApi v3_search_binaries GET /v3/binaries Search binaries
BinariesApi v3_upload_file POST /v3/upload Upload a file.
CollectionsApi create_collection POST /v2/collections Creates new collection information
CollectionsApi delete_collection DELETE /v2/collections/{collection_id} Deletes a collection
CollectionsApi get_collection GET /v2/collections/{collection_id} Returns a collection
CollectionsApi list_collections GET /v2/collections Gets basic collections information
CollectionsApi update_collection PATCH /v2/collections/{collection_id} Updates a collection
CollectionsApi update_collection_binaries PATCH /v2/collections/{collection_id}/binaries Updates a collection binaries
CollectionsApi update_collection_tags PATCH /v2/collections/{collection_id}/tags Updates a collection tags
CollectionsApi v3_add_collection_binaries POST /v3/collections/{collection_id}/binaries Add binaries to a collection.
CollectionsApi v3_create_collection POST /v3/collections Create a collection.
CollectionsApi v3_delete_collection DELETE /v3/collections/{collection_id} Delete a collection.
CollectionsApi v3_get_collection GET /v3/collections/{collection_id} Get a collection.
CollectionsApi v3_list_collections GET /v3/collections List collections.
CollectionsApi v3_patch_collection PATCH /v3/collections/{collection_id} Update a collection.
CollectionsApi v3_patch_collection_binaries PATCH /v3/collections/{collection_id}/binaries Replace the binaries in a collection.
CollectionsApi v3_patch_collection_tags PATCH /v3/collections/{collection_id}/tags Replace the tags on a collection.
CollectionsApi v3_remove_collection_binaries DELETE /v3/collections/{collection_id}/binaries Remove binaries from a collection.
ConfigApi get_config GET /v2/config Get Config
ConfigApi v3_get_config GET /v3/config Get client configuration.
ConfigApi v3_get_models GET /v3/models Get the models available for analysis.
ConversationsApi cancel_run POST /v2/conversations/{id}/cancel Cancel an active run
ConversationsApi confirm_tool POST /v2/conversations/{id}/confirm Approve or reject a pending tool confirmation
ConversationsApi create_conversation POST /v2/conversations Create a new conversation
ConversationsApi get_conversation GET /v2/conversations/{id} Get a conversation with its events
ConversationsApi list_conversations GET /v2/conversations List conversations for the authenticated user
ConversationsApi send_message POST /v2/conversations/{id}/messages Send a message and start an agentic run
ConversationsApi stream_events GET /v2/conversations/{id}/events Stream conversation events (SSE)
DataTypesApi v3_copy_function_signatures POST /v3/analyses/{analysis_id}/signatures/copy Copy function signatures
DataTypesApi v3_create_analysis_data_types POST /v3/analyses/{analysis_id}/data-types Create an analysis's data types
DataTypesApi v3_get_analysis_data_type GET /v3/analyses/{analysis_id}/data-types/{data_type_id} Get one of an analysis's data types
DataTypesApi v3_get_analysis_data_type_history GET /v3/analyses/{analysis_id}/data-types/{data_type_id}/history Get a data type's edit history
DataTypesApi v3_get_function_signature GET /v3/analyses/{analysis_id}/functions/{function_id}/signature Get a function's signature
DataTypesApi v3_get_function_signature_history GET /v3/analyses/{analysis_id}/functions/{function_id}/signature/history Get a function signature's edit history
DataTypesApi v3_list_analysis_data_types GET /v3/analyses/{analysis_id}/data-types List an analysis's data types
DataTypesApi v3_list_data_type_functions GET /v3/analyses/{analysis_id}/data-types/{data_type_id}/functions List the functions using a data type
DataTypesApi v3_list_function_signatures GET /v3/functions/signatures Get signatures for many functions
DataTypesApi v3_update_analysis_data_types PUT /v3/analyses/{analysis_id}/data-types Update an analysis's data types
DataTypesApi v3_update_function_signature PUT /v3/analyses/{analysis_id}/functions/{function_id}/signature Update a function's signature
ExternalSourcesApi v3_get_virustotal_scan_operation GET /v3/operations/virustotal-scan/{binary_id} Get a VirusTotal scan operation.
ExternalSourcesApi v3_run_virustotal_scan POST /v3/binaries/{binary_id}/virustotal-scan:run Trigger a VirusTotal lookup for a binary.
FunctionsAIDecompilationApi create_ai_decompilation POST /v3/functions/{function_id}/ai-decompilation Start AI decompilation
FunctionsAIDecompilationApi delete_ai_decompilation_inline_comment DELETE /v3/functions/{function_id}/ai-decompilation/inline-comments/{line} Delete a single inline comment
FunctionsAIDecompilationApi get_ai_decompilation GET /v3/functions/{function_id}/ai-decompilation Get AI decompilation result
FunctionsAIDecompilationApi get_ai_decompilation_inline_comments GET /v3/functions/{function_id}/ai-decompilation/inline-comments Get AI decompilation inline comments
FunctionsAIDecompilationApi get_ai_decompilation_inline_comments_status GET /v3/functions/{function_id}/ai-decompilation/inline-comments/status Get inline comments generation workflow status
FunctionsAIDecompilationApi get_ai_decompilation_rating GET /v2/functions/{function_id}/ai-decompilation/rating Get rating for AI decompilation
FunctionsAIDecompilationApi get_ai_decompilation_status GET /v3/functions/{function_id}/ai-decompilation/status Get AI decompilation workflow status
FunctionsAIDecompilationApi get_ai_decompilation_summary GET /v3/functions/{function_id}/ai-decompilation/summary Get AI decompilation summary
FunctionsAIDecompilationApi get_ai_decompilation_summary_status GET /v3/functions/{function_id}/ai-decompilation/summary/status Get summary generation workflow status
FunctionsAIDecompilationApi patch_ai_decompilation_inline_comment PATCH /v3/functions/{function_id}/ai-decompilation/inline-comments Update a single inline comment
FunctionsAIDecompilationApi regenerate_ai_decompilation_inline_comments POST /v3/functions/{function_id}/ai-decompilation/inline-comments Regenerate AI decompilation inline comments
FunctionsAIDecompilationApi regenerate_ai_decompilation_summary POST /v3/functions/{function_id}/ai-decompilation/summary Regenerate AI decompilation summary
FunctionsAIDecompilationApi stream_ai_decompilation GET /v3/functions/{function_id}/ai-decompilation/events Stream live AI decompilation output (SSE)
FunctionsAIDecompilationApi upsert_ai_decompilation_rating PATCH /v2/functions/{function_id}/ai-decompilation/rating Upsert rating for AI decompilation
FunctionsAIDecompilationApi v3_accept_ai_decompilation_type_suggestions POST /v3/functions/{function_id}/ai-decompilation/type-suggestions/accept Accept AI decompilation type suggestions
FunctionsAIDecompilationApi v3_get_ai_decompilation_line_attributions GET /v3/functions/{function_id}/ai-decompilation/line-attributions Get AI decompilation line attributions
FunctionsAIDecompilationApi v3_get_ai_decompilation_rating GET /v3/functions/{function_id}/ai-decompilation/rating Get AI decompilation rating
FunctionsAIDecompilationApi v3_get_ai_decompilation_tokens GET /v3/functions/{function_id}/ai-decompilation/tokens Get AI decompilation tokens and user overrides
FunctionsAIDecompilationApi v3_get_ai_decompilation_type_suggestions GET /v3/functions/{function_id}/ai-decompilation/type-suggestions Get AI decompilation type suggestions
FunctionsAIDecompilationApi v3_get_ai_decompilation_type_suggestions_status GET /v3/functions/{function_id}/ai-decompilation/type-suggestions/status Get type suggestion workflow status
FunctionsAIDecompilationApi v3_regenerate_ai_decompilation_type_suggestions POST /v3/functions/{function_id}/ai-decompilation/type-suggestions Regenerate AI decompilation type suggestions
FunctionsAIDecompilationApi v3_upsert_ai_decompilation_overrides PATCH /v3/functions/{function_id}/ai-decompilation/overrides Upsert variable/function name overrides
FunctionsAIDecompilationApi v3_upsert_ai_decompilation_rating PATCH /v3/functions/{function_id}/ai-decompilation/rating Upsert AI decompilation rating
FunctionsCoreApi add_function_callee POST /v3/functions/{function_id}/callees Add a callee to a function
FunctionsCoreApi add_user_string_to_function POST /v3/functions/{function_id}/user-provided-strings Add a user-provided string to a function.
FunctionsCoreApi get_analysis_strings GET /v2/analyses/{analysis_id}/functions/strings Get string information found in the Analysis
FunctionsCoreApi get_analysis_strings_status GET /v2/analyses/{analysis_id}/functions/strings/status Get string processing state for the Analysis
FunctionsCoreApi get_function_blocks GET /v2/functions/{function_id}/blocks Get disassembly blocks related to the function
FunctionsCoreApi get_function_blocks_0 GET /v3/functions/{function_id}/blocks Get function disassembly
FunctionsCoreApi get_function_callees_callers GET /v2/functions/{function_id}/callees_callers Get list of functions that call or are called by the specified function
FunctionsCoreApi get_function_callees_callers_0 GET /v3/functions/{function_id}/callees-callers Get callees and callers for a function
FunctionsCoreApi get_function_callees_callers_bulk GET /v2/functions/callees_callers Get list of functions that call or are called for a list of functions
FunctionsCoreApi get_function_capabilities GET /v2/functions/{function_id}/capabilities Retrieve a functions capabilities
FunctionsCoreApi get_function_capabilities_0 GET /v3/functions/{function_id}/capabilities Get capabilities for a function
FunctionsCoreApi get_function_details GET /v2/functions/{function_id} Get function details
FunctionsCoreApi get_function_details_0 GET /v3/functions/{function_id} Get function details
FunctionsCoreApi get_function_indirect_call_sites GET /v3/functions/{function_id}/indirect-call-sites Get indirect call sites for a function
FunctionsCoreApi get_function_strings GET /v2/functions/{function_id}/strings Get string information found in the function
FunctionsCoreApi get_function_strings_0 GET /v3/functions/{function_id}/strings List strings for a function.
FunctionsCoreApi get_functions_callees_callers GET /v3/functions/callees-callers Get callees and callers for many functions
FunctionsCoreApi get_functions_matches GET /v3/functions/matches Get function-matching results for an explicit set of functions
FunctionsCoreApi get_functions_matching_status GET /v3/functions/matches/status Get function-matching status for an explicit set of functions
FunctionsCoreApi get_imported_function GET /v3/analyses/{analysis_id}/imported-functions/{imported_function_id} Get an imported function with its callers
FunctionsCoreApi list_analysis_functions GET /v3/analyses/{analysis_id}/functions List functions in an analysis
FunctionsCoreApi list_imported_functions GET /v3/analyses/{analysis_id}/imported-functions List imported functions in an analysis
FunctionsCoreApi start_functions_matching POST /v3/functions/matches Start function matching for an explicit set of functions
FunctionsCoreApi v3_canonicalize_function_names POST /v3/functions/canonical-names Canonicalize a batch of function names
FunctionsCoreApi v3_get_analysis_func_maps GET /v3/analyses/{analysis_id}/func-maps Get function ID/address maps for an analysis
FunctionsCoreApi v3_list_function_globals GET /v3/functions/{function_id}/globals List the global variables a function references.
FunctionsCoreApi v3_search_functions GET /v3/functions Search functions
FunctionsRenamingHistoryApi batch_rename_function POST /v2/functions/rename/batch Batch Rename Functions
FunctionsRenamingHistoryApi batch_rename_functions POST /v3/functions/rename Batch rename functions
FunctionsRenamingHistoryApi get_function_history GET /v3/functions/{function_id}/history Get function name history
FunctionsRenamingHistoryApi get_function_name_history GET /v2/functions/history/{function_id} Get Function Name History
FunctionsRenamingHistoryApi rename_function POST /v3/functions/{function_id}/rename Rename a function
FunctionsRenamingHistoryApi rename_function_id POST /v2/functions/rename/{function_id} Rename Function
FunctionsRenamingHistoryApi revert_function_name POST /v2/functions/history/{function_id}/{history_id} Revert the function name
FunctionsRenamingHistoryApi revert_function_name_0 POST /v3/functions/{function_id}/history/{history_id}/revert Revert function name
IAMUsersApi get_me GET /v2/iam/me Get current user
IAMUsersApi get_my_permissions GET /v2/iam/me/permissions Get current user permissions
InvestigationsApi v3_create_investigation POST /v3/investigations Create an investigation.
InvestigationsApi v3_create_investigation_conversation POST /v3/investigations/{investigation_id}/conversations Start a conversation in an investigation.
InvestigationsApi v3_delete_investigation DELETE /v3/investigations/{investigation_id} Delete an investigation.
InvestigationsApi v3_get_investigation GET /v3/investigations/{investigation_id} Get an investigation.
InvestigationsApi v3_get_investigation_finding GET /v3/investigations/{investigation_id}/findings/{finding_id} Get a finding of an investigation.
InvestigationsApi v3_list_investigation_agent_runs GET /v3/investigations/agent-runs List agent runs on investigations.
InvestigationsApi v3_list_investigation_conversations GET /v3/investigations/{investigation_id}/conversations List the conversations of an investigation.
InvestigationsApi v3_list_investigation_findings GET /v3/investigations/{investigation_id}/findings List the findings of an investigation.
InvestigationsApi v3_list_investigation_spend GET /v3/investigations/{investigation_id}/spend List what an investigation spent.
InvestigationsApi v3_list_investigations GET /v3/investigations List investigations.
InvestigationsApi v3_patch_investigation PATCH /v3/investigations/{investigation_id} Update an investigation.
InvestigationsApi v3_set_investigation_budget PUT /v3/investigations/{investigation_id}/budget Set the budget of an investigation.
ModelsApi get_models GET /v2/models Gets models
ReportsApi create_pdf_report POST /v3/analyses/{analysis_id}/pdf Start PDF report generation
ReportsApi download_pdf_report GET /v3/analyses/{analysis_id}/pdf Download generated PDF report
ReportsApi get_pdf_report_status GET /v3/analyses/{analysis_id}/pdf/status Get PDF report workflow status
SearchApi search_binaries GET /v2/search/binaries Binaries search
SearchApi search_collections GET /v2/search/collections Collections search
SearchApi search_functions GET /v2/search/functions Functions search
SearchApi search_tags GET /v2/search/tags Tags search

Documentation For Models