Skip to content
shiftagent Integration API
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Start Here
Integration Guide
Contracts
Provisioning Flow
Streaming Contract
Building Your Adapter
Adapter Implementation Guide
Runtime Architecture
API Reference
Overview
Tenants
Overview
Look up a tenant by external ID.
Upsert a tenant by external ID (the provisioning primitive).
Deprovision a tenant by external ID.
List tenants.
Create a tenant (plain create).
Retrieve a tenant.
Delete a tenant (guarded).
Update a tenant.
Repositories
Overview
List registered repositories.
Register a repository in the integration registry.
Retrieve a repository.
Delete a repository (guarded).
Update a repository.
Trigger a repository re-scan.
List a repository's skills.
Add a skill to a repository.
List repositories attached to a tenant.
Attach a repository to a tenant (idempotent).
Detach a repository from a tenant.
Credentials
Overview
List credentials (no secret material).
Register a credential (write-only secret).
Delete a credential (guarded).
Roles
Overview
List a tenant's roles.
Create a role in a tenant.
Retrieve a role.
Delete a role (guarded).
Update a role.
List a role's resolved effective skills.
Users
Overview
Look up a user by external ID.
Upsert a user by external ID.
List a tenant's users.
List users across all tenants.
Retrieve a user.
Deactivate a user (soft).
Update a user.
List a user's assigned roles.
Assign a role to a user (idempotent).
Unassign a role from a user (idempotent).
List a user's effective skills with provenance.
Conversations
Overview
List conversations by user or by tenant.
Start a conversation.
Retrieve a conversation.
Archive a conversation (soft).
Update a conversation.
List a conversation's messages (history).
Send a message and stream the agent's reply.
List vaulted secret aliases (never values).
Upsert conversation-scoped secrets (write-only).
Delete a vaulted secret by alias.
Approvals
Overview
List approvals.
Retrieve an approval.
Approve (signed assertion required).
Deny (signed assertion required).
Auth
Overview
Exchange external IDs for a platform JWT.
System
Overview
Health check (unauthenticated).
Sandbox pool capacity.
Introspect the integration key.
Select theme
Dark
Light
Auto
Overview
System
Section titled “System”
Health, sandbox-pool capacity, and integration-key introspection.
Operations
Section titled “ Operations ”
GET
/health
GET
/capacity
GET
/integration/self