api.md

Shared Types

from arcadepy.types import AuthorizationContext, AuthorizationResponse, Error

Admin

UserConnections

Types:

from arcadepy.types.admin import UserConnectionResponse

Methods:

• client.admin.user_connections.list(**params) -> SyncOffsetPage[UserConnectionResponse]
• client.admin.user_connections.delete(id) -> None

AuthProviders

Types:

from arcadepy.types.admin import (
    AuthProviderCreateRequest,
    AuthProviderResponse,
    AuthProviderUpdateRequest,
    AuthProviderListResponse,
)

Methods:

• client.admin.auth_providers.create(**params) -> AuthProviderResponse
• client.admin.auth_providers.list() -> AuthProviderListResponse
• client.admin.auth_providers.delete(id) -> AuthProviderResponse
• client.admin.auth_providers.get(id) -> AuthProviderResponse
• client.admin.auth_providers.patch(path_id, **params) -> AuthProviderResponse

Secrets

Types:

from arcadepy.types.admin import SecretResponse, SecretListResponse

Methods:

• client.admin.secrets.list() -> SecretListResponse
• client.admin.secrets.delete(secret_id) -> None

Auth

Types:

from arcadepy.types import AuthRequest, ConfirmUserRequest, ConfirmUserResponse

Methods:

• client.auth.authorize(**params) -> AuthorizationResponse
• client.auth.confirm_user(**params) -> ConfirmUserResponse
• client.auth.status(**params) -> AuthorizationResponse

Health

Types:

from arcadepy.types import HealthSchema

Methods:

• client.health.check() -> HealthSchema

Chat

Types:

from arcadepy.types import ChatMessage, ChatRequest, ChatResponse, Choice, Usage

Completions

Methods:

• client.chat.completions.create(**params) -> ChatResponse

Tools

Types:

from arcadepy.types import (
    AuthorizeToolRequest,
    ExecuteToolRequest,
    ExecuteToolResponse,
    ToolDefinition,
    ToolExecution,
    ToolExecutionAttempt,
    ValueSchema,
)

Methods:

• client.tools.list(**params) -> SyncOffsetPage[ToolDefinition]
• client.tools.authorize(**params) -> AuthorizationResponse
• client.tools.execute(**params) -> ExecuteToolResponse
• client.tools.get(name, **params) -> ToolDefinition

Scheduled

Types:

from arcadepy.types.tools import ScheduledGetResponse

Methods:

• client.tools.scheduled.list(**params) -> SyncOffsetPage[ToolExecution]
• client.tools.scheduled.get(id) -> ScheduledGetResponse

Formatted

Methods:

• client.tools.formatted.list(**params) -> SyncOffsetPage[object]
• client.tools.formatted.get(name, **params) -> object

Workers

Types:

from arcadepy.types import (
    CreateWorkerRequest,
    UpdateWorkerRequest,
    WorkerHealthResponse,
    WorkerResponse,
)

Methods:

• client.workers.create(**params) -> WorkerResponse
• client.workers.update(id, **params) -> WorkerResponse
• client.workers.list(**params) -> SyncOffsetPage[WorkerResponse]
• client.workers.delete(id) -> None
• client.workers.get(id) -> WorkerResponse
• client.workers.health(id) -> WorkerHealthResponse
• client.workers.tools(id, **params) -> SyncOffsetPage[ToolDefinition]