docspace_api_sdk

The ONLYOFFICE DocSpace SDK for Python is a library that provides tools for integrating and managing DocSpace features within your applications. It simplifies interaction with the DocSpace API by offering ready-to-use methods and models.

For more information, please visit https://helpdesk.onlyoffice.com/hc/en-us

Requirements

Python 3.10+

Installation & Usage

Using pip

If the Python package is hosted in a repository, you can install it directly using:

pip install git+https://github.com/ONLYOFFICE/docspace-api-sdk-python.git

If required, run with root permissions:

sudo pip install git+https://github.com/ONLYOFFICE/docspace-api-sdk-python.git

Then import the package:

import docspace_api_sdk

Using setuptools

Alternatively, you can install the package using setuptools:

python setup.py install --user

To install the package for all users, run the following command:

sudo python setup.py install

Then import the package:

import docspace_api_sdk

Getting Started

Please follow the installation procedure and then run the following:

import docspace_api_sdk
from docspace_api_sdk.rest import ApiException
from pprint import pprint

configuration = docspace_api_sdk.Configuration(
    host = "https://your-docspace.onlyoffice.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 Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = docspace_api_sdk.AIAgentsApi(api_client)
    create_agent_request_dto = docspace_api_sdk.CreateAgentRequestDto() # CreateAgentRequestDto |  (optional)

    try:
        # Create an ai agent
        api_response = api_instance.create_agent(create_agent_request_dto=create_agent_request_dto)
        print("The response of AIAgentsApi->create_agent:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AIAgentsApi->create_agent: %s\n" % e)

Documentation For Authorization

Authentication schemes defined for the API:

asc_auth_key

• Type: API key
• API key parameter name: asc_auth_key
• Location:

Basic

• Type: HTTP basic authentication

Bearer

• Type: Bearer authentication (JWT)

ApiKeyBearer

• Type: API key
• API key parameter name: ApiKeyBearer
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: {{authBaseUrl}}/oauth2/authorize
• Token Url: {{authBaseUrl}}/oauth2/token
• Scopes:
• read: Read access to protected resources
• write: Write access to protected resources

OpenId

• Type: OpenId Connect
• OpenId Connect URL: {{authBaseUrl}}/.well-known/openid-configuration

x-signature

• Type: API key
• API key parameter name: x-signature
• Location:

Rate Limiting

All API responses may include the following rate limiting headers:

Documentation for API Endpoints

All URIs are relative to https://your-docspace.onlyoffice.com

Documentation For Models