Skip to content

Repository files navigation

RevEng.AI TypeScript SDK

This is the TypeScript 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 npm:

npm install @revengai/sdk

Usage

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

import*asrevengaifrom'@revengai/sdk'constauthConfig: revengai.AuthMethodsConfiguration={APIKey: process.env.REVENGAI_API_KEY}constconfig=revengai.createConfiguration({authMethods: authConfig,});constapi=newrevengai.AnalysesCoreApi(config);asyncfunctionfetchLogs(){try{constlogs=awaitapi.getAnalysisLogs(715522);console.log(logs);}catch(error){console.error('Error fetching logs:',error);}}fetchLogs();

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
AgentApicheckCapabilitiesTaskStatusV2AnalysesAnalysisIdAgentCapabilitiesStatusGetGET /v2/analyses/{analysis_id}/agent/capabilities/statusCheck the status of a capabilities analysis workflow
AgentApicheckRemediationTaskStatusV2AnalysesAnalysisIdAgentRemediationStatusGetGET /v2/analyses/{analysis_id}/agent/remediation/statusCheck the status of a remediation analysis workflow
AgentApicheckReportAnalysisTaskStatusV2AnalysesAnalysisIdAgentReportAnalysisStatusGetGET /v2/analyses/{analysis_id}/agent/report-analysis/statusCheck the status of a report analysis workflow
AgentApicheckTriageTaskStatusV2AnalysesAnalysisIdAgentTriageStatusGetGET /v2/analyses/{analysis_id}/agent/triage/statusCheck the status of a triage analysis workflow
AgentApicreateCapabilitiesTaskV2AnalysesAnalysisIdAgentCapabilitiesPostPOST /v2/analyses/{analysis_id}/agent/capabilitiesQueues a capabilities analysis workflow process
AgentApicreateRemediationTaskV2AnalysesAnalysisIdAgentRemediationPostPOST /v2/analyses/{analysis_id}/agent/remediationQueues a remediation analysis workflow process
AgentApicreateReportAnalysisTaskV2AnalysesAnalysisIdAgentReportAnalysisPostPOST /v2/analyses/{analysis_id}/agent/report-analysisQueues a combined report analysis workflow process
AgentApicreateTriageTaskV2AnalysesAnalysisIdAgentTriagePostPOST /v2/analyses/{analysis_id}/agent/triageQueues a triage analysis workflow process
AgentApigetCapabilitiesResultV2AnalysesAnalysisIdAgentCapabilitiesGetGET /v2/analyses/{analysis_id}/agent/capabilitiesGet Capabilities Result
AgentApigetRemediationResultV2AnalysesAnalysisIdAgentRemediationGetGET /v2/analyses/{analysis_id}/agent/remediationGet Remediation Result
AgentApigetReportAnalysisResultV2AnalysesAnalysisIdAgentReportAnalysisGetGET /v2/analyses/{analysis_id}/agent/report-analysisGet Report Analysis Result
AgentApigetTriageResultV2AnalysesAnalysisIdAgentTriageGetGET /v2/analyses/{analysis_id}/agent/triageGet Triage Result
AnalysesBulkActionsApibulkAddAnalysisTagsPATCH /v2/analyses/tags/addBulk Add Analysis Tags
AnalysesBulkActionsApibulkDeleteAnalysesPATCH /v2/analyses/deleteBulk Delete Analyses
AnalysesCommentsApicreateAnalysisCommentPOST /v2/analyses/{analysis_id}/commentsCreate a comment for this analysis
AnalysesCommentsApideleteAnalysisCommentDELETE /v2/analyses/{analysis_id}/comments/{comment_id}Delete a comment
AnalysesCommentsApigetAnalysisCommentsGET /v2/analyses/{analysis_id}/commentsGet comments for this analysis
AnalysesCommentsApiupdateAnalysisCommentPATCH /v2/analyses/{analysis_id}/comments/{comment_id}Update a comment
AnalysesCoreApiaddUserStringToAnalysisPOST /v3/analyses/{analysis_id}/user-provided-stringsAdd a user-provided string to an analysis.
AnalysesCoreApicreateAnalysisPOST /v2/analysesCreate Analysis
AnalysesCoreApideleteAnalysisDELETE /v2/analyses/{analysis_id}Delete Analysis
AnalysesCoreApigetAnalysisBasicInfoGET /v2/analyses/{analysis_id}/basicGets basic analysis information
AnalysesCoreApigetAnalysisBasicInfo_0GET /v3/analyses/{analysis_id}/basicGet basic analysis information
AnalysesCoreApigetAnalysisBytesGET /v3/analyses/{analysis_id}/bytesGet the bytes of a binary
AnalysesCoreApigetAnalysisFunctionMapGET /v2/analyses/{analysis_id}/func_mapsGet Analysis Function Map
AnalysesCoreApigetAnalysisFunctionMatchesGET /v3/analyses/{analysis_id}/functions/matchesGet function-matching results for an analysis
AnalysesCoreApigetAnalysisFunctionMatchingStatusGET /v3/analyses/{analysis_id}/functions/matches/statusGet function-matching status for an analysis
AnalysesCoreApigetAnalysisLogsGET /v2/analyses/{analysis_id}/logsGets the logs of an analysis
AnalysesCoreApigetAnalysisParamsGET /v2/analyses/{analysis_id}/paramsGets analysis param information
AnalysesCoreApigetAnalysisStatusGET /v2/analyses/{analysis_id}/statusGets the status of an analysis
AnalysesCoreApigetDynamicExecutionReportGET /v2/analyses/{analysis_id}/dynamic-execution/reportGet dynamic execution report
AnalysesCoreApigetDynamicExecutionStatusGET /v2/analyses/{analysis_id}/dynamic-execution/statusGet dynamic execution status
AnalysesCoreApiinsertAnalysisLogPOST /v2/analyses/{analysis_id}/logsInsert a log entry for an analysis
AnalysesCoreApilistAnalysesGET /v2/analyses/listGets the most recent analyses
AnalysesCoreApilookupBinaryIdGET /v2/analyses/lookup/{binary_id}Gets the analysis ID from binary ID
AnalysesCoreApiputAnalysisStringsPUT /v2/analyses/{analysis_id}/stringsAdd strings to the analysis
AnalysesCoreApirequeueAnalysisPOST /v2/analyses/{analysis_id}/requeueRequeue Analysis
AnalysesCoreApistartAnalysisFunctionMatchingPOST /v3/analyses/{analysis_id}/functions/matchesStart function matching for an analysis
AnalysesCoreApiupdateAnalysisPATCH /v2/analyses/{analysis_id}Update Analysis
AnalysesCoreApiupdateAnalysisTagsPATCH /v2/analyses/{analysis_id}/tagsUpdate Analysis Tags
AnalysesCoreApiuploadFilePOST /v2/uploadUpload File
AnalysesCoreApiv3GetAnalysisAutoUnstripStatusGET /v3/analyses/{analysis_id}/auto-unstrip/statusGet the auto-unstrip status for an analysis.
AnalysesCoreApiv3GetAnalysisStringsGET /v3/analyses/{analysis_id}/functions/stringsList strings for an analysis.
AnalysesCoreApiv3GetAnalysisStringsStatusGET /v3/analyses/{analysis_id}/functions/strings/statusGet the string-extraction status for an analysis.
AnalysesCoreApiv3ListAnalysesGET /v3/analysesList analyses
AnalysesCoreApiv3ListExampleAnalysesGET /v3/analyses/examplesList example analyses
AnalysesResultsMetadataApigetAnalysisFunctionsPaginatedGET /v2/analyses/{analysis_id}/functionsGet functions from analysis
AnalysesResultsMetadataApigetCapabilitiesGET /v2/analyses/{analysis_id}/capabilitiesGets the capabilities from the analysis
AnalysesResultsMetadataApigetFunctionsListGET /v2/analyses/{analysis_id}/functions/listGets functions from analysis
AnalysesResultsMetadataApigetTagsGET /v2/analyses/{analysis_id}/tagsGet function tags with maliciousness score
AnalysesXRefsApigetXrefByVaddrGET /v2/analyses/{analysis_id}/xrefs/{vaddr}[Beta] Look up xrefs by virtual address
AuthenticationUsersApigetUserGET /v2/users/{user_id}Get a user's public information
AuthenticationUsersApigetUserActivityGET /v2/users/activityGet auth user activity
AuthenticationUsersApisubmitUserFeedbackPOST /v2/users/feedbackSubmit feedback about the application
BinariesApidownloadZippedBinaryGET /v2/binaries/{binary_id}/download-zippedDownloads a zipped binary with password protection
BinariesApigetBinaryAdditionalDetailsGET /v2/binaries/{binary_id}/additional-detailsGets the additional details of a binary
BinariesApigetBinaryAdditionalDetailsStatusGET /v2/binaries/{binary_id}/additional-details/statusGets the status of the additional details task for a binary
BinariesApigetBinaryAdditionalDetailsStatus_0GET /v3/binaries/{binary_id}/additional-details/statusGet the additional-details extraction status for a binary.
BinariesApigetBinaryAdditionalDetails_0GET /v3/binaries/{binary_id}/additional-detailsGet additional details for a binary.
BinariesApigetBinaryDetailsGET /v2/binaries/{binary_id}/detailsGets the details of a binary
BinariesApigetBinaryDieInfoGET /v2/binaries/{binary_id}/die-infoGets the die info of a binary
BinariesApigetBinaryExternalsGET /v2/binaries/{binary_id}/externalsGets the external details of a binary
BinariesApigetBinaryRelatedStatusGET /v2/binaries/{binary_id}/related/statusGets the status of the unpack binary task for a binary
BinariesApigetRelatedBinariesGET /v2/binaries/{binary_id}/relatedGets the related binaries of a binary.
CollectionsApicreateCollectionPOST /v2/collectionsCreates new collection information
CollectionsApideleteCollectionDELETE /v2/collections/{collection_id}Deletes a collection
CollectionsApigetCollectionGET /v2/collections/{collection_id}Returns a collection
CollectionsApilistCollectionsGET /v2/collectionsGets basic collections information
CollectionsApiupdateCollectionPATCH /v2/collections/{collection_id}Updates a collection
CollectionsApiupdateCollectionBinariesPATCH /v2/collections/{collection_id}/binariesUpdates a collection binaries
CollectionsApiupdateCollectionTagsPATCH /v2/collections/{collection_id}/tagsUpdates a collection tags
CollectionsApiv3AddCollectionBinariesPOST /v3/collections/{collection_id}/binariesAdd binaries to a collection.
CollectionsApiv3CreateCollectionPOST /v3/collectionsCreate a collection.
CollectionsApiv3DeleteCollectionDELETE /v3/collections/{collection_id}Delete a collection.
CollectionsApiv3GetCollectionGET /v3/collections/{collection_id}Get a collection.
CollectionsApiv3ListCollectionsGET /v3/collectionsList collections.
CollectionsApiv3PatchCollectionPATCH /v3/collections/{collection_id}Update a collection.
CollectionsApiv3PatchCollectionBinariesPATCH /v3/collections/{collection_id}/binariesReplace the binaries in a collection.
CollectionsApiv3PatchCollectionTagsPATCH /v3/collections/{collection_id}/tagsReplace the tags on a collection.
CollectionsApiv3RemoveCollectionBinariesDELETE /v3/collections/{collection_id}/binariesRemove binaries from a collection.
ConfigApigetConfigGET /v2/configGet Config
ConversationsApicancelRunPOST /v2/conversations/{id}/cancelCancel an active run
ConversationsApiconfirmToolPOST /v2/conversations/{id}/confirmApprove or reject a pending tool confirmation
ConversationsApicreateConversationPOST /v2/conversationsCreate a new conversation
ConversationsApigetConversationGET /v2/conversations/{id}Get a conversation with its events
ConversationsApilistConversationsGET /v2/conversationsList conversations for the authenticated user
ConversationsApisendMessagePOST /v2/conversations/{id}/messagesSend a message and start an agentic run
ConversationsApistreamEventsGET /v2/conversations/{id}/eventsStream conversation events (SSE)
ExternalSourcesApicreateExternalTaskVtPOST /v2/analysis/{analysis_id}/external/vtPulls data from VirusTotal
ExternalSourcesApigetVtDataGET /v2/analysis/{analysis_id}/external/vtGet VirusTotal data
ExternalSourcesApigetVtTaskStatusGET /v2/analysis/{analysis_id}/external/vt/statusCheck the status of VirusTotal data retrieval
FirmwareApigetBinariesForFirmwareTaskGET /v2/firmware/get-binaries/{task_id}Upload firmware for unpacking
FirmwareApiuploadFirmwarePOST /v2/firmwareUpload firmware for unpacking
FunctionsAIDecompilationApicreateAiDecompilationPOST /v3/functions/{function_id}/ai-decompilationStart AI decompilation
FunctionsAIDecompilationApideleteAiDecompilationInlineCommentDELETE /v3/functions/{function_id}/ai-decompilation/inline-comments/{line}Delete a single inline comment
FunctionsAIDecompilationApigetAiDecompilationGET /v3/functions/{function_id}/ai-decompilationGet AI decompilation result
FunctionsAIDecompilationApigetAiDecompilationInlineCommentsGET /v3/functions/{function_id}/ai-decompilation/inline-commentsGet AI decompilation inline comments
FunctionsAIDecompilationApigetAiDecompilationInlineCommentsStatusGET /v3/functions/{function_id}/ai-decompilation/inline-comments/statusGet inline comments generation workflow status
FunctionsAIDecompilationApigetAiDecompilationRatingGET /v2/functions/{function_id}/ai-decompilation/ratingGet rating for AI decompilation
FunctionsAIDecompilationApigetAiDecompilationStatusGET /v3/functions/{function_id}/ai-decompilation/statusGet AI decompilation workflow status
FunctionsAIDecompilationApigetAiDecompilationSummaryGET /v3/functions/{function_id}/ai-decompilation/summaryGet AI decompilation summary
FunctionsAIDecompilationApigetAiDecompilationSummaryStatusGET /v3/functions/{function_id}/ai-decompilation/summary/statusGet summary generation workflow status
FunctionsAIDecompilationApigetAiDecompilationTokenisedGET /v3/functions/{function_id}/ai-decompilation/tokenisedGet tokenised AI decompilation with function mapping
FunctionsAIDecompilationApipatchAiDecompilationInlineCommentPATCH /v3/functions/{function_id}/ai-decompilation/inline-commentsUpdate a single inline comment
FunctionsAIDecompilationApiregenerateAiDecompilationInlineCommentsPOST /v3/functions/{function_id}/ai-decompilation/inline-commentsRegenerate AI decompilation inline comments
FunctionsAIDecompilationApiregenerateAiDecompilationSummaryPOST /v3/functions/{function_id}/ai-decompilation/summaryRegenerate AI decompilation summary
FunctionsAIDecompilationApistreamAiDecompilationGET /v3/functions/{function_id}/ai-decompilation/eventsStream live AI decompilation output (SSE)
FunctionsAIDecompilationApiupsertAiDecompilationOverridesPATCH /v3/functions/{function_id}/ai-decompilation/overridesUpsert variable/function name overrides
FunctionsAIDecompilationApiupsertAiDecompilationRatingPATCH /v2/functions/{function_id}/ai-decompilation/ratingUpsert rating for AI decompilation
FunctionsCoreApiaddFunctionCalleePOST /v3/functions/{function_id}/calleesAdd a callee to a function
FunctionsCoreApiaddUserStringToFunctionPOST /v3/functions/{function_id}/user-provided-stringsAdd a user-provided string to a function.
FunctionsCoreApigetAnalysisStringsGET /v2/analyses/{analysis_id}/functions/stringsGet string information found in the Analysis
FunctionsCoreApigetAnalysisStringsStatusGET /v2/analyses/{analysis_id}/functions/strings/statusGet string processing state for the Analysis
FunctionsCoreApigetFunctionBlocksGET /v2/functions/{function_id}/blocksGet disassembly blocks related to the function
FunctionsCoreApigetFunctionBlocks_0GET /v3/functions/{function_id}/blocksGet function disassembly
FunctionsCoreApigetFunctionCalleesCallersGET /v2/functions/{function_id}/callees_callersGet list of functions that call or are called by the specified function
FunctionsCoreApigetFunctionCalleesCallersBulkGET /v2/functions/callees_callersGet list of functions that call or are called for a list of functions
FunctionsCoreApigetFunctionCalleesCallers_0GET /v3/functions/{function_id}/callees-callersGet callees and callers for a function
FunctionsCoreApigetFunctionCapabilitiesGET /v2/functions/{function_id}/capabilitiesRetrieve a functions capabilities
FunctionsCoreApigetFunctionCapabilities_0GET /v3/functions/{function_id}/capabilitiesGet capabilities for a function
FunctionsCoreApigetFunctionDetailsGET /v2/functions/{function_id}Get function details
FunctionsCoreApigetFunctionDetails_0GET /v3/functions/{function_id}Get function details
FunctionsCoreApigetFunctionIndirectCallSitesGET /v3/functions/{function_id}/indirect-call-sitesGet indirect call sites for a function
FunctionsCoreApigetFunctionStringsGET /v2/functions/{function_id}/stringsGet string information found in the function
FunctionsCoreApigetFunctionStrings_0GET /v3/functions/{function_id}/stringsList strings for a function.
FunctionsCoreApigetFunctionsCalleesCallersGET /v3/functions/callees-callersGet callees and callers for many functions
FunctionsCoreApigetFunctionsMatchesGET /v3/functions/matchesGet function-matching results for an explicit set of functions
FunctionsCoreApigetFunctionsMatchingStatusGET /v3/functions/matches/statusGet function-matching status for an explicit set of functions
FunctionsCoreApigetImportedFunctionGET /v3/analyses/{analysis_id}/imported-functions/{imported_function_id}Get an imported function with its callers
FunctionsCoreApilistAnalysisFunctionsGET /v3/analyses/{analysis_id}/functionsList functions in an analysis
FunctionsCoreApilistImportedFunctionsGET /v3/analyses/{analysis_id}/imported-functionsList imported functions in an analysis
FunctionsCoreApistartFunctionsMatchingPOST /v3/functions/matchesStart function matching for an explicit set of functions
FunctionsCoreApiv3CanonicalizeFunctionNamesPOST /v3/functions/canonical-namesCanonicalize a batch of function names
FunctionsDataTypesApibatchUpdateFunctionDataTypesPUT /v3/analyses/{analysis_id}/functions/data-typesBatch update function data types
FunctionsDataTypesApigenerateFunctionDataTypesForAnalysisPOST /v2/analyses/{analysis_id}/functions/data_typesGenerate Function Data Types
FunctionsDataTypesApigenerateFunctionDataTypesForFunctionsPOST /v2/functions/data_typesGenerate Function Data Types for an arbitrary list of functions
FunctionsDataTypesApigetFunctionDataTypesGET /v3/analyses/{analysis_id}/functions/{function_id}/data-typesGet data types for a single function
FunctionsDataTypesApilistAnalysisFunctionsDataTypesGET /v3/analyses/{analysis_id}/functions/data-typesList data types for all functions in an analysis
FunctionsDataTypesApilistFunctionDataTypesForAnalysisGET /v2/analyses/{analysis_id}/functions/data_typesList Function Data Types
FunctionsDataTypesApilistFunctionDataTypesForFunctionsGET /v2/functions/data_typesList Function Data Types
FunctionsDataTypesApilistFunctionsDataTypesGET /v3/functions/data-typesGet data types for many functions
FunctionsDataTypesApiupdateFunctionDataTypesPUT /v2/analyses/{analysis_id}/functions/{function_id}/data_typesUpdate function data types
FunctionsRenamingHistoryApibatchRenameFunctionPOST /v2/functions/rename/batchBatch Rename Functions
FunctionsRenamingHistoryApibatchRenameFunctionsPOST /v3/functions/renameBatch rename functions
FunctionsRenamingHistoryApigetFunctionHistoryGET /v3/functions/{function_id}/historyGet function name history
FunctionsRenamingHistoryApigetFunctionNameHistoryGET /v2/functions/history/{function_id}Get Function Name History
FunctionsRenamingHistoryApirenameFunctionPOST /v3/functions/{function_id}/renameRename a function
FunctionsRenamingHistoryApirenameFunctionIdPOST /v2/functions/rename/{function_id}Rename Function
FunctionsRenamingHistoryApirevertFunctionNamePOST /v2/functions/history/{function_id}/{history_id}Revert the function name
FunctionsRenamingHistoryApirevertFunctionName_0POST /v3/functions/{function_id}/history/{history_id}/revertRevert function name
IAMUsersApigetMeGET /v2/iam/meGet current user
IAMUsersApigetMyPermissionsGET /v2/iam/me/permissionsGet current user permissions
ModelsApigetModelsGET /v2/modelsGets models
ReportsApicreatePdfReportPOST /v3/analyses/{analysis_id}/pdfStart PDF report generation
ReportsApidownloadPdfReportGET /v3/analyses/{analysis_id}/pdfDownload generated PDF report
ReportsApigetPdfReportStatusGET /v3/analyses/{analysis_id}/pdf/statusGet PDF report workflow status
SearchApisearchBinariesGET /v2/search/binariesBinaries search
SearchApisearchCollectionsGET /v2/search/collectionsCollections search
SearchApisearchFunctionsGET /v2/search/functionsFunctions search
SearchApisearchTagsGET /v2/search/tagsTags search

Documentation for Models

About

RevEng.AI TypeScript SDK

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages