Skip to content

Repository files navigation

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:

importosimportrevengaiconfiguration=revengai.Configuration(api_key={'APIKey': os.environ["API_KEY"]})
# Enter a context with an instance of the API clientwithrevengai.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=revengai.AnalysesCoreApi(api_client)
analysis_id=715320try:
# Gets the logs of an analysisapi_response=api_instance.get_analysis_logs(analysis_id)
print("The response of AnalysesCoreApi->get_analysis_logs:\n")
print(api_response)
exceptExceptionase:
print("Exception when calling AnalysesCoreApi->get_analysis_logs: %s\n"%e)

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
AgentApicheck_capabilities_task_status_v2_analyses_analysis_id_agent_capabilities_status_getGET /v2/analyses/{analysis_id}/agent/capabilities/statusCheck the status of a capabilities analysis workflow
AgentApicheck_remediation_task_status_v2_analyses_analysis_id_agent_remediation_status_getGET /v2/analyses/{analysis_id}/agent/remediation/statusCheck the status of a remediation analysis workflow
AgentApicheck_report_analysis_task_status_v2_analyses_analysis_id_agent_report_analysis_status_getGET /v2/analyses/{analysis_id}/agent/report-analysis/statusCheck the status of a report analysis workflow
AgentApicheck_triage_task_status_v2_analyses_analysis_id_agent_triage_status_getGET /v2/analyses/{analysis_id}/agent/triage/statusCheck the status of a triage analysis workflow
AgentApicreate_capabilities_task_v2_analyses_analysis_id_agent_capabilities_postPOST /v2/analyses/{analysis_id}/agent/capabilitiesQueues a capabilities analysis workflow process
AgentApicreate_remediation_task_v2_analyses_analysis_id_agent_remediation_postPOST /v2/analyses/{analysis_id}/agent/remediationQueues a remediation analysis workflow process
AgentApicreate_report_analysis_task_v2_analyses_analysis_id_agent_report_analysis_postPOST /v2/analyses/{analysis_id}/agent/report-analysisQueues a combined report analysis workflow process
AgentApicreate_triage_task_v2_analyses_analysis_id_agent_triage_postPOST /v2/analyses/{analysis_id}/agent/triageQueues a triage analysis workflow process
AgentApiget_capabilities_result_v2_analyses_analysis_id_agent_capabilities_getGET /v2/analyses/{analysis_id}/agent/capabilitiesGet Capabilities Result
AgentApiget_remediation_result_v2_analyses_analysis_id_agent_remediation_getGET /v2/analyses/{analysis_id}/agent/remediationGet Remediation Result
AgentApiget_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_getGET /v2/analyses/{analysis_id}/agent/report-analysisGet Report Analysis Result
AgentApiget_triage_result_v2_analyses_analysis_id_agent_triage_getGET /v2/analyses/{analysis_id}/agent/triageGet Triage Result
AgentApiv3_cancel_rename_unnamed_functionsPOST /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/cancelCancel the rename-unnamed-functions agent.
AgentApiv3_get_rename_unnamed_functions_resultGET /v3/analyses/{analysis_id}/agents/rename-unnamed-functionsGet rename-unnamed-functions agent result.
AgentApiv3_get_rename_unnamed_functions_statusGET /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/statusGet rename-unnamed-functions agent status.
AgentApiv3_trigger_rename_unnamed_functionsPOST /v3/analyses/{analysis_id}/agents/rename-unnamed-functionsRun the rename-unnamed-functions agent.
AnalysesBulkActionsApibulk_add_analysis_tagsPATCH /v2/analyses/tags/addBulk Add Analysis Tags
AnalysesBulkActionsApibulk_delete_analysesPATCH /v2/analyses/deleteBulk Delete Analyses
AnalysesCommentsApicreate_analysis_commentPOST /v2/analyses/{analysis_id}/commentsCreate a comment for this analysis
AnalysesCommentsApidelete_analysis_commentDELETE /v2/analyses/{analysis_id}/comments/{comment_id}Delete a comment
AnalysesCommentsApiget_analysis_commentsGET /v2/analyses/{analysis_id}/commentsGet comments for this analysis
AnalysesCommentsApiupdate_analysis_commentPATCH /v2/analyses/{analysis_id}/comments/{comment_id}Update a comment
AnalysesCoreApiadd_user_string_to_analysisPOST /v3/analyses/{analysis_id}/user-provided-stringsAdd a user-provided string to an analysis.
AnalysesCoreApicreate_analysisPOST /v2/analysesCreate Analysis
AnalysesCoreApidelete_analysisDELETE /v2/analyses/{analysis_id}Delete Analysis
AnalysesCoreApiget_analysis_basic_infoGET /v2/analyses/{analysis_id}/basicGets basic analysis information
AnalysesCoreApiget_analysis_basic_info_0GET /v3/analyses/{analysis_id}/basicGet basic analysis information
AnalysesCoreApiget_analysis_bytesGET /v3/analyses/{analysis_id}/bytesGet the bytes of a binary
AnalysesCoreApiget_analysis_function_mapGET /v2/analyses/{analysis_id}/func_mapsGet Analysis Function Map
AnalysesCoreApiget_analysis_function_matchesGET /v3/analyses/{analysis_id}/functions/matchesGet function-matching results for an analysis
AnalysesCoreApiget_analysis_function_matching_statusGET /v3/analyses/{analysis_id}/functions/matches/statusGet function-matching status for an analysis
AnalysesCoreApiget_analysis_logsGET /v2/analyses/{analysis_id}/logsGets the logs of an analysis
AnalysesCoreApiget_analysis_paramsGET /v2/analyses/{analysis_id}/paramsGets analysis param information
AnalysesCoreApiget_analysis_statusGET /v2/analyses/{analysis_id}/statusGets the status of an analysis
AnalysesCoreApiget_dynamic_execution_reportGET /v2/analyses/{analysis_id}/dynamic-execution/reportGet dynamic execution report
AnalysesCoreApiget_dynamic_execution_statusGET /v2/analyses/{analysis_id}/dynamic-execution/statusGet dynamic execution status
AnalysesCoreApiinsert_analysis_logPOST /v2/analyses/{analysis_id}/logsInsert a log entry for an analysis
AnalysesCoreApilist_analysesGET /v2/analyses/listGets the most recent analyses
AnalysesCoreApilookup_binary_idGET /v2/analyses/lookup/{binary_id}Gets the analysis ID from binary ID
AnalysesCoreApiput_analysis_stringsPUT /v2/analyses/{analysis_id}/stringsAdd strings to the analysis
AnalysesCoreApirequeue_analysisPOST /v2/analyses/{analysis_id}/requeueRequeue Analysis
AnalysesCoreApistart_analysis_function_matchingPOST /v3/analyses/{analysis_id}/functions/matchesStart function matching for an analysis
AnalysesCoreApiupdate_analysisPATCH /v2/analyses/{analysis_id}Update Analysis
AnalysesCoreApiupdate_analysis_tagsPATCH /v2/analyses/{analysis_id}/tagsUpdate Analysis Tags
AnalysesCoreApiupload_filePOST /v2/uploadUpload File
AnalysesCoreApiv3_get_analysis_auto_unstrip_statusGET /v3/analyses/{analysis_id}/auto-unstrip/statusGet the auto-unstrip status for an analysis.
AnalysesCoreApiv3_get_analysis_logsGET /v3/analyses/{analysis_id}/logsGet the Analysis log
AnalysesCoreApiv3_get_analysis_stringsGET /v3/analyses/{analysis_id}/functions/stringsList strings for an analysis.
AnalysesCoreApiv3_get_analysis_strings_statusGET /v3/analyses/{analysis_id}/functions/strings/statusGet the string-extraction status for an analysis.
AnalysesCoreApiv3_list_analysesGET /v3/analysesList analyses
AnalysesCoreApiv3_list_example_analysesGET /v3/analyses/examplesList example analyses
AnalysesResultsMetadataApiget_analysis_functions_paginatedGET /v2/analyses/{analysis_id}/functionsGet functions from analysis
AnalysesResultsMetadataApiget_capabilitiesGET /v2/analyses/{analysis_id}/capabilitiesGets the capabilities from the analysis
AnalysesResultsMetadataApiget_functions_listGET /v2/analyses/{analysis_id}/functions/listGets functions from analysis
AnalysesResultsMetadataApiget_tagsGET /v2/analyses/{analysis_id}/tagsGet function tags with maliciousness score
AnalysesXRefsApiget_xref_by_vaddrGET /v2/analyses/{analysis_id}/xrefs/{vaddr}[Beta] Look up xrefs by virtual address
AuthenticationUsersApiget_userGET /v2/users/{user_id}Get a user's public information
AuthenticationUsersApiget_user_activityGET /v2/users/activityGet auth user activity
AuthenticationUsersApisubmit_user_feedbackPOST /v2/users/feedbackSubmit feedback about the application
BinariesApidownload_zipped_binaryGET /v2/binaries/{binary_id}/download-zippedDownloads a zipped binary with password protection
BinariesApiget_binary_additional_detailsGET /v2/binaries/{binary_id}/additional-detailsGets the additional details of a binary
BinariesApiget_binary_additional_details_0GET /v3/binaries/{binary_id}/additional-detailsGet additional details for a binary.
BinariesApiget_binary_additional_details_statusGET /v2/binaries/{binary_id}/additional-details/statusGets the status of the additional details task for a binary
BinariesApiget_binary_additional_details_status_0GET /v3/binaries/{binary_id}/additional-details/statusGet the additional-details extraction status for a binary.
BinariesApiget_binary_detailsGET /v2/binaries/{binary_id}/detailsGets the details of a binary
BinariesApiget_binary_die_infoGET /v2/binaries/{binary_id}/die-infoGets the die info of a binary
BinariesApiget_binary_externalsGET /v2/binaries/{binary_id}/externalsGets the external details of a binary
BinariesApiget_binary_related_statusGET /v2/binaries/{binary_id}/related/statusGets the status of the unpack binary task for a binary
BinariesApiget_related_binariesGET /v2/binaries/{binary_id}/relatedGets the related binaries of a binary.
CollectionsApicreate_collectionPOST /v2/collectionsCreates new collection information
CollectionsApidelete_collectionDELETE /v2/collections/{collection_id}Deletes a collection
CollectionsApiget_collectionGET /v2/collections/{collection_id}Returns a collection
CollectionsApilist_collectionsGET /v2/collectionsGets basic collections information
CollectionsApiupdate_collectionPATCH /v2/collections/{collection_id}Updates a collection
CollectionsApiupdate_collection_binariesPATCH /v2/collections/{collection_id}/binariesUpdates a collection binaries
CollectionsApiupdate_collection_tagsPATCH /v2/collections/{collection_id}/tagsUpdates a collection tags
CollectionsApiv3_add_collection_binariesPOST /v3/collections/{collection_id}/binariesAdd binaries to a collection.
CollectionsApiv3_create_collectionPOST /v3/collectionsCreate a collection.
CollectionsApiv3_delete_collectionDELETE /v3/collections/{collection_id}Delete a collection.
CollectionsApiv3_get_collectionGET /v3/collections/{collection_id}Get a collection.
CollectionsApiv3_list_collectionsGET /v3/collectionsList collections.
CollectionsApiv3_patch_collectionPATCH /v3/collections/{collection_id}Update a collection.
CollectionsApiv3_patch_collection_binariesPATCH /v3/collections/{collection_id}/binariesReplace the binaries in a collection.
CollectionsApiv3_patch_collection_tagsPATCH /v3/collections/{collection_id}/tagsReplace the tags on a collection.
CollectionsApiv3_remove_collection_binariesDELETE /v3/collections/{collection_id}/binariesRemove binaries from a collection.
ConfigApiget_configGET /v2/configGet Config
ConversationsApicancel_runPOST /v2/conversations/{id}/cancelCancel an active run
ConversationsApiconfirm_toolPOST /v2/conversations/{id}/confirmApprove or reject a pending tool confirmation
ConversationsApicreate_conversationPOST /v2/conversationsCreate a new conversation
ConversationsApiget_conversationGET /v2/conversations/{id}Get a conversation with its events
ConversationsApilist_conversationsGET /v2/conversationsList conversations for the authenticated user
ConversationsApisend_messagePOST /v2/conversations/{id}/messagesSend a message and start an agentic run
ConversationsApistream_eventsGET /v2/conversations/{id}/eventsStream conversation events (SSE)
DataTypesApiv3_copy_function_signaturesPOST /v3/analyses/{analysis_id}/signatures/copyCopy function signatures
DataTypesApiv3_create_analysis_data_typesPOST /v3/analyses/{analysis_id}/data-typesCreate an analysis's data types
DataTypesApiv3_get_analysis_data_typeGET /v3/analyses/{analysis_id}/data-types/{data_type_id}Get one of an analysis's data types
DataTypesApiv3_get_analysis_data_type_historyGET /v3/analyses/{analysis_id}/data-types/{data_type_id}/historyGet a data type's edit history
DataTypesApiv3_get_function_signatureGET /v3/analyses/{analysis_id}/functions/{function_id}/signatureGet a function's signature
DataTypesApiv3_get_function_signature_historyGET /v3/analyses/{analysis_id}/functions/{function_id}/signature/historyGet a function signature's edit history
DataTypesApiv3_list_analysis_data_typesGET /v3/analyses/{analysis_id}/data-typesList an analysis's data types
DataTypesApiv3_list_data_type_functionsGET /v3/analyses/{analysis_id}/data-types/{data_type_id}/functionsList the functions using a data type
DataTypesApiv3_list_function_signaturesGET /v3/functions/signaturesGet signatures for many functions
DataTypesApiv3_update_analysis_data_typesPUT /v3/analyses/{analysis_id}/data-typesUpdate an analysis's data types
DataTypesApiv3_update_function_signaturePUT /v3/analyses/{analysis_id}/functions/{function_id}/signatureUpdate a function's signature
ExternalSourcesApicreate_external_task_vtPOST /v2/analysis/{analysis_id}/external/vtPulls data from VirusTotal
ExternalSourcesApiget_vt_dataGET /v2/analysis/{analysis_id}/external/vtGet VirusTotal data
ExternalSourcesApiget_vt_task_statusGET /v2/analysis/{analysis_id}/external/vt/statusCheck the status of VirusTotal data retrieval
FirmwareApiget_binaries_for_firmware_taskGET /v2/firmware/get-binaries/{task_id}Upload firmware for unpacking
FirmwareApiupload_firmwarePOST /v2/firmwareUpload firmware for unpacking
FunctionsAIDecompilationApicreate_ai_decompilationPOST /v3/functions/{function_id}/ai-decompilationStart AI decompilation
FunctionsAIDecompilationApidelete_ai_decompilation_inline_commentDELETE /v3/functions/{function_id}/ai-decompilation/inline-comments/{line}Delete a single inline comment
FunctionsAIDecompilationApiget_ai_decompilationGET /v3/functions/{function_id}/ai-decompilationGet AI decompilation result
FunctionsAIDecompilationApiget_ai_decompilation_inline_commentsGET /v3/functions/{function_id}/ai-decompilation/inline-commentsGet AI decompilation inline comments
FunctionsAIDecompilationApiget_ai_decompilation_inline_comments_statusGET /v3/functions/{function_id}/ai-decompilation/inline-comments/statusGet inline comments generation workflow status
FunctionsAIDecompilationApiget_ai_decompilation_ratingGET /v2/functions/{function_id}/ai-decompilation/ratingGet rating for AI decompilation
FunctionsAIDecompilationApiget_ai_decompilation_statusGET /v3/functions/{function_id}/ai-decompilation/statusGet AI decompilation workflow status
FunctionsAIDecompilationApiget_ai_decompilation_summaryGET /v3/functions/{function_id}/ai-decompilation/summaryGet AI decompilation summary
FunctionsAIDecompilationApiget_ai_decompilation_summary_statusGET /v3/functions/{function_id}/ai-decompilation/summary/statusGet summary generation workflow status
FunctionsAIDecompilationApipatch_ai_decompilation_inline_commentPATCH /v3/functions/{function_id}/ai-decompilation/inline-commentsUpdate a single inline comment
FunctionsAIDecompilationApiregenerate_ai_decompilation_inline_commentsPOST /v3/functions/{function_id}/ai-decompilation/inline-commentsRegenerate AI decompilation inline comments
FunctionsAIDecompilationApiregenerate_ai_decompilation_summaryPOST /v3/functions/{function_id}/ai-decompilation/summaryRegenerate AI decompilation summary
FunctionsAIDecompilationApistream_ai_decompilationGET /v3/functions/{function_id}/ai-decompilation/eventsStream live AI decompilation output (SSE)
FunctionsAIDecompilationApiupsert_ai_decompilation_ratingPATCH /v2/functions/{function_id}/ai-decompilation/ratingUpsert rating for AI decompilation
FunctionsAIDecompilationApiv3_get_ai_decompilation_line_attributionsGET /v3/functions/{function_id}/ai-decompilation/line-attributionsGet AI decompilation line attributions
FunctionsAIDecompilationApiv3_get_ai_decompilation_tokensGET /v3/functions/{function_id}/ai-decompilation/tokensGet AI decompilation tokens and user overrides
FunctionsAIDecompilationApiv3_upsert_ai_decompilation_overridesPATCH /v3/functions/{function_id}/ai-decompilation/overridesUpsert variable/function name overrides
FunctionsCoreApiadd_function_calleePOST /v3/functions/{function_id}/calleesAdd a callee to a function
FunctionsCoreApiadd_user_string_to_functionPOST /v3/functions/{function_id}/user-provided-stringsAdd a user-provided string to a function.
FunctionsCoreApiget_analysis_stringsGET /v2/analyses/{analysis_id}/functions/stringsGet string information found in the Analysis
FunctionsCoreApiget_analysis_strings_statusGET /v2/analyses/{analysis_id}/functions/strings/statusGet string processing state for the Analysis
FunctionsCoreApiget_function_blocksGET /v2/functions/{function_id}/blocksGet disassembly blocks related to the function
FunctionsCoreApiget_function_blocks_0GET /v3/functions/{function_id}/blocksGet function disassembly
FunctionsCoreApiget_function_callees_callersGET /v2/functions/{function_id}/callees_callersGet list of functions that call or are called by the specified function
FunctionsCoreApiget_function_callees_callers_0GET /v3/functions/{function_id}/callees-callersGet callees and callers for a function
FunctionsCoreApiget_function_callees_callers_bulkGET /v2/functions/callees_callersGet list of functions that call or are called for a list of functions
FunctionsCoreApiget_function_capabilitiesGET /v2/functions/{function_id}/capabilitiesRetrieve a functions capabilities
FunctionsCoreApiget_function_capabilities_0GET /v3/functions/{function_id}/capabilitiesGet capabilities for a function
FunctionsCoreApiget_function_detailsGET /v2/functions/{function_id}Get function details
FunctionsCoreApiget_function_details_0GET /v3/functions/{function_id}Get function details
FunctionsCoreApiget_function_indirect_call_sitesGET /v3/functions/{function_id}/indirect-call-sitesGet indirect call sites for a function
FunctionsCoreApiget_function_stringsGET /v2/functions/{function_id}/stringsGet string information found in the function
FunctionsCoreApiget_function_strings_0GET /v3/functions/{function_id}/stringsList strings for a function.
FunctionsCoreApiget_functions_callees_callersGET /v3/functions/callees-callersGet callees and callers for many functions
FunctionsCoreApiget_functions_matchesGET /v3/functions/matchesGet function-matching results for an explicit set of functions
FunctionsCoreApiget_functions_matching_statusGET /v3/functions/matches/statusGet function-matching status for an explicit set of functions
FunctionsCoreApiget_imported_functionGET /v3/analyses/{analysis_id}/imported-functions/{imported_function_id}Get an imported function with its callers
FunctionsCoreApilist_analysis_functionsGET /v3/analyses/{analysis_id}/functionsList functions in an analysis
FunctionsCoreApilist_imported_functionsGET /v3/analyses/{analysis_id}/imported-functionsList imported functions in an analysis
FunctionsCoreApistart_functions_matchingPOST /v3/functions/matchesStart function matching for an explicit set of functions
FunctionsCoreApiv3_canonicalize_function_namesPOST /v3/functions/canonical-namesCanonicalize a batch of function names
FunctionsRenamingHistoryApibatch_rename_functionPOST /v2/functions/rename/batchBatch Rename Functions
FunctionsRenamingHistoryApibatch_rename_functionsPOST /v3/functions/renameBatch rename functions
FunctionsRenamingHistoryApiget_function_historyGET /v3/functions/{function_id}/historyGet function name history
FunctionsRenamingHistoryApiget_function_name_historyGET /v2/functions/history/{function_id}Get Function Name History
FunctionsRenamingHistoryApirename_functionPOST /v3/functions/{function_id}/renameRename a function
FunctionsRenamingHistoryApirename_function_idPOST /v2/functions/rename/{function_id}Rename Function
FunctionsRenamingHistoryApirevert_function_namePOST /v2/functions/history/{function_id}/{history_id}Revert the function name
FunctionsRenamingHistoryApirevert_function_name_0POST /v3/functions/{function_id}/history/{history_id}/revertRevert function name
IAMUsersApiget_meGET /v2/iam/meGet current user
IAMUsersApiget_my_permissionsGET /v2/iam/me/permissionsGet current user permissions
ModelsApiget_modelsGET /v2/modelsGets models
ReportsApicreate_pdf_reportPOST /v3/analyses/{analysis_id}/pdfStart PDF report generation
ReportsApidownload_pdf_reportGET /v3/analyses/{analysis_id}/pdfDownload generated PDF report
ReportsApiget_pdf_report_statusGET /v3/analyses/{analysis_id}/pdf/statusGet PDF report workflow status
SearchApisearch_binariesGET /v2/search/binariesBinaries search
SearchApisearch_collectionsGET /v2/search/collectionsCollections search
SearchApisearch_functionsGET /v2/search/functionsFunctions search
SearchApisearch_tagsGET /v2/search/tagsTags search

Documentation For Models

About

RevEng.AI Python SDK

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages