Skip to main content

Anyreach API SDK

Built with APIMatic License: MIT Python 3.10+

The Anyreach API SDK for Python provides access to the Anyreach API REST APIs from Python applications.

REST API for the Anyreach platform.

Every endpoint is scoped to one organization. Authenticate with a bearer token and, if your token can reach more than one organization, name the one you mean with the X-Anyreach-Org header. See Authentication.

This reference is generated from the running service, so the request and response shapes here are the ones the API actually enforces.


Installation

Install the Python SDK from PyPI, with whichever package manager your project uses:

pip install areach-apimatic-sdk
uv add areach-apimatic-sdk
poetry add areach-apimatic-sdk

Quick Start

Synchronous client

Construct AnyreachApiClient with keyword arguments, and call close() when you are done. Every argument is optional; the full list is in the SDK map.

from anyreach_api import AnyreachApiClient

client = AnyreachApiClient(bearer_auth="YOUR_BEARER_TOKEN")

# TODO: call endpoints here -- see api-reference.md

client.close()

Alternatively, scope it -- with AnyreachApiClient(...) as client: closes the pool on exit; see Best Practices.

Client is exported as an alias of AnyreachApiClient, so from anyreach_api import Client also works.

The SDK accepts every model-typed input in two interchangeable spellings, both type-checked: the typed model, or a plain dict with the same keys -- the OrDict and Model | ModelDict unions in the SDK map. Pick whichever suits the call site: the dict form needs no import, while the model form adds a keyword-checked constructor and editor completion.

Asynchronous client

AsyncAnyreachApiClient mirrors AnyreachApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences -- for example, the transport argument is custom_async_http_client.

from asyncio import run

from anyreach_api import AsyncAnyreachApiClient


async def main() -> None:
    client = AsyncAnyreachApiClient(bearer_auth="YOUR_BEARER_TOKEN")
    # TODO: call endpoints here, awaiting each -- see api-reference.md
    await client.aclose()


run(main())

Alternatively, scope it -- async with AsyncAnyreachApiClient(...) as client: closes the pool on exit. Only the async spelling is aclose, matching httpx; see Best Practices.

AsyncClient is the exported alias. Each client accepts only its own transport argument; passing the other's is a TypeError at runtime and an error under mypy.


Usage

Two generated references cover the SDK; each answers a different question:

Reference For
API Reference Usage guidance for a single parsed operation: client.<group>.<operation>(...) returns the typed payload and raises ApiError on any non-2xx, with .error the typed error body, or RawError for a status the operation does not document.
Raw API Reference The same for the raw variant: client.<group>.with_raw_response.<operation>(...) returns ApiResult[T, E] and never raises for an API error.

Both API references carry every one of the 185 operations, with a sync and an async sample and a parameter table each.

SDK map

This SDK ships a generated SDK map -- sdk-map.md -- a deterministic, lookup-oriented table of contents of the SDK's Python surface, generated by APIMatic alongside this SDK.

Consult the map before scanning or grepping the source: it answers call-level contract questions by lookup, and for anything it does not carry -- model shapes, enum values, an endpoint's route or behavioural prose -- it names the one source file to read. How to read the map itself, including the SDK-wide defaults its rows rely on, is stated at the top of sdk-map.md.

Best Practices

Match the disposal to the client's lifetime: an application-lifetime client is closed once at shutdown with close() / aclose(); where the lifetime fits a block, with AnyreachApiClient() as client: / async with AsyncAnyreachApiClient() as client: releases it automatically. Both are idempotent, but a closed client is not reusable: the next call raises. The client closes whatever transport it holds, including one you supplied via custom_http_client / custom_async_http_client; if you intend to reuse your own transport across clients, don't hand its lifetime to a with block.

License

This SDK is distributed under the MIT License.


Support

Refer to the API reference for detailed information on available operations with code samples.


Metadata

Release files for areach-apimatic-sdk 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for areach-apimatic-sdk 0.0.2
File Size Uploaded Provenance Actions
areach_apimatic_sdk-0.0.2.tar.gz 238.4 kB Without provenance Details for areach_apimatic_sdk-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for areach-apimatic-sdk 0.0.2
File Interpreter ABI Platform Actions
areach_apimatic_sdk-0.0.2-py3-none-any.whl Python 3 none any Details for areach_apimatic_sdk-0.0.2-py3-none-any.whl

Total release size: 784.8 kB

Release files / areach_apimatic_sdk-0.0.2.tar.gz

Download URL areach_apimatic_sdk-0.0.2.tar.gz
Size 238.4 kB
Tags Source
SHA-256 checksum
How to use checksums
ea4bc6f09c8f88da5c07c788a03056a82b22fb61d3feb2ce10e2be22487197d9
BLAKE2b-256 checksum
How to use checksums
dbcf837bf181c934339cc666e15c01fe56fade67f78de2b1f88051bd4a3031d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.3 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Release files / areach_apimatic_sdk-0.0.2-py3-none-any.whl

Download URL areach_apimatic_sdk-0.0.2-py3-none-any.whl
Size 546.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1920a0f4e3e7121b5fcd5fc999743b0b977969e0febc87b22c1e08c40b3e2e30
BLAKE2b-256 checksum
How to use checksums
8e64c505d34ee81aa4efa164967f052b2e49d6953886abf976f7d8df2638de3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.3 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Security for areach-apimatic-sdk 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page