Python API reference
This file is generated by scripts/generate_api_reference.py. Do not edit it by hand.
Docstrings and type signatures in the Python source remain authoritative.
vendor_fabric.anthropic
class AnthropicError
Base exception for Anthropic API errors.
class AnthropicAuthError
Authentication error.
class AnthropicRateLimitError
Rate limit exceeded error.
class AnthropicAPIError
API error from Anthropic service.
class MessageRole
Message role in conversation.
class ContentBlock
Content block within a message.
class Usage
Token usage information.
class Message
Claude message response.
class Model
Claude model information.
class AnthropicConnector
Anthropic Claude API connector.
vendor_fabric.anthropic.tools
class CreateMessageSchema
Pydantic schema for the anthropic_create_message tool.
class ListModelsSchema
Pydantic schema for the anthropic_list_models tool.
anthropic_create_message(model: str, prompt: str, max_tokens: int=1024, system: str | None=None)
Create a message using Anthropic Claude.
anthropic_list_models()
List available Anthropic Claude models.
vendor_fabric.aws
class AWSConnector
AWS connector for boto3 client, resource, and external data operations.
vendor_fabric.aws.codedeploy
get_aws_codedeploy_deployments(application_name: str | None=None, deployment_group_name: str | None=None, deployment_config_name: str | None=None, statuses: Sequence[str] | None=None, created_after: datetime | str | float | None=None, created_before: datetime | str | float | None=None, tag_filters: Sequence[Mapping[str, Any]] | None=None, include_details: bool=True, limit: int | None=None, next_token: str | None=None, max_pages: int | None=None, codedeploy_client: BaseClient | None=None, aws_connector: AWSConnector | None=None, execution_role_arn: str | None=None, role_session_name: str | None=None, region_name: str | None=None, config: Config | None=None, logging_adapter: Logging | None=None)
List CodeDeploy deployments with optional detail hydration.
create_codedeploy_deployment(application_name: str, deployment_group_name: str, revision: Mapping[str, Any], description: str | None=None, ignore_application_stop_failures: bool | None=None, file_exists_behavior: str | None=None, auto_rollback_configuration: Mapping[str, Any] | None=None, update_outdated_instances_only: bool | None=None, wait: bool=False, waiter_delay: int=15, waiter_max_attempts: int=120, include_details: bool=True, codedeploy_client: BaseClient | None=None, aws_connector: AWSConnector | None=None, execution_role_arn: str | None=None, role_session_name: str | None=None, region_name: str | None=None, config: Config | None=None, logging_adapter: Logging | None=None, **additional_params: Any)
Create a CodeDeploy deployment and optionally wait for completion.
vendor_fabric.aws.organizations
class AWSOrganizationsMixin
Mixin providing AWS Organizations operations.
vendor_fabric.aws.s3
class AWSS3Mixin
Mixin providing AWS S3 operations.
vendor_fabric.aws.sso
class AWSSSOmixin
Mixin providing AWS SSO/Identity Center operations.
vendor_fabric.aws.tools
class GetCallerAccountIdSchema
Schema for getting caller account ID.
class ListS3BucketsSchema
Schema for listing S3 buckets.
class ListS3ObjectsSchema
Schema for listing S3 objects.
class ListAccountsSchema
Schema for listing AWS accounts.
class ListSSOUsersSchema
Schema for listing SSO users.
class ListSSOGroupsSchema
Schema for listing SSO groups.
class ListSecretsSchema
Schema for listing secrets.
class GetSecretSchema
Schema for getting a secret.
get_caller_account_id()
Get the AWS account ID of the caller.
list_s3_buckets()
List S3 buckets in the account.
list_s3_objects(bucket: str)
List objects in an S3 bucket.
list_accounts()
List AWS organization accounts.
list_sso_users()
List IAM Identity Center users.
list_sso_groups()
List IAM Identity Center groups.
list_secrets(prefix: str='', get_values: bool=False)
List secrets from AWS Secrets Manager.
get_secret(secret_id: str)
Get a single secret value from AWS Secrets Manager.
vendor_fabric.base
class RateLimitError
Raised when API rate limit is hit - triggers retry.
class ConnectorAPIError
Raised when API returns an error.
class ConnectorBase
Base class for all vendor fabric.
vendor_fabric.capabilities
class CapabilitySpec
A provider-declared operation exposed through a facade.
class CapabilityRoute
Resolved provider operation routed to a concrete method.
capability(operation: str, *, kind: str='operation', aliases: tuple[str, ...]=(), description: str='')
Declare that a provider method supports a facade operation.
class CapabilityProviderMixin
Collect provider capability declarations from class methods.
capability_routes(provider: str, provider_cls: type[Any])
Return resolved capability routes for a provider class.
vendor_fabric.cli
cmd_list(args: argparse.Namespace)
List connector catalog entries.
cmd_call(args: argparse.Namespace)
Call a connector data method.
cmd_methods(args: argparse.Namespace)
List connector data methods.
cmd_credentials(args: argparse.Namespace)
List connector credential and configuration source names.
cmd_secrets_sync(args: argparse.Namespace)
Route a command through the binding-backed SecretSync CLI.
cmd_info(args: argparse.Namespace)
Show info about a specific connector.
main(argv: Sequence[str] | None=None)
Main CLI entry point.
vendor_fabric.cloud_params
get_cloud_call_params(max_results: int | None=10, no_max_results: bool=False, reject_null: bool=True, first_letter_to_lower: bool=False, first_letter_to_upper: bool=False, **kwargs: Any)
Build a parameter dictionary for cloud API calls.
get_aws_call_params(max_results: int | None=100, **kwargs: Any)
Build parameters for AWS API calls.
get_google_call_params(max_results: int | None=200, no_max_results: bool=False, **kwargs: Any)
Build parameters for Google Cloud API calls.
vendor_fabric.connectors
class ConnectorFabric
Public API for vendor fabric with client caching.
vendor_fabric.cursor
class CursorError
Base exception for Cursor API errors.
class CursorValidationError
Validation error for Cursor API inputs.
class CursorAPIError
API error from Cursor service.
class AgentState
Agent execution state.
class Agent
Cursor Background Agent representation.
class Repository
Repository available for Cursor agents.
class ConversationMessage
Single message in agent conversation.
class Conversation
Agent conversation history.
class LaunchOptions
Options for launching a new agent.
validate_agent_id(agent_id: str)
Validate an agent ID to prevent injection attacks.
validate_prompt_text(text: str)
Validate prompt text.
validate_repository(repository: str)
Validate repository name.
validate_webhook_url(url: str)
Validate webhook URL to prevent SSRF attacks.
sanitize_error(error: Any, *, values: Iterable[Any] | None=None)
Sanitize error messages to prevent sensitive data leakage.
class CursorConnector
Cursor Background Agent API connector.
vendor_fabric.cursor.tools
class LaunchAgentSchema
Pydantic schema for the cursor_launch_agent tool.
class GetAgentStatusSchema
Pydantic schema for the cursor_get_agent_status tool.
cursor_launch_agent(prompt: str, repository: str, ref: str | None=None, branch_name: str | None=None)
Launch a new Cursor coding agent.
cursor_get_agent_status(agent_id: str)
Get the current status of a Cursor agent.
vendor_fabric.github
class GitHubFallbackError
Fallback exception used until PyGithub is imported.
get_github_api_error(exc: BaseException)
Extract error message from a GitHub exception.
class GitHubConnector
GitHub connector for repository operations.
build_github_actions_workflow(workflow_name: str, jobs: dict[str, Any], concurrency_group: str | None=None, environment_variables: dict[str, str] | None=None, secrets: dict[str, str] | None=None, use_oidc_auth: bool=True, events: dict[str, Any] | None=None, triggers: dict[str, Any] | None=None, inputs: dict[str, Any] | None=None, pull_requests: dict[str, Any] | None=None)
Generate a GitHub Actions workflow YAML string.
vendor_fabric.github.tools
class ListReposSchema
Schema for listing GitHub repositories.
class GetRepoSchema
Schema for getting a GitHub repository.
class ListTeamsSchema
Schema for listing GitHub teams.
class GetTeamSchema
Schema for getting a GitHub team.
class ListOrgMembersSchema
Schema for listing GitHub organization members.
class GetRepositoryFileSchema
Schema for getting a file from a GitHub repository.
list_repositories(github_owner: str, type_filter: str='all', include_branches: bool=False, github_token: str | None=None, **kwargs: Any)
List repositories in a GitHub organization.
get_repository(github_owner: str, repo_name: str, github_token: str | None=None, **kwargs: Any)
Get details of a specific GitHub repository.
list_teams(github_owner: str, include_members: bool=False, include_repos: bool=False, github_token: str | None=None, **kwargs: Any)
List teams in a GitHub organization.
get_team(github_owner: str, team_slug: str, github_token: str | None=None, **kwargs: Any)
Get details of a specific GitHub team.
list_org_members(github_owner: str, role: str='member', include_pending: bool=False, github_token: str | None=None, **kwargs: Any)
List members of a GitHub organization.
get_repository_file(github_owner: str, github_repo: str, file_path: str, github_branch: str | None=None, github_token: str | None=None, **kwargs: Any)
Get a file from a GitHub repository.
vendor_fabric.google
class GoogleConnector
Google Cloud and Workspace connector.
vendor_fabric.google.billing
class GoogleBillingMixin
Mixin providing Google Cloud Billing operations.
vendor_fabric.google.cloud
class GoogleCloudMixin
Mixin providing Google Cloud Platform operations.
vendor_fabric.google.jules
class SessionState
Jules session states.
class AutomationMode
Automation modes for Jules sessions.
class Source
A connected source (e.g., GitHub repository).
class SourceContext
Context for a session's source.
class PullRequestOutput
Pull request created by Jules.
class Session
A Jules session.
class JulesError
Error from Jules API.
class JulesConnector
Connector for Google Jules AI Agent API.
vendor_fabric.google.services
class GoogleServicesMixin
Mixin providing Google Cloud services discovery operations.
vendor_fabric.google.tools
class ListProjectsSchema
Schema for listing Google Cloud projects.
class ListFoldersSchema
Schema for listing Google Cloud folders.
class ListEnabledServicesSchema
Schema for listing enabled services in a project.
class ListBillingAccountsSchema
Schema for listing Google Cloud billing accounts.
class ListWorkspaceUsersSchema
Schema for listing Google Workspace users.
class ListWorkspaceGroupsSchema
Schema for listing Google Workspace groups.
list_projects(parent: str='', max_results: int=100)
List Google Cloud projects.
list_folders(parent: str, max_results: int=100)
List folders under a parent resource.
list_enabled_services(project_id: str, max_results: int=100)
List enabled services in a Google Cloud project.
list_billing_accounts(max_results: int=100)
List Google Cloud billing accounts.
list_workspace_users(domain: str='', max_results: int=100)
List users from Google Workspace.
list_workspace_groups(domain: str='', max_results: int=100)
List groups from Google Workspace.
vendor_fabric.google.workspace
class GoogleWorkspaceMixin
Mixin providing Google Workspace operations.
vendor_fabric.meshy.animate
create(request: AnimationRequest)
Create animation task. Returns task_id.
get(task_id: str)
Get task status.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until complete or failed.
apply(rigged_task_id: str, animation_id: int, *, loop: bool=True, frame_rate: int=30, wait: bool=True)
Apply animation to a rigged model.
vendor_fabric.meshy.animations
class AnimationMeta
Metadata for a Meshy animation.
class AnimationCategory
Animation categories.
class AnimationSubcategory
Animation subcategories.
class GameAnimationSet
Pre-defined animation sets for common game scenarios.
get_animations_by_category(category: AnimationCategory)
Get all animations in a category.
get_animations_by_subcategory(subcategory: AnimationSubcategory)
Get all animations in a subcategory.
get_animation(action_id: int)
Get animation by ID.
vendor_fabric.meshy.base
class RateLimitError
Raised when API rate limit is hit.
class MeshyAPIError
Raised when API returns an error.
configure(api_key: str | None=None, **kwargs: Any)
Configure Meshy API credentials.
get_api_key()
Get API key from InputProvider (env vars, direct inputs, or stdin).
get_client()
Get or create HTTP client.
close()
Close the HTTP client.
task_failure_message(error: Any)
Return a public, redacted Meshy task failure message.
unexpected_response_message(data: Any)
Return a public, redacted unexpected-response diagnostic.
task_id_from_response(response: httpx.Response)
Extract a non-empty Meshy task id from any documented create-response shape.
task_payload_from_response(response: httpx.Response, model_type: type[BaseModel], endpoint: str)
Validate a Meshy task payload and return a promoted public mapping.
task_list_from_response(response: httpx.Response, model_type: type[BaseModel], endpoint: str)
Validate a Meshy task list and return promoted public mappings.
poll_task(fetch: Callable[[str], ExtendedDict], task_id: str, interval: float=5.0, timeout: float=600.0)
Poll a Meshy task through its endpoint-specific fetch function.
request(method: str, endpoint: str, *, version: str='v2', **kwargs: Any)
Make HTTP request with retries and rate limiting.
download(url: str, output_path: str)
Download file from URL.
vendor_fabric.meshy.connector
class MeshyConnector
Meshy AI 3D generation connector.
vendor_fabric.meshy.image2image
create(request: Image2ImageRequest)
Create an image-to-image task and return its task ID.
get(task_id: str)
Get an image-to-image task.
delete(task_id: str)
Permanently delete an image-to-image task.
list_tasks(*, page_num: int=1, page_size: int=10, sort_by: str='-created_at')
List image-to-image tasks.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until the image-to-image task reaches a terminal state.
generate(prompt: str, reference_image_urls: list[str], *, ai_model: str='nano-banana', aspect_ratio: str | None=None, generate_multi_view: bool=False, wait: bool=True)
Edit reference images from a text prompt.
vendor_fabric.meshy.image3d
create(request: Image3DRequest)
Create image-to-3d task. Returns task_id.
get(task_id: str)
Get task status.
refine(task_id: str)
Refine preview to full quality. Returns new task_id.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Polls the status of an image-to-3D task until it completes, fails, expires, or times out.
generate(image_url: str, *, topology: str | None=None, target_polycount: int | None=None, enable_pbr: bool=True, wait: bool=True)
Generate a 3D model from an image.
vendor_fabric.meshy.jobs
class AssetManifest
Metadata for generated asset.
class ImageManifest
Persisted metadata for a text-to-image generation job.
class ImageGenerator
Orchestrate text-to-image submission, polling, download, and persistence.
class AssetGenerator
Orchestrates 3D asset generation workflows.
example_character_spec()
Example character asset specification.
example_prop_spec()
Example prop asset specification.
example_environment_spec()
Example environment asset specification.
vendor_fabric.meshy.logging
create_meshy_logger(*, level: int | str='INFO', logger_name: str=MESHY_LOGGER_NAME, enable_console: bool=False, enable_file: bool=False, log_file_name: str | None=None, default_storage_marker: str | None=MESHY_STORAGE_MARKER, allowed_levels: Sequence[str] | None=None, denied_levels: Sequence[str] | None=None, enable_verbose_output: bool=False, verbosity_threshold: int=VERBOSITY)
Create an Extended Data logger configured for Meshy workflows.
vendor_fabric.meshy.models
class TaskStatus
No module-local docstring is available.
class ArtStyle
Art style for text-to-3D generation.
class TexturePBRMapType
No module-local docstring is available.
class Text2ImageRequest
No module-local docstring is available.
class Text2ImageResult
No module-local docstring is available.
class Image2ImageRequest
No module-local docstring is available.
class Image2ImageResult
Image-to-image task payload; its result contract matches text-to-image.
class Text3DRequest
No module-local docstring is available.
class ModelUrls
No module-local docstring is available.
class TextureUrls
No module-local docstring is available.
class Text3DResult
No module-local docstring is available.
class Text3DTask
No module-local docstring is available.
class RiggingTask
No module-local docstring is available.
class AnimationTask
No module-local docstring is available.
class RetextureTask
No module-local docstring is available.
class AnimationAction
No module-local docstring is available.
class TextTextureRequest
No module-local docstring is available.
class TextTextureResult
No module-local docstring is available.
class Image3DRequest
No module-local docstring is available.
class Image3DResult
No module-local docstring is available.
class ModelTaskResult
Common current Meshy task payload for 3D generation and processing APIs.
class MultiImage3DRequest
No module-local docstring is available.
class MultiImage3DResult
Multi-image-to-3D task payload.
class RemeshRequest
No module-local docstring is available.
class RemeshResult
Remesh task payload.
class RiggingRequest
No module-local docstring is available.
class BasicAnimations
No module-local docstring is available.
class RiggingResultData
No module-local docstring is available.
class RiggingResult
No module-local docstring is available.
class AnimationRequest
No module-local docstring is available.
class AnimationResult
No module-local docstring is available.
class RetextureRequest
No module-local docstring is available.
class RetextureResult
No module-local docstring is available.
class AssetIntent
Categories for 3D asset generation.
class AssetSpec
High-level specification for 3D asset generation.
vendor_fabric.meshy.multiimage3d
create(request: MultiImage3DRequest)
Create a multi-image-to-3D task and return its task ID.
get(task_id: str)
Get a multi-image-to-3D task.
delete(task_id: str)
Permanently delete a multi-image-to-3D task.
list_tasks(*, page_num: int=1, page_size: int=10, sort_by: str='-created_at')
List multi-image-to-3D tasks.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until the multi-image-to-3D task reaches a terminal state.
generate(image_urls: list[str], *, ai_model: str='latest', should_texture: bool=True, enable_pbr: bool=False, target_formats: list[str] | None=None, wait: bool=True)
Generate a 3D model from one to four views of the same subject.
vendor_fabric.meshy.persistence.repository
class TaskRepository
File-backed repository for task manifests with atomic operations.
vendor_fabric.meshy.persistence.schemas
class TaskStatus
Task status enum.
class TaskSubmission
Record of a task submission.
class TaskGraphEntry
Record of a single task in the generation pipeline.
class ArtifactRecord
Record of a downloaded file artifact.
class StatusHistoryEntry
Record of a status transition.
class AssetManifest
Manifest for a single generated asset.
class ProjectManifest
Top-level manifest for all assets of a project.
vendor_fabric.meshy.persistence.utils
canonicalize_spec(spec: dict[str, Any])
Convert asset spec to canonical JSON string for hashing.
compute_spec_hash(spec: dict[str, Any], length: int=12)
Compute truncated SHA256 hash of asset spec.
vendor_fabric.meshy.persistence.vector_store
class GenerationRecord
Record of a 3D asset generation.
class SimilarityResult
Result from similarity search.
class VectorStore
SQLite vector store for asset generation tracking and RAG.
get_embedding(text: str, model: str='all-MiniLM-L6-v2')
Get embedding for text using sentence-transformers.
vendor_fabric.meshy.remesh
create(request: RemeshRequest)
Create a remesh task and return its task ID.
get(task_id: str)
Get a remesh task.
delete(task_id: str)
Permanently delete a remesh task.
list_tasks(*, page_num: int=1, page_size: int=10, sort_by: str='-created_at')
List remesh tasks.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until the remesh task reaches a terminal state.
apply(model_task_id: str, *, target_formats: list[str] | None=None, topology: str='triangle', target_polycount: int | None=None, decimation_mode: int | None=None, wait: bool=True)
Remesh a completed Meshy model task.
apply_from_url(model_url: str, *, target_formats: list[str] | None=None, topology: str='triangle', target_polycount: int | None=None, decimation_mode: int | None=None, wait: bool=True)
Remesh a model supplied by public URL or data URI.
vendor_fabric.meshy.retexture
create(request: RetextureRequest)
Create retexture task. Returns task_id.
get(task_id: str)
Get task status.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until complete or failed.
apply(model_task_id: str, prompt: str, *, enable_original_uv: bool=True, enable_pbr: bool=True, wait: bool=True)
Apply new textures to a model.
apply_from_image(model_task_id: str, style_image_url: str, *, enable_original_uv: bool=True, enable_pbr: bool=True, wait: bool=True)
Apply textures based on reference image.
vendor_fabric.meshy.rigging
create(request: RiggingRequest)
Create rigging task. Returns task_id.
get(task_id: str)
Get task status.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until complete or failed.
rig(model_task_id: str, *, height_meters: float=1.7, wait: bool=True)
Rig a model for animation.
rig_from_url(model_url: str, *, height_meters: float=1.7, texture_url: str | None=None, wait: bool=True)
Rig a model from URL.
vendor_fabric.meshy.text2image
create(request: Text2ImageRequest, *, requester: Requester | None=None)
Create a text-to-image task and return its task ID.
get(task_id: str, *, requester: Requester | None=None)
Get a text-to-image task.
delete(task_id: str)
Permanently delete a text-to-image task and its generated images.
list_tasks(*, page_num: int=1, page_size: int=10, sort_by: str='-created_at')
List text-to-image tasks using Meshy's pagination contract.
poll(task_id: str, interval: float=5.0, timeout: float=600.0, *, requester: Requester | None=None)
Poll until the text-to-image task succeeds or reaches a terminal state.
generate(prompt: str, *, ai_model: str='nano-banana', aspect_ratio: str | None=None, generate_multi_view: bool=False, pose_mode: str | None=None, wait: bool=True, requester: Requester | None=None)
Generate images from text, optionally waiting for the completed task.
download_first(result: Mapping[str, object], output_path: str)
Download image_urls[0] from a completed text-to-image task.
vendor_fabric.meshy.text3d
create(request: Text3DRequest)
Create text-to-3d task. Returns task_id.
get(task_id: str)
Get task status.
refine(task_id: str)
Refine preview to full quality. Returns new task_id.
poll(task_id: str, interval: float=5.0, timeout: float=600.0)
Poll until complete or failed.
generate(prompt: str, *, art_style: ArtStyle | str=ArtStyle.REALISTIC, negative_prompt: str='', target_polycount: int=15000, enable_pbr: bool=True, wait: bool=True)
Generate a 3D model from text.
vendor_fabric.meshy.tools
class Text3dGenerateSchema
Pydantic schema for the text3d_generate tool.
class Text2ImageGenerateSchema
Pydantic schema for the text2image_generate tool.
class Image3dGenerateSchema
Pydantic schema for the image3d_generate tool.
class RigModelSchema
Pydantic schema for the rig_model tool.
class ApplyAnimationSchema
Pydantic schema for the apply_animation tool.
class RetextureModelSchema
Pydantic schema for the retexture_model tool.
class ListAnimationsSchema
Pydantic schema for the list_animations tool.
class CheckTaskStatusSchema
Pydantic schema for the check_task_status tool.
class GetAnimationSchema
Pydantic schema for the get_animation tool.
text3d_generate(prompt: str, art_style: str='realistic', negative_prompt: str='', target_polycount: int=30000, enable_pbr: bool=True)
Generate a 3D model from text description.
text2image_generate(prompt: str, ai_model: str='nano-banana', aspect_ratio: str | None=None, generate_multi_view: bool=False, pose_mode: str | None=None)
Generate an image from text and expose the first downloadable URL.
image3d_generate(image_url: str, topology: str='', target_polycount: int=15000, enable_pbr: bool=True)
Generate a 3D model from an image.
rig_model(model_id: str, wait: bool=True)
Add skeleton/rig to a static 3D model.
apply_animation(model_id: str, animation_id: int, wait: bool=True)
Apply animation to a rigged model.
retexture_model(model_id: str, texture_prompt: str, enable_pbr: bool=True, wait: bool=True)
Apply new textures to an existing model.
list_animations(category: str='', limit: int=50)
List available animations from the Meshy catalog.
check_task_status(task_id: str, task_type: str='text-to-3d')
Check status of a Meshy task.
get_animation(animation_id: int)
Get details of a specific animation.
vendor_fabric.meshy.webhooks.handler
class WebhookHandler
Handle webhook callbacks from Meshy API.
vendor_fabric.meshy.webhooks.schemas
class WebhookModelUrls
Model URLs in webhook payload.
class WebhookTextureUrls
Texture URLs in webhook payload.
class WebhookBasicAnimations
Basic animations in rigging webhook.
class WebhookRiggingResult
Rigging result in webhook payload.
class WebhookTaskError
Error details in webhook payload.
class MeshyWebhookPayload
Webhook payload from Meshy API.
vendor_fabric.registry
class BuiltinConnectorSpec
Import metadata for a built-in connector.
class ConnectorInfo
Registry metadata for a connector.
class ConnectorAdapter
Adapter contract for connector availability, metadata, and construction.
class BuiltinConnectorAdapter
Adapter for a connector shipped inside this distribution.
class RegisteredConnectorAdapter
Adapter for a connector class discovered through entry points.
list_connectors(*, include_unavailable: bool=True)
List connector catalog names.
list_available_connectors()
List connector names whose runtime requirements are installed.
get_connector_class(name: str)
Get a connector class by name.
get_connector(name: str, **kwargs: Any)
Factory to instantiate a connector by name.
clear_cache()
Clear the connector cache (useful for testing).
get_connector_info(name: str, *, include_unavailable: bool=True)
Get registry metadata about a connector.
get_connector_adapter(name: str, *, include_unavailable: bool=True)
Get the adapter registry entry for a connector.
list_connector_info(*, include_unavailable: bool=True)
Get registry metadata for known connectors.
list_connector_categories(*, include_unavailable: bool=True)
List connector catalog categories.
list_connector_capabilities(*, include_unavailable: bool=True)
List connector catalog capabilities.
list_connectors_by_category(category: str, *, include_unavailable: bool=True)
List connector catalog entries for a category.
list_connectors_by_capability(capability: str, *, include_unavailable: bool=True)
List connector catalog entries for a capability.
vendor_fabric.secrets_sync.bundles
bundle_id(sources: list[str])
Return the deterministic bundle id for an ordered source sequence.
bundle_path(mount: str, sources: list[str])
Return a generic merge bundle path.
target_bundle_path(mount: str, target_name: str, sources: list[str])
Return a target-scoped merge bundle path.
vendor_fabric.secrets_sync.cli
cmd_validate(args: argparse.Namespace)
Validate a config file.
cmd_info(args: argparse.Namespace)
Inspect a config file.
cmd_pipeline(args: argparse.Namespace)
Run a pipeline operation.
build_parser()
Build the CLI argument parser.
main(argv: list[str] | None=None)
Run the CLI.
vendor_fabric.secrets_sync.deepmerge
deep_merge(dst: Mapping[str, Any] | None, src: Mapping[str, Any] | None)
Merge src into dst using the shared Extended Data semantics.
normalize_for_compare(value: Any)
Normalize JSON-compatible values before equality checks.
deep_equal(left: Any, right: Any)
Return whether two secret payloads are equal after JSON normalization.
compare_secret_json(existing: str | bytes, new: str | bytes)
Compare two secret strings as JSON when possible, else as raw strings.
vendor_fabric.secrets_sync.files
class FileSyncResult
File sync operation result.
class LocalFileStore
Local file store using Extended Data decoding and export.
class S3FileStore
S3 file store using the AWS connector.
sync_mapping_to_file(data: Mapping[str, Any], destination: str | Path, *, encoding: str | None='json', dry_run: bool=False)
Sync a mapping to a local file through Extended Data export rules.
vendor_fabric.secrets_sync.graph
class NodeType
Dependency graph node type.
class Node
Dependency graph node.
class Graph
Target dependency graph.
vendor_fabric.secrets_sync.models
class SyncOperation
Pipeline operation types.
class OutputFormat
Diff output formats.
class ProviderSession
Authenticated provider material passed through to the SecretSync binding.
class SyncOptions
Options for pipeline execution.
class LogConfig
Logging configuration.
class VaultAuthAppRole
Vault AppRole authentication config.
class VaultAuthToken
Vault token authentication config.
class VaultAuthKubernetes
Vault Kubernetes authentication config.
class VaultAuthConfig
Vault authentication config.
class VaultConfig
Vault connection config.
class ExecutionRoleConfig
Control Tower execution role config.
class ControlTowerConfig
AWS Control Tower config.
class ExecutionContextConfig
AWS execution context config.
class AWSConfig
AWS config.
class VaultSource
Vault source config.
class AWSSource
AWS Secrets Manager source config.
class Source
Source config.
class MergeStoreVault
Vault merge store config.
class MergeStoreS3
S3 merge store config.
class MergeStoreConfig
Merge store config.
class Target
Sync destination target.
class AccountNamePattern
Dynamic target account-name routing pattern.
class DynamicTarget
Runtime-discovered target config.
class MergeSettings
Merge phase settings.
class SyncSettings
Sync phase settings.
class PipelineSettings
Pipeline settings.
class ConfigInfo
Public configuration information.
class ResultDetails
Operation detail counts.
class TargetDiff
Diff summary for one target.
class OperationResult
Outcome for one target and phase.
class SyncResult
Aggregate pipeline result.
class SecretSyncConfig
SecretSync pipeline configuration.
redacted_error(exc: BaseException)
Return a redacted exception string.
vendor_fabric.secrets_sync.pipeline
class SecretSyncPipeline
Transitional Python pipeline for tests and compatibility.
validate_config(config_path: str)
Validate a config file through the SecretSync binding.
get_config_info(config_path: str)
Return public configuration info through the SecretSync binding.
run_pipeline(config_path: str, options: SyncOptions | None=None, provider_session: ProviderSession | Mapping[str, Any] | None=None)
Run a SecretSync config file through the SecretSync binding.
dry_run(config_path: str, provider_session: ProviderSession | Mapping[str, Any] | None=None)
Run a dry-run pipeline through the SecretSync binding.
get_targets(config_path: str)
Return target names through the SecretSync binding.
get_sources(config_path: str)
Return source names through the SecretSync binding.
merge(config_path: str, *, dry_run: bool=False, provider_session: ProviderSession | Mapping[str, Any] | None=None)
Run only the merge phase through the SecretSync binding.
sync(config_path: str, *, dry_run: bool=False, provider_session: ProviderSession | Mapping[str, Any] | None=None)
Run only the sync phase through the SecretSync binding.
diff_trees(target: str, phase: str, before: Mapping[str, Any], after: Mapping[str, Any])
Return a diff summary for two secret trees.
format_diff(diffs: list[TargetDiff], *, output_format: OutputFormat=OutputFormat.JSON)
Format target diffs for CLI and agent diagnostics.
vendor_fabric.secrets_sync.stores
class WriteSummary
Summary of a store write operation.
class SecretTreeStore
Read/write interface for tree-shaped secret stores.
join_secret_path(*parts: str)
Join secret path parts without duplicate separators.
relative_secret_path(path: str, root: str)
Return path relative to root.
normalize_secret_payload(value: Any)
Return a dict payload from connector values.
class InMemorySecretStore
In-memory secret tree store for dry-runs, tests, and ephemeral merges.
class VaultSecretStore
Vault KV2-backed secret tree store.
class AWSSecretsManagerStore
AWS Secrets Manager tree store.
class S3SecretStore
S3-backed JSON object store for merged secret bundles.
class StoreRegistry
Explicit store injection for tests and custom vendor wiring.
vendor_fabric.secrets_sync.tools
class ValidateConfigSchema
Schema for validating a secrets sync configuration.
class RunPipelineSchema
Schema for running the secrets sync pipeline.
class GetConfigInfoSchema
Schema for getting configuration information.
validate_config(config_path: str)
Validate a secrets sync pipeline configuration file.
run_pipeline(config_path: str, dry_run: bool=False, operation: str='pipeline', targets: str | None=None, continue_on_error: bool=True)
Run the secrets synchronization pipeline.
dry_run(config_path: str)
Perform a dry run to see what changes would be made.
get_config_info(config_path: str)
Get detailed information about a pipeline configuration.
get_targets(config_path: str)
Get the list of sync targets from a configuration.
get_sources(config_path: str)
Get the list of secret sources from a configuration.
vendor_fabric.slack
class SlackFallbackError
Fallback exception used until slack-sdk is imported.
class SlackAPIError
Slack API error wrapper.
get_divider()
Return a Slack divider block.
get_header_block(field_title: str)
Return header and divider blocks for a section title.
get_field_context_message_blocks(field_name: str, context_data: Mapping[str, Any])
Build header and context blocks for detailed field data.
get_key_value_blocks(k: str, v: Any)
Format a key/value pair into Slack section blocks.
get_rich_text_blocks(lines: list[str], bold: bool=False, italic: bool=False, strike: bool=False)
Build a rich text block for multiline messages.
class SlackConnector
Slack connector for messaging, directory, and channel management.
vendor_fabric.slack.tools
class ListChannelsSchema
Schema for listing Slack channels.
class ListUsersSchema
Schema for listing Slack users.
class SendMessageSchema
Schema for sending a Slack message.
class GetChannelHistorySchema
Schema for getting Slack channel history.
list_channels(exclude_archived: bool=True, channels_only: bool=True, limit: int=100)
List Slack channels.
list_users(include_bots: bool=False, include_deleted: bool=False, max_results: int=100)
List Slack users.
send_message(channel: str, text: str, thread_id: str='')
Send a message to a Slack channel.
get_channel_history(channel: str, limit: int=100)
Get recent messages from a Slack channel.
vendor_fabric.surface
connector_data_methods(connector_class: builtins.type[Any])
Return public connector methods that advertise Extended Data payloads.
is_connector_data_method(method: Any)
Return True when a callable belongs to the public data payload surface.
return_annotation(method: Callable[..., Any])
Resolve a callable return annotation without failing on optional imports.
annotation_includes_extended_payload(annotation: Any)
Return True when an annotation includes the ExtendedData payload contract.
vendor_fabric.vault
class VaultConnector
Vault connector with token and AppRole authentication.
vendor_fabric.vault.tools
class ListSecretsSchema
Schema for listing Vault secrets.
class ReadSecretSchema
Schema for reading a Vault secret.
list_secrets(root_path: str='/', mount_point: str='secret', max_depth: int | None=10)
List secrets recursively from Vault KV v2 engine.
read_secret(path: str, mount_point: str='secret')
Read a single secret from Vault.
vendor_fabric.vendor_data
class VendorCapability
A public VendorData operation routed to a provider connector method.
class VendorData
Extended Data facade with lazy vendor activation and capability dispatch.
vendor_fabric.zoom
class ZoomConnector
Zoom connector for user management.
vendor_fabric.zoom.tools
class ListUsersSchema
Pydantic schema for the zoom_list_users tool.
class GetUserSchema
Pydantic schema for the zoom_get_user tool.
class ListMeetingsSchema
Pydantic schema for the zoom_list_meetings tool.
class GetMeetingSchema
Pydantic schema for the zoom_get_meeting tool.
list_users(max_results: int=100)
List Zoom users.
get_user(user_id: str)
Get a specific Zoom user by ID or email.
list_meetings(user_id: str, meeting_type: str='scheduled', max_results: int=100)
List Zoom meetings for a specific user.
get_meeting(meeting_id: str)
Get details of a specific Zoom meeting.
