Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ Class | Method | HTTP request | Description
*BinariesApi* | [**get_binary_externals**](docs/BinariesApi.md#get_binary_externals) | **GET** /v2/binaries/{binary_id}/externals | Gets the external details of a binary
*BinariesApi* | [**get_binary_related_status**](docs/BinariesApi.md#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**](docs/BinariesApi.md#get_related_binaries) | **GET** /v2/binaries/{binary_id}/related | Gets the related binaries of a binary.
*BinariesCoreApi* | [**get_binary_additional_details**](docs/BinariesCoreApi.md#get_binary_additional_details) | **GET** /v3/binaries/{binary_id}/additional-details | Get additional details for a binary.
*BinariesCoreApi* | [**get_binary_additional_details_status**](docs/BinariesCoreApi.md#get_binary_additional_details_status) | **GET** /v3/binaries/{binary_id}/additional-details/status | Get the additional-details extraction status for a binary.
*CollectionsApi* | [**create_collection**](docs/CollectionsApi.md#create_collection) | **POST** /v2/collections | Creates new collection information
*CollectionsApi* | [**delete_collection**](docs/CollectionsApi.md#delete_collection) | **DELETE** /v2/collections/{collection_id} | Deletes a collection
*CollectionsApi* | [**get_collection**](docs/CollectionsApi.md#get_collection) | **GET** /v2/collections/{collection_id} | Returns a collection
Expand Down Expand Up @@ -442,6 +444,8 @@ Class | Method | HTTP request | Description
- [GenerateFunctionDataTypes](docs/GenerateFunctionDataTypes.md)
- [GeneratePDFOutputBody](docs/GeneratePDFOutputBody.md)
- [GenerationStatusList](docs/GenerationStatusList.md)
- [GetAdditionalDetailsOutputBody](docs/GetAdditionalDetailsOutputBody.md)
- [GetAdditionalDetailsStatusOutputBody](docs/GetAdditionalDetailsStatusOutputBody.md)
- [GetAiDecompilationRatingResponse](docs/GetAiDecompilationRatingResponse.md)
- [GetAiDecompilationTask](docs/GetAiDecompilationTask.md)
- [GetAnalysisStringsStatusOutputBody](docs/GetAnalysisStringsStatusOutputBody.md)
Expand Down
184 changes: 184 additions & 0 deletions docs/BinariesCoreApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
# revengai.BinariesCoreApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_binary_additional_details**](BinariesCoreApi.md#get_binary_additional_details) | **GET** /v3/binaries/{binary_id}/additional-details | Get additional details for a binary.
[**get_binary_additional_details_status**](BinariesCoreApi.md#get_binary_additional_details_status) | **GET** /v3/binaries/{binary_id}/additional-details/status | Get the additional-details extraction status for a binary.


# **get_binary_additional_details**
> GetAdditionalDetailsOutputBody get_binary_additional_details(binary_id)

Get additional details for a binary.

Returns structured metadata extracted by the additional-details pipeline for the given binary. Returns `null` for `details` when the pipeline has not yet run.

**Error codes:**
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) β€” Not Found
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) β€” Access Denied

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.get_additional_details_output_body import GetAdditionalDetailsOutputBody
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
host = "https://api.reveng.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# 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.BinariesCoreApi(api_client)
binary_id = 56 # int | Binary ID

try:
# Get additional details for a binary.
api_response = api_instance.get_binary_additional_details(binary_id)
print("The response of BinariesCoreApi->get_binary_additional_details:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling BinariesCoreApi->get_binary_additional_details: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**binary_id** | **int**| Binary ID |

### Return type

[**GetAdditionalDetailsOutputBody**](GetAdditionalDetailsOutputBody.md)

### Authorization

[APIKey](../README.md#APIKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**422** | Unprocessable Entity | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_binary_additional_details_status**
> GetAdditionalDetailsStatusOutputBody get_binary_additional_details_status(binary_id)

Get the additional-details extraction status for a binary.

Returns the status of the additional-details extraction task. One of `UNINITIALISED`, `PENDING`, `RUNNING`, `COMPLETED`, `FAILED`.

**Error codes:**
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) β€” Not Found
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) β€” Access Denied

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.get_additional_details_status_output_body import GetAdditionalDetailsStatusOutputBody
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
host = "https://api.reveng.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# 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.BinariesCoreApi(api_client)
binary_id = 56 # int | Binary ID

try:
# Get the additional-details extraction status for a binary.
api_response = api_instance.get_binary_additional_details_status(binary_id)
print("The response of BinariesCoreApi->get_binary_additional_details_status:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling BinariesCoreApi->get_binary_additional_details_status: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**binary_id** | **int**| Binary ID |

### Return type

[**GetAdditionalDetailsStatusOutputBody**](GetAdditionalDetailsStatusOutputBody.md)

### Authorization

[APIKey](../README.md#APIKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**422** | Unprocessable Entity | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

30 changes: 30 additions & 0 deletions docs/GetAdditionalDetailsOutputBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# GetAdditionalDetailsOutputBody


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**binary_id** | **int** | |
**details** | **object** | |

## Example

```python
from revengai.models.get_additional_details_output_body import GetAdditionalDetailsOutputBody

# TODO update the JSON string below
json = "{}"
# create an instance of GetAdditionalDetailsOutputBody from a JSON string
get_additional_details_output_body_instance = GetAdditionalDetailsOutputBody.from_json(json)
# print the JSON string representation of the object
print(GetAdditionalDetailsOutputBody.to_json())

# convert the object into a dict
get_additional_details_output_body_dict = get_additional_details_output_body_instance.to_dict()
# create an instance of GetAdditionalDetailsOutputBody from a dict
get_additional_details_output_body_from_dict = GetAdditionalDetailsOutputBody.from_dict(get_additional_details_output_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


29 changes: 29 additions & 0 deletions docs/GetAdditionalDetailsStatusOutputBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# GetAdditionalDetailsStatusOutputBody


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | |

## Example

```python
from revengai.models.get_additional_details_status_output_body import GetAdditionalDetailsStatusOutputBody

# TODO update the JSON string below
json = "{}"
# create an instance of GetAdditionalDetailsStatusOutputBody from a JSON string
get_additional_details_status_output_body_instance = GetAdditionalDetailsStatusOutputBody.from_json(json)
# print the JSON string representation of the object
print(GetAdditionalDetailsStatusOutputBody.to_json())

# convert the object into a dict
get_additional_details_status_output_body_dict = get_additional_details_status_output_body_instance.to_dict()
# create an instance of GetAdditionalDetailsStatusOutputBody from a dict
get_additional_details_status_output_body_from_dict = GetAdditionalDetailsStatusOutputBody.from_dict(get_additional_details_status_output_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


6 changes: 6 additions & 0 deletions revengai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"AnalysesXRefsApi",
"AuthenticationUsersApi",
"BinariesApi",
"BinariesCoreApi",
"CollectionsApi",
"ConfigApi",
"ConversationsApi",
Expand Down Expand Up @@ -308,6 +309,8 @@
"GenerateFunctionDataTypes",
"GeneratePDFOutputBody",
"GenerationStatusList",
"GetAdditionalDetailsOutputBody",
"GetAdditionalDetailsStatusOutputBody",
"GetAiDecompilationRatingResponse",
"GetAiDecompilationTask",
"GetAnalysisStringsStatusOutputBody",
Expand Down Expand Up @@ -460,6 +463,7 @@
from revengai.api.analyses_x_refs_api import AnalysesXRefsApi as AnalysesXRefsApi
from revengai.api.authentication_users_api import AuthenticationUsersApi as AuthenticationUsersApi
from revengai.api.binaries_api import BinariesApi as BinariesApi
from revengai.api.binaries_core_api import BinariesCoreApi as BinariesCoreApi
from revengai.api.collections_api import CollectionsApi as CollectionsApi
from revengai.api.config_api import ConfigApi as ConfigApi
from revengai.api.conversations_api import ConversationsApi as ConversationsApi
Expand Down Expand Up @@ -747,6 +751,8 @@
from revengai.models.generate_function_data_types import GenerateFunctionDataTypes as GenerateFunctionDataTypes
from revengai.models.generate_pdf_output_body import GeneratePDFOutputBody as GeneratePDFOutputBody
from revengai.models.generation_status_list import GenerationStatusList as GenerationStatusList
from revengai.models.get_additional_details_output_body import GetAdditionalDetailsOutputBody as GetAdditionalDetailsOutputBody
from revengai.models.get_additional_details_status_output_body import GetAdditionalDetailsStatusOutputBody as GetAdditionalDetailsStatusOutputBody
from revengai.models.get_ai_decompilation_rating_response import GetAiDecompilationRatingResponse as GetAiDecompilationRatingResponse
from revengai.models.get_ai_decompilation_task import GetAiDecompilationTask as GetAiDecompilationTask
from revengai.models.get_analysis_strings_status_output_body import GetAnalysisStringsStatusOutputBody as GetAnalysisStringsStatusOutputBody
Expand Down
1 change: 1 addition & 0 deletions revengai/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from revengai.api.analyses_x_refs_api import AnalysesXRefsApi
from revengai.api.authentication_users_api import AuthenticationUsersApi
from revengai.api.binaries_api import BinariesApi
from revengai.api.binaries_core_api import BinariesCoreApi
from revengai.api.collections_api import CollectionsApi
from revengai.api.config_api import ConfigApi
from revengai.api.conversations_api import ConversationsApi
Expand Down
Loading