Skip to content

Recover a Workspace Connection create

GET
/api/app/{app_slug}/workflow/connections/recovery/{mutation_id}/
curl --request GET \
--url https://api.agentaab.com/api/app/example/workflow/connections/recovery/example/ \
--header 'Authorization: Bearer <token>'

Look up the committed result of an earlier idempotent create without creating or mutating a Connection.

app_slug
required
string
mutation_id
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$/

The exact Idempotency-Key from the original create.

The previously created redacted Connection summary.

Media typeapplication/json
object
connection
required

Redacted Workspace Connection state. It contains a server-managed reference and sanitized capabilities, never private credential material.

object
id
required
string
credential_ref
required

Opaque server-managed reference used by materialized v1 Tool bindings.

string
/^WORKSPACE_CONNECTION_[A-F0-9]{32}$/
scope
required
object
kind
required
string
Allowed values: creator organization
id
required
string
provider
required
string
Allowed values: web_search mcp
display_name
required
string
endpoint
required
string format: uri
nullable
configuration
required

Bounded provider configuration with credential-shaped fields forbidden.

object
key
additional properties
any
credential_mode
required
string
Allowed values: bearer x_api_key
cached_capabilities
required

Sanitized bounded capability marker or MCP Tool manifest from the last successful test.

object
key
additional properties
any
status
required
string
Allowed values: active error deleted
last_tested_at
required
string format: date-time
nullable
last_error_code
required
string
nullable
Allowed values: workspace_connection_test_required workspace_connection_auth_unavailable workspace_connection_provider_unavailable
created_at
required
string format: date-time
updated_at
required
string format: date-time
rotated_at
required
string format: date-time
nullable
deleted_at
required
string format: date-time
nullable
Example
{
"connection": {
"scope": {
"kind": "creator"
},
"provider": "web_search",
"credential_mode": "bearer",
"status": "active",
"last_error_code": "workspace_connection_test_required"
}
}

The mutation identifier is invalid.

Media typeapplication/json
object
error
required
string
code
required

Stable public-safe Workspace Connection error identifier.

string
Allowed values: workspace_connection_failed workspace_connection_invalid workspace_connection_unavailable workspace_connection_conflict workspace_connection_capacity_exceeded workspace_connection_encryption_unavailable workspace_connection_decryption_failed workspace_connection_store_unavailable workspace_connection_mutations_disabled workspace_connection_payload_too_large workspace_connection_creation_not_found workspace_connection_test_failed workspace_connection_test_state_unavailable
Example
{
"code": "workspace_connection_failed"
}

The creator session is missing, invalid, expired, or does not have a verified email.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: creator_session_required creator_email_unverified creator_session_invalid creator_session_expired
Example
{
"code": "creator_session_required"
}

A public Agent Business runtime credential cannot access creator control-plane APIs.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: runtime_token_not_allowed
Example
{
"code": "runtime_token_not_allowed"
}

No committed create is visible for this mutation identifier, or the Workflow is unavailable.

Media typeapplication/json
One of:
object
error
required
string
code
required

Stable public-safe Workspace Connection error identifier.

string
Allowed values: workspace_connection_failed workspace_connection_invalid workspace_connection_unavailable workspace_connection_conflict workspace_connection_capacity_exceeded workspace_connection_encryption_unavailable workspace_connection_decryption_failed workspace_connection_store_unavailable workspace_connection_mutations_disabled workspace_connection_payload_too_large workspace_connection_creation_not_found workspace_connection_test_failed workspace_connection_test_state_unavailable
Example
{
"code": "workspace_connection_failed"
}

The Agent Business is not a Workflow, or the creator identity conflicts with an existing binding.

Media typeapplication/json
One of:
object
error
required
string
code
required
string
Allowed values: application_not_workflow
Example
{
"code": "application_not_workflow"
}

An unexpected Workspace Connection failure was sanitized before returning it.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: workspace_connection_failed
Example
{
"code": "workspace_connection_failed"
}

The configured creator identity service failed while verifying the session.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: creator_session_verification_failed
Example
{
"code": "creator_session_verification_failed"
}

Creator auth, control-plane storage, or authoritative Connection storage is unavailable.

Media typeapplication/json
One of:
object
error
required
string
code
required
string
Allowed values: creator_auth_provider_invalid creator_session_not_configured creator_control_storage_not_configured
Example
{
"code": "creator_auth_provider_invalid"
}