App Manifest

The manifest for your Modus app allows you to configure the exposure and resources for your functions at runtime. You define the manifest in the modus.json file within the root of directory of your app.

​

Structure

​

Base manifest

A simple manifest, which exposes a single GraphQL endpoint with a bearer token for authentication, looks like this:

{
  "$schema": "https://schema.hypermode.com/modus.json",
  "endpoints": {
    "default": {
      "type": "graphql",
      "path": "/graphql",
      "auth": "bearer-token"
    }
  }
}

​

Endpoints

Endpoints make your functions available outside of your Modus app. The endpoints object in the app manifest allows you to define these endpoints for integration into your frontend or federated API.

Each endpoint requires a unique name, specified as a key containing only alphanumeric characters and hyphens.

​

GraphQL endpoint

This endpoint type supports the GraphQL protocol to communicate with external clients. You can use a GraphQL client, such as urql or Apollo Client, to interact with the endpoint.

Example:

{
  "endpoints": {
    "default": {
      "type": "graphql",
      "path": "/graphql",
      "auth": "bearer-token"
    }
  }
}

​

Connections

Connections establish connectivity and access to external services. They’re used for HTTP and GraphQL APIs, database connections, and externally hosted AI models. The connections object in the app manifest allows you to define these hosts, for secure access from within a function.

Each connection requires a unique name, specified as a key containing only alphanumeric characters and hyphens.

Each connection has a type property, which controls how it’s used and which additional properties are available. The following table lists the available connection types:

​

HTTP connection

This connection type supports the HTTP and HTTPS protocols to communicate with external hosts. You can use the HTTP APIs in the Modus SDK to interact with the host.

This connection type is also used for GraphQL APIs and to invoke externally hosted AI models.

Example:

{
  "connections": {
    "openai": {
      "type": "http",
      "baseUrl": "https://api.openai.com/",
      "headers": {
        "Authorization": "Bearer {{API_KEY}}"
      }
    }
  }
}

​

Dgraph connection

This connection type supports connecting to Dgraph databases. You can use the Dgraph APIs in the Modus SDK to interact with the database.

There are two ways to connect to Dgraph:

• Using a connection string (preferred method)
• Using a gRPC target (older method)

You can use either approach in Modus, but not both.

​

Using a Dgraph connection string

This is the preferred method for connecting to Dgraph. It uses a simplified URI based connection string to specify all options, including host, port, options, and authentication.

Example:

{
  "connections": {
    "my-dgraph": {
      "type": "dgraph",
      "connString": "dgraph://example.hypermode.host:443?sslmode=verify-ca&bearertoken={{DGRAPH_API_KEY}}"
    }
  }
}

​

Using a Dgraph gRPC target

This is the older method for connecting to Dgraph. It uses a gRPC target to specify the host and port, and a separate key for authentication. It automatically uses SSL mode (with full CA verification) for the connection - except when connecting to localhost.

Additional options such as username/password authentication aren’t supported. If you need to use these options, use the connection string method instead.

Example:

{
  "connections": {
    "my-dgraph": {
      "type": "dgraph",
      "grpcTarget": "example.grpc.region.aws.cloud.dgraph.io:443",
      "key": "{{DGRAPH_API_KEY}}"
    }
  }
}

​

MySQL connection

This connection type supports connecting to MySQL databases. You can use the MySQL APIs in the Modus SDK to interact with the database.

Example:

{
  "connections": {
    "my-database": {
      "type": "mysql",
      "connString": "mysql://{{USERNAME}}:{{PASSWORD}}@db.example.com:3306/dbname?tls=true"
    }
  }
}

​

Neo4j connection

This connection type supports connecting to Neo4j databases. You can use the Neo4j APIs in the Modus SDK to interact with the database.

Example:

{
  "connections": {
    "my-neo4j": {
      "type": "neo4j",
      "dbUri": "bolt://localhost:7687",
      "username": "neo4j",
      "password": "{{NEO4J_PASSWORD}}"
    }
  }
}

​

PostgreSQL connection

This connection type supports connecting to PostgreSQL databases. You can use the PostgreSQL APIs in the Modus SDK to interact with the database.

Example:

{
  "connections": {
    "my-database": {
      "type": "postgresql",
      "connString": "postgresql://{{PG_USER}}:{{PG_PASSWORD}}@db.example.com:5432/data?sslmode=require"
    }
  }
}

​

Models

AI models are a core resource for inferencing. The models object in the app manifest allows you to easily define models, whether hosted by Hypermode or another host.

Each model requires a unique name, specified as a key, containing only alphanumeric characters and hyphens.

{
  "models": {
    "text-generator": {
      "sourceModel": "meta-llama/Llama-3.2-3B-Instruct",
      "provider": "hugging-face",
      "connection": "hypermode"
    }
  }
}