> ## Documentation Index
> Fetch the complete documentation index at: https://vida.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install agent app

> Installs an app for the selected account. Inspect the app first and provide the app settings or authentication values its manifest requires.



## OpenAPI

````yaml post /api/v2/apps/{appId}/{appVersion}
openapi: 3.0.0
info:
  version: 2.0.0
  title: Vida API
  description: Vida API Documentation
servers:
  - url: https://api.vida.dev
    description: Vida Production
    variables:
      baseUrl:
        default: api.vida.dev
        description: Production API Root
security: []
tags:
  - name: Agents
  - name: Inbound Email
    description: Control which senders may create inbound email work for an Agent.
  - name: Features
    description: Inspect capabilities available within an account hierarchy.
  - name: Conversation Logs
    description: Query conversation activity and calculate account-level metrics.
  - name: Computer Agents
    description: Set up, configure, inspect, and manage Vida Computer Agents.
  - name: Computer Agent Sessions
    description: View and reset Computer Agent sessions.
  - name: Accounts
  - name: Agent Templates
    description: Create, manage, and apply reusable Agent configurations.
paths:
  /api/v2/apps/{appId}/{appVersion}:
    post:
      tags:
        - Apps
      summary: Install agent app
      description: >-
        Installs an app for the selected account. Inspect the app first and
        provide the app settings or authentication values its manifest requires.
      parameters:
        - name: appId
          in: path
          required: true
          schema:
            type: string
          description: ID of the application
          example: acme
        - name: appVersion
          in: path
          required: true
          schema:
            type: string
          description: Version of the application (defaults to v1)
          example: v1
        - name: targetAccountId
          in: query
          description: Account where the app should be installed.
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                app:
                  type: object
                  description: Application manifest data to install
                  example:
                    name: Acme App
                    version: v1
      responses:
        '201':
          description: Successfully installed the app
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  app:
                    $ref: '#/components/schemas/AgentAppManifest'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Unauthorized
        '500':
          description: Failed to install the app
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Failed to install the app
                  error:
                    type: string
                    example: Error details
      security:
        - apiKeyAuth: []
components:
  schemas:
    AgentAppManifest:
      type: object
      description: Agent app metadata and account-specific setup state.
      properties:
        appId:
          type: string
          description: Stable app identifier.
        version:
          type: string
          description: App version.
        title:
          type: string
          description: Display name.
        description:
          type: string
          description: What the app enables.
        installed:
          type: boolean
          readOnly: true
          description: Whether this app is installed for the selected account.
        active:
          type: boolean
          readOnly: true
          description: Whether required setup is complete and the app can be used.
        dependencies:
          type: object
          additionalProperties: true
          description: >-
            Authentication and configuration requirements. Required properties
            include their current account-specific values when available.
      additionalProperties: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: query
      name: token
      description: Vida API Token

````