revengai.CollectionsApi

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

Method	HTTP request	Description
create_collection	POST /v2/collections	Creates new collection information
delete_collection	DELETE /v2/collections/{collection_id}	Deletes a collection
get_collection	GET /v2/collections/{collection_id}	Returns a collection
list_collections	GET /v2/collections	Gets basic collections information
update_collection	PATCH /v2/collections/{collection_id}	Updates a collection
update_collection_binaries	PATCH /v2/collections/{collection_id}/binaries	Updates a collection binaries
update_collection_tags	PATCH /v2/collections/{collection_id}/tags	Updates a collection tags
v3_create_collection	POST /v3/collections	Create a collection.
v3_delete_collection	DELETE /v3/collections/{collection_id}	Delete a collection.
v3_get_collection	GET /v3/collections/{collection_id}	Get a collection.
v3_list_collections	GET /v3/collections	List collections.
v3_patch_collection	PATCH /v3/collections/{collection_id}	Update a collection.
v3_patch_collection_binaries	PATCH /v3/collections/{collection_id}/binaries	Replace the binaries in a collection.
v3_patch_collection_tags	PATCH /v3/collections/{collection_id}/tags	Replace the tags on a collection.

create_collection

BaseResponseCollectionResponse create_collection(collection_create_request)

Creates new collection information

A collection is a group of binaries that are related in some way. This endpoint creates a new collection and allows you to add tags and binaries to it. If you add tags or binaries to the collection, they will be returned in the response.

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.base_response_collection_response import BaseResponseCollectionResponse
from revengai.models.collection_create_request import CollectionCreateRequest
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.CollectionsApi(api_client)
    collection_create_request = revengai.CollectionCreateRequest() # CollectionCreateRequest | 

    try:
        # Creates new collection information
        api_response = api_instance.create_collection(collection_create_request)
        print("The response of CollectionsApi->create_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->create_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_create_request	CollectionCreateRequest

Return type

BaseResponseCollectionResponse

Authorization

APIKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_collection

BaseResponseBool delete_collection(collection_id)

Deletes a collection

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.base_response_bool import BaseResponseBool
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.CollectionsApi(api_client)
    collection_id = 56 # int | 

    try:
        # Deletes a collection
        api_response = api_instance.delete_collection(collection_id)
        print("The response of CollectionsApi->delete_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->delete_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int

Return type

BaseResponseBool

Authorization

APIKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_collection

BaseResponseCollectionResponse get_collection(collection_id, include_tags=include_tags, include_binaries=include_binaries, page_size=page_size, page_number=page_number, binary_search_str=binary_search_str)

Returns a collection

Gets a single collection. The collection can include binaries and tags if requested. You can specify whether to include tags and binaries in the response by using the query string parameters defined.

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.base_response_collection_response import BaseResponseCollectionResponse
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    include_tags = False # bool |  (optional) (default to False)
    include_binaries = False # bool |  (optional) (default to False)
    page_size = 10 # int |  (optional) (default to 10)
    page_number = 1 # int |  (optional) (default to 1)
    binary_search_str = 'binary_search_str_example' # str |  (optional)

    try:
        # Returns a collection
        api_response = api_instance.get_collection(collection_id, include_tags=include_tags, include_binaries=include_binaries, page_size=page_size, page_number=page_number, binary_search_str=binary_search_str)
        print("The response of CollectionsApi->get_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->get_collection: %s\n" % e)

Parameters

Name	Type	Notes
collection_id	int
include_tags	bool	[optional] [default to False]
include_binaries	bool	[optional] [default to False]
page_size	int	[optional] [default to 10]
page_number	int	[optional] [default to 1]
binary_search_str	str	[optional]

Return type

BaseResponseCollectionResponse

Authorization

APIKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_collections

BaseResponseListCollectionResults list_collections(search_term=search_term, filters=filters, limit=limit, offset=offset, order_by=order_by, order=order)

Gets basic collections information

Returns a list of collections

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.app_api_rest_v2_collections_enums_order_by import AppApiRestV2CollectionsEnumsOrderBy
from revengai.models.base_response_list_collection_results import BaseResponseListCollectionResults
from revengai.models.filters import Filters
from revengai.models.order import Order
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.CollectionsApi(api_client)
    search_term = '' # str |  (optional) (default to '')
    filters = [] # List[Filters] |  (optional) (default to [])
    limit = 20 # int |  (optional) (default to 20)
    offset = 0 # int |  (optional) (default to 0)
    order_by = revengai.AppApiRestV2CollectionsEnumsOrderBy() # AppApiRestV2CollectionsEnumsOrderBy |  (optional)
    order = revengai.Order() # Order |  (optional)

    try:
        # Gets basic collections information
        api_response = api_instance.list_collections(search_term=search_term, filters=filters, limit=limit, offset=offset, order_by=order_by, order=order)
        print("The response of CollectionsApi->list_collections:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->list_collections: %s\n" % e)

Parameters

Name	Type	Notes
search_term	str	[optional] [default to '']
filters	List[Filters]	[optional] [default to []]
limit	int	[optional] [default to 20]
offset	int	[optional] [default to 0]
order_by	AppApiRestV2CollectionsEnumsOrderBy	[optional]
order	Order	[optional]

Return type

BaseResponseListCollectionResults

Authorization

APIKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_collection

BaseResponseCollectionResponse update_collection(collection_id, collection_update_request)

Updates a collection

Updates a collection, you can update the collection name, description, and scope

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.base_response_collection_response import BaseResponseCollectionResponse
from revengai.models.collection_update_request import CollectionUpdateRequest
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    collection_update_request = revengai.CollectionUpdateRequest() # CollectionUpdateRequest | 

    try:
        # Updates a collection
        api_response = api_instance.update_collection(collection_id, collection_update_request)
        print("The response of CollectionsApi->update_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->update_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int
collection_update_request	CollectionUpdateRequest

Return type

BaseResponseCollectionResponse

Authorization

APIKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_collection_binaries

BaseResponseCollectionBinariesUpdateResponse update_collection_binaries(collection_id, collection_binaries_update_request)

Updates a collection binaries

Updates/changes a collection binaries to whatever is provided in the request. After this update the collection will only contain the binaries provided in the request.

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.base_response_collection_binaries_update_response import BaseResponseCollectionBinariesUpdateResponse
from revengai.models.collection_binaries_update_request import CollectionBinariesUpdateRequest
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    collection_binaries_update_request = revengai.CollectionBinariesUpdateRequest() # CollectionBinariesUpdateRequest | 

    try:
        # Updates a collection binaries
        api_response = api_instance.update_collection_binaries(collection_id, collection_binaries_update_request)
        print("The response of CollectionsApi->update_collection_binaries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->update_collection_binaries: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int
collection_binaries_update_request	CollectionBinariesUpdateRequest

Return type

BaseResponseCollectionBinariesUpdateResponse

Authorization

APIKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_collection_tags

BaseResponseCollectionTagsUpdateResponse update_collection_tags(collection_id, collection_tags_update_request)

Updates a collection tags

Updates/changes a collection tags to whatever is provided in the request. After this update the collection will only contain the tags provided in the request.

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.base_response_collection_tags_update_response import BaseResponseCollectionTagsUpdateResponse
from revengai.models.collection_tags_update_request import CollectionTagsUpdateRequest
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    collection_tags_update_request = revengai.CollectionTagsUpdateRequest() # CollectionTagsUpdateRequest | 

    try:
        # Updates a collection tags
        api_response = api_instance.update_collection_tags(collection_id, collection_tags_update_request)
        print("The response of CollectionsApi->update_collection_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->update_collection_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int
collection_tags_update_request	CollectionTagsUpdateRequest

Return type

BaseResponseCollectionTagsUpdateResponse

Authorization

APIKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_create_collection

CreateCollectionOutputBody v3_create_collection(create_collection_input_body)

Create a collection.

Creates a new collection, optionally tagging it and linking binary IDs to it. Tags and binaries are returned in the response only when they were supplied in the request.

Error codes:

404 NOT_FOUND — Not Found
422 VALIDATION_FAILED — Validation Failed

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.create_collection_input_body import CreateCollectionInputBody
from revengai.models.create_collection_output_body import CreateCollectionOutputBody
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.CollectionsApi(api_client)
    create_collection_input_body = revengai.CreateCollectionInputBody() # CreateCollectionInputBody | 

    try:
        # Create a collection.
        api_response = api_instance.v3_create_collection(create_collection_input_body)
        print("The response of CollectionsApi->v3_create_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_create_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_collection_input_body	CreateCollectionInputBody

Return type

CreateCollectionOutputBody

Authorization

APIKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_delete_collection

v3_delete_collection(collection_id)

Delete a collection.

Deletes a collection. The collection must not have any linked binaries (call PATCH /v3/collections/{collection_id}/binaries with an empty list first).

Error codes:

404 NOT_FOUND — Not Found
403 ACCESS_DENIED — Access Denied
409 CONFLICT — Conflict

Example

Api Key Authentication (APIKey):

import revengai
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.CollectionsApi(api_client)
    collection_id = 56 # int | 

    try:
        # Delete a collection.
        api_instance.v3_delete_collection(collection_id)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_delete_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int

Return type

void (empty response body)

Authorization

APIKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_get_collection

GetCollectionOutputBody v3_get_collection(collection_id, include_tags=include_tags, include_binaries=include_binaries, page_size=page_size, page_number=page_number, binary_search_str=binary_search_str)

Get a collection.

Gets a single collection by ID. Optionally include tags and paginated binaries.

Error codes:

404 NOT_FOUND — Not Found

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.get_collection_output_body import GetCollectionOutputBody
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    include_tags = True # bool |  (optional)
    include_binaries = True # bool |  (optional)
    page_size = 10 # int |  (optional) (default to 10)
    page_number = 1 # int |  (optional) (default to 1)
    binary_search_str = 'binary_search_str_example' # str |  (optional)

    try:
        # Get a collection.
        api_response = api_instance.v3_get_collection(collection_id, include_tags=include_tags, include_binaries=include_binaries, page_size=page_size, page_number=page_number, binary_search_str=binary_search_str)
        print("The response of CollectionsApi->v3_get_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_get_collection: %s\n" % e)

Parameters

Name	Type	Notes
collection_id	int
include_tags	bool	[optional]
include_binaries	bool	[optional]
page_size	int	[optional] [default to 10]
page_number	int	[optional] [default to 1]
binary_search_str	str	[optional]

Return type

GetCollectionOutputBody

Authorization

APIKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_list_collections

ListCollectionsOutputBody v3_list_collections(search_term=search_term, filters=filters, limit=limit, offset=offset, order_by=order_by, order=order)

List collections.

Lists collections accessible to the authenticated user. Supports search, filtering, ordering, and pagination.

Error codes:

422 VALIDATION_FAILED — Validation Failed

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.list_collections_output_body import ListCollectionsOutputBody
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.CollectionsApi(api_client)
    search_term = 'search_term_example' # str |  (optional)
    filters = ['filters_example'] # List[str] |  (optional)
    limit = 20 # int |  (optional) (default to 20)
    offset = 0 # int |  (optional) (default to 0)
    order_by = collection # str |  (optional) (default to collection)
    order = ASC # str |  (optional) (default to ASC)

    try:
        # List collections.
        api_response = api_instance.v3_list_collections(search_term=search_term, filters=filters, limit=limit, offset=offset, order_by=order_by, order=order)
        print("The response of CollectionsApi->v3_list_collections:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_list_collections: %s\n" % e)

Parameters

Name	Type	Notes
search_term	str	[optional]
filters	List[str]	[optional]
limit	int	[optional] [default to 20]
offset	int	[optional] [default to 0]
order_by	str	[optional] [default to collection]
order	str	[optional] [default to ASC]

Return type

ListCollectionsOutputBody

Authorization

APIKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
422	Unprocessable Entity	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_patch_collection

PatchCollectionOutputBody v3_patch_collection(collection_id, patch_collection_input_body)

Update a collection.

Updates a collection's name, description, and/or scope. Omitted fields keep their existing values.

Error codes:

404 NOT_FOUND — Not Found
403 ACCESS_DENIED — Access Denied
422 VALIDATION_FAILED — Validation Failed

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.patch_collection_input_body import PatchCollectionInputBody
from revengai.models.patch_collection_output_body import PatchCollectionOutputBody
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    patch_collection_input_body = revengai.PatchCollectionInputBody() # PatchCollectionInputBody | 

    try:
        # Update a collection.
        api_response = api_instance.v3_patch_collection(collection_id, patch_collection_input_body)
        print("The response of CollectionsApi->v3_patch_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_patch_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int
patch_collection_input_body	PatchCollectionInputBody

Return type

PatchCollectionOutputBody

Authorization

APIKey

HTTP request headers

Content-Type: application/json
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] [Back to Model list] [Back to README]

v3_patch_collection_binaries

PatchCollectionBinariesOutputBody v3_patch_collection_binaries(collection_id, patch_collection_binaries_input_body)

Replace the binaries in a collection.

Replaces the binaries linked to a collection with the supplied list. Binaries not present in the request are removed. All supplied binary IDs must belong to the same model as the collection.

Error codes:

404 NOT_FOUND — Not Found
403 ACCESS_DENIED — Access Denied
422 VALIDATION_FAILED — Validation Failed

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.patch_collection_binaries_input_body import PatchCollectionBinariesInputBody
from revengai.models.patch_collection_binaries_output_body import PatchCollectionBinariesOutputBody
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    patch_collection_binaries_input_body = revengai.PatchCollectionBinariesInputBody() # PatchCollectionBinariesInputBody | 

    try:
        # Replace the binaries in a collection.
        api_response = api_instance.v3_patch_collection_binaries(collection_id, patch_collection_binaries_input_body)
        print("The response of CollectionsApi->v3_patch_collection_binaries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_patch_collection_binaries: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int
patch_collection_binaries_input_body	PatchCollectionBinariesInputBody

Return type

PatchCollectionBinariesOutputBody

Authorization

APIKey

HTTP request headers

Content-Type: application/json
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] [Back to Model list] [Back to README]

v3_patch_collection_tags

PatchCollectionTagsOutputBody v3_patch_collection_tags(collection_id, patch_collection_tags_input_body)

Replace the tags on a collection.

Replaces the tags on a collection with the supplied list. Tags not present in the request are removed. Empty or whitespace-only tags are filtered; duplicates are deduplicated.

Error codes:

404 NOT_FOUND — Not Found
403 ACCESS_DENIED — Access Denied

Example

Api Key Authentication (APIKey):

import revengai
from revengai.models.patch_collection_tags_input_body import PatchCollectionTagsInputBody
from revengai.models.patch_collection_tags_output_body import PatchCollectionTagsOutputBody
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.CollectionsApi(api_client)
    collection_id = 56 # int | 
    patch_collection_tags_input_body = revengai.PatchCollectionTagsInputBody() # PatchCollectionTagsInputBody | 

    try:
        # Replace the tags on a collection.
        api_response = api_instance.v3_patch_collection_tags(collection_id, patch_collection_tags_input_body)
        print("The response of CollectionsApi->v3_patch_collection_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CollectionsApi->v3_patch_collection_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	int
patch_collection_tags_input_body	PatchCollectionTagsInputBody

Return type

PatchCollectionTagsOutputBody

Authorization

APIKey

HTTP request headers

Content-Type: application/json
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] [Back to Model list] [Back to README]

FilesExpand file tree

CollectionsApi.md

Latest commit

History

CollectionsApi.md

File metadata and controls

revengai.CollectionsApi

create_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_collections

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_collection_binaries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_collection_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_create_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_delete_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_get_collection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_collections

Example

Parameters