Skip to content
Proud to collaborate with Microsoft for Startups

data.ai-provider.get ​

Fetch one AIProviderConfig by UUID, scoped to the calling organization

Fetch a single AIProviderConfig by UUID, org-scoped.

Read-only — no DB mutations. Uses context.metadata["organization"] for the internal organization_id lookup; the public input is organization_uuid only.

Output shapes:

  • Found: found=True + all record fields
  • Not found: found=False (no other fields present; cross-org isolation upheld)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-connection
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization the request is scoped to
ai_provider_config_uuiduuidYes—UUID of the AIProviderConfig row to fetch

Output Schema ​

FieldTypeRequiredDefaultDescription
foundbooleanYes—True when the record exists and belongs to the org
ai_provider_config_uuiduuidNo—UUID of the fetched AIProviderConfig row (present only when found=True)
connection_uuiduuidNo—UUID of the linked CloudConnection (present only when found=True)
default_modelstringNo—Default model ID configured for this provider (e.g. 'gpt-4o-mini')
modelslistNo—User-supplied list of model IDs (e.g. for OpenRouter); None when unset
model_configdictNo—Model configuration dict: temperature, max_tokens, etc. None is normalized to {}
rate_limit_rpmintegerNo—Requests per minute rate limit; None means unlimited
rate_limit_tpmintegerNo—Tokens per minute rate limit; None means unlimited
is_defaultbooleanNo—Whether this is the org's default AI provider config
enabledbooleanNo—Whether this provider config is active
total_requestsintegerNo—Total number of AI requests made through this config
total_tokensintegerNo—Total tokens consumed (input + output)
total_cost_usdfloatNo—Total cost in USD; converted from Numeric for JSON safety
last_used_atstringNo—ISO-8601 timestamp of last usage; None when never used
failure_reasonstringNo—Engine-stamped: human-readable failure reason
failure_typestringNo—Engine-stamped: failure category
failed_actionstringNo—Engine-stamped: action method that raised
failed_at_statestringNo—Engine-stamped: state name when the failure occurred
failed_stepstringNo—Engine-stamped: name of the step that failed (DAG workflows)
failed_layerintegerNo—Engine-stamped: layer index that failed (DAG workflows)
errorstringNo—Engine-stamped: error message on the failure envelope
error_typestringNo—Engine-stamped: exception class name on the failure envelope

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeFetch AI provider config by UUID
completedNoYesYes—AI provider config fetched (or confirmed absent)
failedNoYesNo—Fetch failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.ai-provider.get",
  "initial_data": {
    "organization_uuid": "value",
    "ai_provider_config_uuid": "value"
  }
}