|
| 1 | +# revengai.BinariesCoreApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.reveng.ai* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_binary_additional_details**](BinariesCoreApi.md#get_binary_additional_details) | **GET** /v3/binaries/{binary_id}/additional-details | Get additional details for a binary. |
| 8 | +[**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. |
| 9 | + |
| 10 | + |
| 11 | +# **get_binary_additional_details** |
| 12 | +> GetAdditionalDetailsOutputBody get_binary_additional_details(binary_id) |
| 13 | +
|
| 14 | +Get additional details for a binary. |
| 15 | + |
| 16 | +Returns structured metadata extracted by the additional-details pipeline for the given binary. Returns `null` for `details` when the pipeline has not yet run. |
| 17 | + |
| 18 | +**Error codes:** |
| 19 | +- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found |
| 20 | +- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied |
| 21 | + |
| 22 | +### Example |
| 23 | + |
| 24 | +* Api Key Authentication (APIKey): |
| 25 | + |
| 26 | +```python |
| 27 | +import revengai |
| 28 | +from revengai.models.get_additional_details_output_body import GetAdditionalDetailsOutputBody |
| 29 | +from revengai.rest import ApiException |
| 30 | +from pprint import pprint |
| 31 | + |
| 32 | +# Defining the host is optional and defaults to https://api.reveng.ai |
| 33 | +# See configuration.py for a list of all supported configuration parameters. |
| 34 | +configuration = revengai.Configuration( |
| 35 | + host = "https://api.reveng.ai" |
| 36 | +) |
| 37 | + |
| 38 | +# The client must configure the authentication and authorization parameters |
| 39 | +# in accordance with the API server security policy. |
| 40 | +# Examples for each auth method are provided below, use the example that |
| 41 | +# satisfies your auth use case. |
| 42 | + |
| 43 | +# Configure API key authorization: APIKey |
| 44 | +configuration.api_key['APIKey'] = os.environ["API_KEY"] |
| 45 | + |
| 46 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 47 | +# configuration.api_key_prefix['APIKey'] = 'Bearer' |
| 48 | + |
| 49 | +# Enter a context with an instance of the API client |
| 50 | +with revengai.ApiClient(configuration) as api_client: |
| 51 | + # Create an instance of the API class |
| 52 | + api_instance = revengai.BinariesCoreApi(api_client) |
| 53 | + binary_id = 56 # int | Binary ID |
| 54 | + |
| 55 | + try: |
| 56 | + # Get additional details for a binary. |
| 57 | + api_response = api_instance.get_binary_additional_details(binary_id) |
| 58 | + print("The response of BinariesCoreApi->get_binary_additional_details:\n") |
| 59 | + pprint(api_response) |
| 60 | + except Exception as e: |
| 61 | + print("Exception when calling BinariesCoreApi->get_binary_additional_details: %s\n" % e) |
| 62 | +``` |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +### Parameters |
| 67 | + |
| 68 | + |
| 69 | +Name | Type | Description | Notes |
| 70 | +------------- | ------------- | ------------- | ------------- |
| 71 | + **binary_id** | **int**| Binary ID | |
| 72 | + |
| 73 | +### Return type |
| 74 | + |
| 75 | +[**GetAdditionalDetailsOutputBody**](GetAdditionalDetailsOutputBody.md) |
| 76 | + |
| 77 | +### Authorization |
| 78 | + |
| 79 | +[APIKey](../README.md#APIKey) |
| 80 | + |
| 81 | +### HTTP request headers |
| 82 | + |
| 83 | + - **Content-Type**: Not defined |
| 84 | + - **Accept**: application/json |
| 85 | + |
| 86 | +### HTTP response details |
| 87 | + |
| 88 | +| Status code | Description | Response headers | |
| 89 | +|-------------|-------------|------------------| |
| 90 | +**200** | OK | - | |
| 91 | +**403** | Forbidden | - | |
| 92 | +**404** | Not Found | - | |
| 93 | +**422** | Unprocessable Entity | - | |
| 94 | +**500** | Internal Server Error | - | |
| 95 | + |
| 96 | +[[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) |
| 97 | + |
| 98 | +# **get_binary_additional_details_status** |
| 99 | +> GetAdditionalDetailsStatusOutputBody get_binary_additional_details_status(binary_id) |
| 100 | +
|
| 101 | +Get the additional-details extraction status for a binary. |
| 102 | + |
| 103 | +Returns the status of the additional-details extraction task. One of `UNINITIALISED`, `PENDING`, `RUNNING`, `COMPLETED`, `FAILED`. |
| 104 | + |
| 105 | +**Error codes:** |
| 106 | +- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found |
| 107 | +- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied |
| 108 | + |
| 109 | +### Example |
| 110 | + |
| 111 | +* Api Key Authentication (APIKey): |
| 112 | + |
| 113 | +```python |
| 114 | +import revengai |
| 115 | +from revengai.models.get_additional_details_status_output_body import GetAdditionalDetailsStatusOutputBody |
| 116 | +from revengai.rest import ApiException |
| 117 | +from pprint import pprint |
| 118 | + |
| 119 | +# Defining the host is optional and defaults to https://api.reveng.ai |
| 120 | +# See configuration.py for a list of all supported configuration parameters. |
| 121 | +configuration = revengai.Configuration( |
| 122 | + host = "https://api.reveng.ai" |
| 123 | +) |
| 124 | + |
| 125 | +# The client must configure the authentication and authorization parameters |
| 126 | +# in accordance with the API server security policy. |
| 127 | +# Examples for each auth method are provided below, use the example that |
| 128 | +# satisfies your auth use case. |
| 129 | + |
| 130 | +# Configure API key authorization: APIKey |
| 131 | +configuration.api_key['APIKey'] = os.environ["API_KEY"] |
| 132 | + |
| 133 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 134 | +# configuration.api_key_prefix['APIKey'] = 'Bearer' |
| 135 | + |
| 136 | +# Enter a context with an instance of the API client |
| 137 | +with revengai.ApiClient(configuration) as api_client: |
| 138 | + # Create an instance of the API class |
| 139 | + api_instance = revengai.BinariesCoreApi(api_client) |
| 140 | + binary_id = 56 # int | Binary ID |
| 141 | + |
| 142 | + try: |
| 143 | + # Get the additional-details extraction status for a binary. |
| 144 | + api_response = api_instance.get_binary_additional_details_status(binary_id) |
| 145 | + print("The response of BinariesCoreApi->get_binary_additional_details_status:\n") |
| 146 | + pprint(api_response) |
| 147 | + except Exception as e: |
| 148 | + print("Exception when calling BinariesCoreApi->get_binary_additional_details_status: %s\n" % e) |
| 149 | +``` |
| 150 | + |
| 151 | + |
| 152 | + |
| 153 | +### Parameters |
| 154 | + |
| 155 | + |
| 156 | +Name | Type | Description | Notes |
| 157 | +------------- | ------------- | ------------- | ------------- |
| 158 | + **binary_id** | **int**| Binary ID | |
| 159 | + |
| 160 | +### Return type |
| 161 | + |
| 162 | +[**GetAdditionalDetailsStatusOutputBody**](GetAdditionalDetailsStatusOutputBody.md) |
| 163 | + |
| 164 | +### Authorization |
| 165 | + |
| 166 | +[APIKey](../README.md#APIKey) |
| 167 | + |
| 168 | +### HTTP request headers |
| 169 | + |
| 170 | + - **Content-Type**: Not defined |
| 171 | + - **Accept**: application/json |
| 172 | + |
| 173 | +### HTTP response details |
| 174 | + |
| 175 | +| Status code | Description | Response headers | |
| 176 | +|-------------|-------------|------------------| |
| 177 | +**200** | OK | - | |
| 178 | +**403** | Forbidden | - | |
| 179 | +**404** | Not Found | - | |
| 180 | +**422** | Unprocessable Entity | - | |
| 181 | +**500** | Internal Server Error | - | |
| 182 | + |
| 183 | +[[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) |
| 184 | + |
0 commit comments