docs
Get startedTroubleshootingPaymentsWebhooksAgent paymentsSwop MCPOviIdentity (swop.id)SwivyRPC (preview)API reference
API reference

Control plane

Current Swivy API operations from the deployed OpenAPI snapshot.

Testnet preview

Staging uses software custody. Use your environment’s API base URL and test assets only.

33 operations from the November 1, 2026 deployed contract. Full OpenAPI schema · Live interactive reference.

List chain capabilities

GET/v1/control/chains/capabilities

Auth: No operation-level credentials specified; deployment and policy restrictions still apply.

Responses: 200 Capabilities

Get signer infrastructure status

GET/v1/control/infrastructure/signer

Auth: x-swivy-admin-key or x-admin-token

Responses: 200 Signer status · 401 Invalid or missing admin token

Create an organization

POST/v1/control/organizations

Auth: x-admin-token

Request body: required. Organization payload

Content type: application/json.

FieldTypeRequiredDescription
namestringYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created organization and issued its initial owner credential · 401 Invalid or missing admin token

Create a project

POST/v1/control/organizations/{organizationId}/projects

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Request body: required. Project payload

Content type: application/json.

FieldTypeRequiredDescription
namestringYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created project · 401 Invalid or missing admin token

Rename a project

PATCH/v1/control/projects/{projectId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
projectIdpathYesProject identifier

Request body: required. Project payload

Content type: application/json.

FieldTypeRequiredDescription
namestringYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Updated project · 401 Invalid or missing control-plane credential · 404 Project not found · 409 Project slug already exists in this organization

Create an environment and issue its first credential pair

POST/v1/control/projects/{projectId}/environments

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
projectIdpathYesProject identifier

Request body: required. Environment payload

Content type: application/json.

FieldTypeRequiredDescription
namestringYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created environment · 401 Invalid or missing admin token

Rename an environment

PATCH/v1/control/environments/{environmentId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Request body: required. Environment payload

Content type: application/json.

FieldTypeRequiredDescription
namestringYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Updated environment · 401 Invalid or missing control-plane credential · 404 Environment not found · 409 Environment slug already exists in this project

List environment credentials

GET/v1/control/environments/{environmentId}/credentials

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Responses: 200 Credential list · 401 Invalid or missing admin token

Rotate or create a new environment credential pair

POST/v1/control/environments/{environmentId}/credentials

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Request body: optional. Credential creation payload

Content type: application/json.

FieldTypeRequiredDescription
labelstringNo

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created environment credential · 401 Invalid or missing admin token · 404 Environment not found

Revoke an environment credential pair

DELETE/v1/control/environments/{environmentId}/credentials/{credentialId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier
credentialIdpathYesCredential identifier

Responses: 200 Credential revoked · 401 Invalid or missing admin token · 404 Credential not found

Get organization overview

GET/v1/control/organizations/{organizationId}/overview

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Responses: 200 Organization overview · 401 Invalid or missing control-plane credential · 404 Organization not found

List organization admin credentials

GET/v1/control/organizations/{organizationId}/admin-credentials

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Responses: 200 Organization admin credential list · 401 Invalid or missing control-plane credential · 403 Credential is outside this organization or lacks read access · 404 Organization not found

Create an organization admin credential

POST/v1/control/organizations/{organizationId}/admin-credentials

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Request body: optional. Organization admin credential payload

Content type: application/json.

FieldTypeRequiredDescription
labelstringNo
roleobjectNo

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created organization admin credential · 401 Invalid or missing control-plane credential · 403 Credential lacks owner access for this organization · 404 Organization not found

List organization members

GET/v1/control/organizations/{organizationId}/members

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Responses: 200 Organization member list · 401 Invalid or missing control-plane credential · 403 Credential is outside this organization or lacks read access · 404 Organization not found

Update an organization member role and sync their active admin credentials

PATCH/v1/control/organizations/{organizationId}/members/{memberId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier
memberIdpathYesOrganization member identifier

Request body: required. Organization member role payload

Content type: application/json.

FieldTypeRequiredDescription
rolestringYesAllowed: owner, admin, developer, viewer

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Organization member updated · 401 Invalid or missing control-plane credential · 403 Credential lacks owner access for this organization · 404 Organization or member not found · 409 Update would remove the last active owner credential

Revoke an organization member and deactivate their admin credentials

DELETE/v1/control/organizations/{organizationId}/members/{memberId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier
memberIdpathYesOrganization member identifier

Responses: 200 Organization member revoked · 401 Invalid or missing control-plane credential · 403 Credential lacks owner access for this organization · 404 Organization or member not found · 409 Revocation would remove the last active owner credential

List organization invites

GET/v1/control/organizations/{organizationId}/invites

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Responses: 200 Organization invite list · 401 Invalid or missing control-plane credential · 403 Credential is outside this organization or lacks read access · 404 Organization not found

Create an organization invite

POST/v1/control/organizations/{organizationId}/invites

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier

Request body: required. Organization invite payload

Content type: application/json.

FieldTypeRequiredDescription
emailstringYes
roleobjectNo
expiresInHoursintegerNo

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created organization invite · 401 Invalid or missing control-plane credential · 403 Credential lacks owner access for this organization · 404 Organization not found

Revoke an organization invite

DELETE/v1/control/organizations/{organizationId}/invites/{inviteId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier
inviteIdpathYesOrganization invite identifier

Responses: 200 Organization invite revoked · 401 Invalid or missing control-plane credential · 403 Credential lacks owner access for this organization · 404 Organization or invite not found

Revoke an organization admin credential

DELETE/v1/control/organizations/{organizationId}/admin-credentials/{credentialId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
organizationIdpathYesOrganization identifier
credentialIdpathYesOrganization admin credential identifier

Responses: 200 Organization admin credential revoked · 401 Invalid or missing control-plane credential · 403 Credential lacks owner access for this organization · 404 Organization or credential not found · 409 Revocation would remove the last active owner credential

Accept an organization invite and mint an org-scoped admin credential

POST/v1/control/organization-invites/{inviteId}/accept

Auth: No operation-level credentials specified; deployment and policy restrictions still apply.

ParameterLocationRequiredDescription
inviteIdpathYesOrganization invite identifier

Request body: required. Organization invite acceptance payload

Content type: application/json.

FieldTypeRequiredDescription
tokenstringYes
namestringNo
labelstringNo

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Accepted organization invite · 404 Invite not found · 409 Invite expired, already used, or member already exists

Replace environment policy

PUT/v1/control/environments/{environmentId}/policy

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Request body: required. Environment policy

Content type: application/json.

FieldTypeRequiredDescription
loginPolicyobjectNo
allowedChainsarrayYes
exportPolicyobjectYes
signingPolicyobjectYes
executionPolicyobjectYes
walletToolPolicyobjectNo
walletPolicyobjectYes
serverWalletPolicyobjectNoWhen requireAuthorizationKey is true (the default), server wallets need an Ed25519 authorization key and every intent must be signed with it.
offlineSigningPolicyobjectNo
blockchainDataPolicyobjectNo
rpcProviderPolicyobjectNo
sessionPolicyobjectYes
recoveryPolicyobjectYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Updated environment policy · 401 Invalid or missing admin token

Get environment dashboard snapshot

GET/v1/control/environments/{environmentId}/dashboard

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Responses: 200 Environment dashboard · 401 Invalid or missing admin token · 404 Environment not found

List environment RPC targets

GET/v1/control/environments/{environmentId}/chains

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Responses: 200 Environment RPC targets · 401 Invalid or missing admin token

Create or update an environment RPC target

PUT/v1/control/environments/{environmentId}/chains/{chain}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier
chainpathYesChain family

Request body: required. Chain RPC target configuration

Content type: application/json.

FieldTypeRequiredDescription
networkstringNo
rpcUrlstringYes
wsUrlanyOfNo
headersarrayNo
commitmentanyOfNo
skipPreflightbooleanNo
maxRetriesanyOfNo
enabledbooleanNo

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Updated environment RPC target · 401 Invalid or missing admin token

Create a webhook endpoint

POST/v1/control/environments/{environmentId}/webhooks

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Request body: required. Webhook target

Content type: application/json.

FieldTypeRequiredDescription
urlstringYes

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created webhook · 401 Invalid or missing admin token

List webhooks

GET/v1/control/environments/{environmentId}/webhooks

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Responses: 200 Webhook list · 401 Invalid or missing admin token

Rotate a webhook signing secret

POST/v1/control/environments/{environmentId}/webhooks/{webhookId}/rotate-secret

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier
webhookIdpathYesWebhook identifier

Responses: 200 Rotated webhook secret · 401 Invalid or missing admin token · 404 Webhook not found

Revoke a webhook endpoint

DELETE/v1/control/environments/{environmentId}/webhooks/{webhookId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier
webhookIdpathYesWebhook identifier

Responses: 200 Revoked webhook · 401 Invalid or missing admin token · 404 Webhook not found

List environment audit logs

GET/v1/control/environments/{environmentId}/audit

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Responses: 200 Audit logs · 401 Invalid or missing admin token

List OIDC clients for an environment

GET/v1/control/environments/{environmentId}/oidc-clients

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Responses: 200 OIDC client list · 401 Invalid or missing control-plane credential · 404 Environment not found

Create an OIDC client for Sign in with Swop

POST/v1/control/environments/{environmentId}/oidc-clients

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier

Request body: required. OIDC client payload

Content type: application/json.

FieldTypeRequiredDescription
namestringYes
redirectUrisarrayYes
scopesarrayNo
grantTypesarrayNo
tokenEndpointAuthMethodstringNoAllowed: none, client_secret_post, client_secret_basic
applicationTypestringNoAllowed: web, spa, native
brandColorstringNo
logoUrlstringNo
authMethodsobjectNo

Nested schemas and constraints are in the OpenAPI document.

Responses: 200 Created OIDC client · 401 Invalid or missing control-plane credential · 404 Environment not found

Revoke an OIDC client

DELETE/v1/control/environments/{environmentId}/oidc-clients/{clientId}

Auth: x-swivy-admin-key or x-admin-token

ParameterLocationRequiredDescription
environmentIdpathYesEnvironment identifier
clientIdpathYesOIDC client identifier

Responses: 200 OIDC client revoked · 401 Invalid or missing control-plane credential · 404 Environment or OIDC client not found

On this page