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

# How an app can be connected

> The schemes this app supports and the fields each one asks for. Call it before POST /integrations/:app/connect: most apps need credentials of your own — an OAuth application you registered with the provider, or an API key — and this says which.



## OpenAPI

````yaml GET /v1/integrations/{app}/auth
openapi: 3.0.0
info:
  title: Devic.ai Public API
  description: >-
    Devic.ai is an AI platform that allows you to create, manage, and use AI
    agents for various tasks.
  version: 1.0.0
  contact:
    name: Devic.ai Support
    url: https://devic.ai
  x-logo:
    url: https://devic.ai/logo.png
    altText: Devic.ai Logo
  x-summary: Public API for interacting with Devic.ai platform
servers:
  - url: https://api.devic.ai
    description: Production server
  - url: https://staging-api.devic.ai
    description: Staging server
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Group agents, assistants, documents and costs into projects
  - name: Documents
    description: >-
      Knowledge base documents: create, version, attach and index markdown
      content for RAG
  - name: Document Folders
    description: Organise knowledge base documents into folders and attach them in bulk
  - name: Files
    description: Upload files and obtain shareable download URLs to attach to messages
  - name: Agents
    description: Endpoints related to AI agents and their operations
  - name: Assistants
    description: Endpoints for interacting with assistants and their specializations
  - name: Tool Servers
    description: Endpoints for managing tool servers and their tool definitions
  - name: Health
    description: API health check endpoints
  - name: Documentation
    description: Endpoints for retrieving markdown documentation
  - name: Integrations
    description: Connect third-party apps and turn them into tools
  - name: Triggers
    description: Start an agent or an assistant from an app event
  - name: Tenant Integrations
    description: Apps that each end user connects for themselves
  - name: Memory
    description: What an assistant remembers between conversations
  - name: Skills
    description: Reusable instruction packs for agents and assistants
  - name: Speech to Text
    description: Audio transcription
  - name: Tenants
    description: Tenants, subtenants and their usage
  - name: MCP Gateway
    description: One MCP endpoint over many servers, with visibility per user
  - name: Tenant Sessions
    description: Tokens that prove which end user is calling
paths:
  /v1/integrations/{app}/auth:
    get:
      tags:
        - Integrations
      summary: How an app can be connected
      description: >-
        The schemes this app supports and the fields each one asks for. Call it
        before POST /integrations/:app/connect: most apps need credentials of
        your own — an OAuth application you registered with the provider, or an
        API key — and this says which.
      operationId: getAppAuthSchemes
      parameters:
        - name: app
          required: true
          in: path
          description: App slug
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAuthDto'
        '401':
          description: Unauthorized - Invalid or missing token
        '429':
          description: Too Many Requests - Rate limit exceeded
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  schemas:
    IntegrationAuthDto:
      type: object
      properties:
        schemes:
          description: >-
            The ways this app can be connected. Empty when it needs no account
            at all
          type: array
          items:
            $ref: '#/components/schemas/AuthSchemeDto'
      required:
        - schemes
    AuthSchemeDto:
      type: object
      properties:
        mode:
          type: string
          description: The provider's own name for it
          example: API_KEY
        composioManaged:
          type: boolean
          description: >-
            The integration provider holds credentials for this app, so
            `appCredentials` can be omitted. False for most of the catalog
        redirect:
          type: boolean
          description: Connecting returns an authorizationUrl to open in a browser
        appFields:
          description: >-
            Credentials of your own application with the provider, registered
            once for the workspace. Empty when composioManaged
          type: array
          items:
            $ref: '#/components/schemas/AuthFieldDto'
        accountFields:
          description: >-
            What the account being connected supplies: its API key, its
            subdomain
          type: array
          items:
            $ref: '#/components/schemas/AuthFieldDto'
        guideUrl:
          type: string
          description: The provider's setup guide
      required:
        - mode
        - composioManaged
        - redirect
        - appFields
        - accountFields
    AuthFieldDto:
      type: object
      properties:
        name:
          type: string
          description: Send it under this name
          example: generic_api_key
        label:
          type: string
          description: Human-readable name
          example: API key
        type:
          type: string
          example: string
        required:
          type: boolean
        description:
          type: string
          description: The provider's own explanation
        default:
          type: string
          description: Prefilled value, when the provider suggests one
        secret:
          type: boolean
          description: 'Holds a credential: mask it on screen and keep it out of logs'
      required:
        - name
        - label
        - type
        - required
        - secret
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use JWT token for authentication

````