blindvault-sdk-api

BlindVault REST API for account, library, conversation, signing, and agent workflows. Protected operations document their accepted authentication schemes. Request and response models are generated from controller DTOs; errors use Problem Details.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.1.0rc1
• Generator version: 7.26.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Packaging uses standard [project] metadata and [dependency-groups] (PEP 621/735). Install the package with python -m pip install .; install development dependencies with Poetry 2.2 or newer using poetry install, or pip 25.1 or newer using python -m pip install --group dev. The latter installs the group, not the package.

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://gitlab.com/blindvault/blindvault-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://gitlab.com/blindvault/blindvault-sdk.git)

Then import the package:

import blindvault_sdk_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import blindvault_sdk_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import blindvault_sdk_api
from blindvault_sdk_api.rest import ApiException
from pprint import pprint

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

# 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: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = blindvault_sdk_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with blindvault_sdk_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = blindvault_sdk_api.AgentApi(api_client)
    device_id = 'device_id_example' # str | 
    create_agent_command_request = blindvault_sdk_api.CreateAgentCommandRequest() # CreateAgentCommandRequest | 

    try:
        # Create Command
        api_response = api_instance.create_command(device_id, create_agent_command_request)
        print("The response of AgentApi->create_command:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentApi->create_command: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.eu.blindvault.com

Documentation For Models

• APIKeyPublicView
• AddOnSubscriptionItemView
• AgentCommandResponse
• AgentDeviceSummaryResponse
• AgentLibraryFileMatchResponse
• AgentLibraryFileSearchResponse
• ApiProblem
• ApiProblemErrorsInner
• AppConfigResponse
• AuditLogEntryResponse
• BillingUsageMetricResponse
• BillingUsageSectionResponse
• BillingUsageSummaryResponse
• ChangeMembershipRoleRequest
• CheckProps
• CollectionQuotaResponse
• ConfirmAgentPairingRequest
• ConversationQuotaResponse
• ConversationThreadPreferencesResponse
• CreateAPIKeyRequest
• CreateAPIKeyResponse
• CreateAgentCommandRequest
• CreateEncryptedMessageRequest
• CreateLibraryCollectionRequest
• CreateLibraryShareRequest
• CreateMessageThreadRequest
• CreateSignatureRequest
• CreateSigningProcessRequest
• CreateSigningProcessResponse
• CreateSigningProcessTemplateRequest
• CreateWebhookRequest
• CreditUsageEntryResponse
• CreditUsagePageResponse
• DateProps
• DeclineParticipationRequest
• DocumentHash
• DropdownProps
• EncryptedAssetRequest
• EncryptedAssetResponse
• EncryptedFileUploadResponse
• EncryptedMessageResponse
• FormField
• GetSigningProcessResponse
• GetSigningProcessTemplateResponse
• GlobalSearchChannelResponse
• GlobalSearchFileResponse
• GlobalSearchPersonResponse
• GlobalSearchRequestResponse
• GlobalSearchResponse
• LibraryCollectionFileResponse
• LibraryCollectionResponse
• LibraryCollectionShareResponse
• LibraryCollectionSummaryResponse
• LoginRequest
• LoginResponse
• MemberShipInvitationRequest
• Membership
• MessageChannelRefResponse
• MessageMentionResponse
• MessageReactionResponse
• MessageThreadResponse
• MessageThreadSummaryResponse
• NotificationListResponse
• NotificationResponse
• NotificationUnreadCountResponse
• Observer
• OtpDetail
• PairingStatusResponse
• PendingCekResponse
• ProcessUpdateRequest
• Profile
• PublicAssistantCitationResponse
• PublicAssistantLinkResponse
• PublicAssistantRequest
• PublicAssistantResponse
• PublicKey
• PublicProfileResponse
• ReactToMessageRequest
• RegisterPushDeviceRequest
• RegisterTrustedDeviceRequest
• RequestAgentPairingRequest
• RequestAgentPairingResponse
• ResendInvitationRequest
• ResendOtpRequest
• ReviewRejectionRequest
• Reviewer
• RevokeTrustedDeviceRequest
• RotatePassphraseRequest
• SalesContactRequest
• SelfCekResponse
• SignatureCard
• SignatureImage
• SignatureProps
• SigncardTemplate
• Signer
• SigningDocument
• SigningDocumentResponse
• SigningHashRequest
• SigningRequest
• SigningResponse
• SigningStatusResponse
• SigningUploadResponse
• SimpleActionResponse
• SubmitOtpRequest
• SyncThreadKeysRequest
• SyncThreadKeysResponse
• TestDataCleanupResponse
• TextProps
• ThreadParticipantKeyRequest
• ThreadPrivateNoteResponse
• TrustedDeviceResponse
• UpdateCekRequest
• UpdateDocumentRequest
• UpdateEncryptedMessageRequest
• UpdateLibraryCollectionRequest
• UpdateMessageThreadRequest
• UpdateSelfCekRequest
• UpdateThreadPrivateNoteRequest
• UpdateUserKeysRequest
• UpdateUserProfileRequest
• UpdateWebhookRequest
• UpsertAgentKeyGrantRequest
• WebhookEndpointResponse
• WebhookSecretResponse
• WebhookTestResponse

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

apiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Author