> ## Documentation Index > Fetch the complete documentation index at: https://docs.useanima.sh/llms.txt > Use this file to discover all available pages before exploring further. # Post vaultoauthrequire auth ## OpenAPI ````yaml /openapi.json post /vault/oauth/require-auth openapi: 3.1.1 info: title: Anima API version: 0.1.0 description: >- The Anima API provides programmatic access to unified infrastructure for AI agents: create and manage agents; send and receive email; place phone calls and send/receive SMS and voice; store and retrieve vault credentials; manage agent identity; and configure webhooks for real-time events. Authenticate using a Bearer token or an API key passed via the X-API-Key header. contact: name: Anima Labs url: https://useanima.sh email: support@useanima.sh license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.useanima.sh/v1 description: Production security: - BearerAuth: [] - ApiKeyAuth: [] tags: - name: Agents description: Create and manage AI agents with email and phone capabilities - name: Inboxes description: Manage email inboxes and their configurations - name: Messages description: Send, receive, and search email messages - name: Webhooks description: Register and manage webhook subscriptions for real-time events - name: Organizations description: Manage organizations and team settings - name: Domains description: Configure and verify custom email domains - name: Phone description: Manage phone numbers and SMS/voice capabilities - name: Invoices description: Track invoices, match receipts, and reconcile payments - name: Billing description: View usage, tiers, and billing information - name: Security description: Configure security policies and access controls - name: Vault description: Store and retrieve encrypted secrets - name: API Keys description: Create and manage API keys for programmatic access paths: /vault/oauth/require-auth: post: operationId: vault.oauthRequireAuth requestBody: required: true content: application/json: schema: type: object properties: agentId: anyOf: - type: string pattern: ^[0-9a-z]+$ - type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ description: >- Agent identifier. Optional when using an agent API key (resolved automatically); required when using a master key. userId: type: string description: End-user ID for multi-tenant scoping appSlug: type: string description: App slug to check authentication for required: - appSlug description: >- Input for checking if a service is authenticated and getting a Connect Link if not responses: '200': description: OK content: application/json: schema: type: object properties: authenticated: type: boolean description: Whether the service is currently authenticated connectedAccount: anyOf: - type: object properties: id: type: string description: Unique connected account identifier agentId: type: string description: Agent that owns this connection userId: anyOf: - type: string - type: 'null' description: End-user this connection belongs to (multi-tenant) appDefinitionId: type: string description: OAuth app definition ID appSlug: type: string description: App slug for easy reference appName: type: string description: Human-readable app name appIconUrl: anyOf: - type: string - type: 'null' description: App icon URL customAppId: anyOf: - type: string - type: 'null' description: Custom OAuth app ID (if BYOA) grantedScopes: type: array items: type: string description: Scopes granted by the user accountLabel: anyOf: - type: string - type: 'null' description: User-defined label for this connection accountEmail: anyOf: - type: string - type: 'null' description: Account email from the provider status: enum: - PENDING - ACTIVE - EXPIRED - REFRESHING - FAILED - REVOKED type: string description: Connection status statusMessage: anyOf: - type: string - type: 'null' description: Error message if status is FAILED tokenExpiresAt: anyOf: - type: string format: date-time - type: 'null' description: When the access token expires lastRefreshedAt: anyOf: - type: string format: date-time - type: 'null' description: When the token was last refreshed createdAt: type: string format: date-time description: When the connection was established updatedAt: type: string format: date-time description: When the connection was last updated required: - id - agentId - userId - appDefinitionId - appSlug - appName - appIconUrl - customAppId - grantedScopes - accountLabel - accountEmail - status - statusMessage - tokenExpiresAt - lastRefreshedAt - createdAt - updatedAt description: Connected OAuth account details - type: 'null' description: Connected account details (if authenticated) connectLinkUrl: anyOf: - type: string - type: 'null' description: Connect Link URL to authenticate (if not authenticated) required: - authenticated - connectedAccount - connectLinkUrl description: Authentication status and Connect Link for a service components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer ApiKeyAuth: type: apiKey in: header name: X-API-Key description: 'API key for programmatic access. Pass as: X-API-Key: ' ````