quadratic-developer-api-client

Token-authenticated REST API for Quadratic spreadsheets. All /v1/* routes require an Authorization: Bearer <token> header where the token is a qdx_live_… or qdx_test_… value minted from the Quadratic UI.

Optional Quadratic-Session-Id header. Clients may attach a UUID v4 to every request to correlate analytics events from a single integration run (one client instance, one CLI invocation, one CI job). Official SDKs generate one at construction and send it transparently; direct callers may omit it. Malformed values are dropped silently and never propagated to analytics.

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

• API version: 0.26.1
• Package version: 0.26.1
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/quadratichq/quadratic.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/quadratichq/quadratic.git)

Then import the package:

import quadratic_developer_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 quadratic_developer_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import quadratic_developer_api
from quadratic_developer_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = quadratic_developer_api.Configuration(
    host = "http://localhost"
)

# 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 (API token (qdx_live_… or qdx_test_…)): bearer_auth
configuration = quadratic_developer_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with quadratic_developer_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quadratic_developer_api.AgentConnectionsApi(api_client)
    connection_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Agent connection UUID
    team_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Team UUID that owns the connections. Defaults to the caller's token-scoped team when omitted. (optional)

    try:
        # Fetches a single agent connection by UUID, including its full plan and apiSchema.
        api_response = api_instance.get_agent_connection(connection_id, team_uuid=team_uuid)
        print("The response of AgentConnectionsApi->get_agent_connection:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentConnectionsApi->get_agent_connection: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• AddListValidationRequest
• AddLogicalValidationRequest
• AddSheetRequest
• AddTableRequest
• AgentConnectionDetail
• AgentConnectionSecretBinding
• AgentConnectionSummary
• BatchItem
• BatchRequest
• ColorSheetEntry
• ColorSheetsRequest
• ConvertToTableRequest
• CreateFileRequest
• CreateFileResponse
• DeleteCellsRequest
• DeleteColumnsRequest
• DeleteRowsRequest
• DuplicateSheetRequest
• ErrorBody
• ErrorDetail
• FileDetail
• FileSummary
• GetSchemasRequest
• HealthResponse
• ImportIntoFileRequest
• ImportNewFileRequest
• ImportNewFileResponse
• InsertColumnsRequest
• InsertRowsRequest
• MeResponse
• MergeCellsRequest
• MoveCellsRequest
• MoveSheetRequest
• RemoveValidationRequest
• RenameSheetRequest
• RerunCodeRequest
• ResizeColumnsRequest
• ResizeRowsRequest
• SetBordersRequest
• SetCellValuesRequest
• SetCodeCellRequest
• SetDefaultSizeRequest
• SetFormatsRequest
• SetFormulaCellsRequest
• SetSqlCellRequest
• TableColumnSettingsRequest
• TableMetaRequest
• UndoRedoRequest
• UpdateConditionalFormatsRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearer_auth

• Type: Bearer authentication (API token (qdx_live_… or qdx_test_…))

Author