openapi

Developer-friendly & type-safe Python SDK specifically catered to leverage openapi API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

SDK Installation

Tip

To finish publishing your SDK to PyPI you must run your first generation action.

Note

Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add git+<UNSET>.git

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

Shell and script usage with `uv`

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from attio python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "attio",
# ]
# ///

from attio import SDK

sdk = SDK(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from attio import SDK


with SDK(
    oauth2="<YOUR_OAUTH2_HERE>",
) as sdk:

    res = sdk.objects.get_v2_objects()

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from attio import SDK

async def main():

    async with SDK(
        oauth2="<YOUR_OAUTH2_HERE>",
    ) as sdk:

        res = await sdk.objects.get_v2_objects_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`oauth2`	oauth2	OAuth2 token

To authenticate with the API the oauth2 parameter must be set when initializing the SDK client instance. For example:

from attio import SDK


with SDK(
    oauth2="<YOUR_OAUTH2_HERE>",
) as sdk:

    res = sdk.objects.get_v2_objects()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

lists

get_v2_lists - List all lists
post_v2_lists - Create a list
get_v2_lists_list_ - Get a list
patch_v2_lists_list_ - Update a list

meetings

get_v2_meetings - List meetings
get_v2_meetings_meeting_id_ - Get a meeting

notes

get_v2_notes - List notes
post_v2_notes - Create a note
get_v2_notes_note_id_ - Get a note
delete_v2_notes_note_id_ - Delete a note

objects

get_v2_objects - List objects
post_v2_objects - Create an object
get_v2_objects_object_ - Get an object
patch_v2_objects_object_ - Update an object

records

post_v2_objects_object_records_query - List records
post_v2_objects_object_records - Create a record
put_v2_objects_object_records - Assert a record
get_v2_objects_object_records_record_id_ - Get a record
patch_v2_objects_object_records_record_id_ - Update a record (append multiselect values)
put_v2_objects_object_records_record_id_ - Update a record (overwrite multiselect values)
delete_v2_objects_object_records_record_id_ - Delete a record
get_v2_objects_object_records_record_id_attributes_attribute_values - List record attribute values
get_v2_objects_object_records_record_id_entries - List record entries
post_v2_objects_records_search - Search records

tasks

get_v2_tasks - List tasks
post_v2_tasks - Create a task
get_v2_tasks_task_id_ - Get a task
patch_v2_tasks_task_id_ - Update a task
delete_v2_tasks_task_id_ - Delete a task

threads

get_v2_threads - List threads
get_v2_threads_thread_id_ - Get a thread

transcripts

get_v2_meetings_meeting_id_call_recordings_call_recording_id_transcript - Get call transcript

webhooks

get_v2_webhooks - List webhooks
post_v2_webhooks - Create a webhook
get_v2_webhooks_webhook_id_ - Get a webhook
patch_v2_webhooks_webhook_id_ - Update a webhook
delete_v2_webhooks_webhook_id_ - Delete a webhook

workspace_members

get_v2_workspace_members - List workspace members
get_v2_workspace_members_workspace_member_id_ - Get a workspace member

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from attio import SDK
from attio.utils import BackoffStrategy, RetryConfig


with SDK(
    oauth2="<YOUR_OAUTH2_HERE>",
) as sdk:

    res = sdk.objects.get_v2_objects(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from attio import SDK
from attio.utils import BackoffStrategy, RetryConfig


with SDK(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    oauth2="<YOUR_OAUTH2_HERE>",
) as sdk:

    res = sdk.objects.get_v2_objects()

    # Handle response
    print(res)

Error Handling

SDKError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`err.message`	`str`	Error message
`err.status_code`	`int`	HTTP response status code eg `404`
`err.headers`	`httpx.Headers`	HTTP response headers
`err.body`	`str`	HTTP body. Can be empty string if no body is returned.
`err.raw_response`	`httpx.Response`	Raw HTTP response
`err.data`		Optional. Some errors may contain structured data. See Error Classes.

Example

from attio import SDK, errors


with SDK(
    oauth2="<YOUR_OAUTH2_HERE>",
) as sdk:
    res = None
    try:

        res = sdk.objects.post_v2_objects(data={
            "api_slug": "people",
            "singular_noun": "Person",
            "plural_noun": "People",
        })

        # Handle response
        print(res)


    except errors.SDKError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.PostV2ObjectsSlugConflictError):
            print(e.data.status_code)  # float
            print(e.data.type)  # models.PostV2ObjectsType
            print(e.data.code)  # models.PostV2ObjectsCode
            print(e.data.message)  # str

Error Classes

Primary error:

SDKError: The base class for HTTP error responses.

Less common errors (85)

Network errors:

httpx.RequestError: Base class for request errors.
- httpx.ConnectError: HTTP client was unable to make a request to a server.
- httpx.TimeoutException: HTTP request timed out.

Inherit from SDKError:

PatchV2ObjectsObjectValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
SystemEditUnauthorizedError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesAttributeOptionsValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeOptionsOptionValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesAttributeStatusesValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeStatusesStatusValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
FilterError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2ObjectsObjectRecordsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PutV2ObjectsObjectRecordsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PatchV2ObjectsObjectRecordsRecordIDMissingValueError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PutV2ObjectsObjectRecordsRecordIDMissingValueError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
GetV2ObjectsObjectRecordsRecordIDAttributesAttributeValuesValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2ObjectsRecordsSearchValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2ListsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PatchV2ListsListValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2ListsListEntriesValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
MultipleMatchResultsError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PatchV2ListsListEntriesEntryIDImmutableValueError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PutV2ListsListEntriesEntryIDImmutableValueError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2TasksValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PatchV2TasksTaskIDValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2CommentsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
PostV2WebhooksValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 63 methods.*
BillingError: Forbidden. Status code 403. Applicable to 1 of 63 methods.*
GetV2ObjectsObjectNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2ObjectsObjectNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2TargetIdentifierAttributesAttributeNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2TargetIdentifierAttributesAttributeOptionsNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesAttributeOptionsNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeOptionsOptionNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2TargetIdentifierAttributesAttributeStatusesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesAttributeStatusesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeStatusesStatusNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2ObjectsObjectRecordsQueryNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2ObjectsObjectRecordsNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PutV2ObjectsObjectRecordsNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2ObjectsObjectRecordsRecordIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2ObjectsObjectRecordsRecordIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PutV2ObjectsObjectRecordsRecordIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
DeleteV2ObjectsObjectRecordsRecordIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2ObjectsObjectRecordsRecordIDAttributesAttributeValuesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2ListsNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2ListsListNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2ListsListNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2ListsListEntriesQueryNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2ListsListEntriesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PutV2ListsListEntriesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2ListsListEntriesEntryIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2ListsListEntriesEntryIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PutV2ListsListEntriesEntryIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
DeleteV2ListsListEntriesEntryIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2ListsListEntriesEntryIDAttributesAttributeValuesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2WorkspaceMembersWorkspaceMemberIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2NotesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2NotesNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2NotesNoteIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
DeleteV2NotesNoteIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2TasksNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2TasksTaskIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2TasksTaskIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
DeleteV2TasksTaskIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2ThreadsThreadIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2CommentsCommentIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
DeleteV2CommentsCommentIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2MeetingsMeetingIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2MeetingsMeetingIDCallRecordingsCallRecordingIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
GetV2WebhooksWebhookIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PatchV2WebhooksWebhookIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
DeleteV2WebhooksWebhookIDNotFoundError: Not Found. Status code 404. Applicable to 1 of 63 methods.*
PostV2ObjectsSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PatchV2ObjectsObjectSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesAttributeOptionsSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeOptionsOptionSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PostV2TargetIdentifierAttributesAttributeStatusesSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PatchV2TargetIdentifierAttributesAttributeStatusesStatusSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
PostV2ListsSlugConflictError: Conflict. Status code 409. Applicable to 1 of 63 methods.*
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from attio import SDK


with SDK(
    server_url="https://api.attio.com",
    oauth2="<YOUR_OAUTH2_HERE>",
) as sdk:

    res = sdk.objects.get_v2_objects()

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from attio import SDK
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = SDK(client=http_client)

or you could wrap the client with your own custom logic:

from attio import SDK
from attio.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = SDK(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The SDK class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from attio import SDK
def main():

    with SDK(
        oauth2="<YOUR_OAUTH2_HERE>",
    ) as sdk:
        # Rest of application here...


# Or when using async:
async def amain():

    async with SDK(
        oauth2="<YOUR_OAUTH2_HERE>",
    ) as sdk:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from attio import SDK
import logging

logging.basicConfig(level=logging.DEBUG)
s = SDK(debug_logger=logging.getLogger("attio"))

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 31 Commits
.claude		.claude
.github/workflows		.github/workflows
.speakeasy.backup		.speakeasy.backup
.speakeasy		.speakeasy
docs		docs
scripts		scripts
src/attio		src/attio
.gitattributes		.gitattributes
.gitignore		.gitignore
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
USAGE.md		USAGE.md
api-00.json		api-00.json
api-01.json		api-01.json
overlay.yaml		overlay.yaml
overlay_guide.md		overlay_guide.md
py.typed		py.typed
pylintrc		pylintrc
pyproject.toml		pyproject.toml
pyrightconfig.json		pyrightconfig.json
sdk_changes.txt		sdk_changes.txt
test.json		test.json
test_unmarshal.py		test_unmarshal.py
uv.lock		uv.lock

elviskahoro/attio-sdk-python

Folders and files

Latest commit

History

Repository files navigation

openapi

Summary

Table of Contents

SDK Installation

uv

PIP

Poetry

Shell and script usage with uv

IDE Support

PyCharm

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Retries

Error Handling

Example

Error Classes

Server Selection

Override Server URL Per-Client

Custom HTTP Client

Resource Management

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Uh oh!

Uh oh!

Languages

Shell and script usage with `uv`