Modal

Modal WebEndpoints API

HTTP/ASGI/WSGI web endpoints backed by Modal Functions.

GitHub OpenAPI

Operations 3

GET /web-endpoints List Web Endpoints #
GET /web-endpoints/{endpoint_id} Get Web Endpoint #
PUT /web-endpoints/{endpoint_id}/labels Set Web Endpoint Custom URL Label #

Documentation

📖
Documentation
https://modal.com/docs/guide/apps
📖
Documentation
https://modal.com/docs/reference/modal.Function
📖
Documentation
https://modal.com/docs/reference/modal.App
📖
Documentation
https://modal.com/docs/guide/sandboxes
📖
Documentation
https://modal.com/docs/reference/modal.Sandbox
📖
Documentation
https://modal.com/docs/guide/volumes
📖
Documentation
https://modal.com/docs/reference/modal.Volume
📖
Documentation
https://modal.com/docs/guide/images
📖
Documentation
https://modal.com/docs/reference/modal.Image
📖
Documentation
https://modal.com/docs/guide/secrets
📖
Documentation
https://modal.com/docs/reference/modal.Secret
📖
Documentation
https://modal.com/docs/guide/dicts
📖
Documentation
https://modal.com/docs/guide/queues
📖
Documentation
https://modal.com/docs/reference/modal.Dict
📖
Documentation
https://modal.com/docs/reference/modal.Queue
📖
Documentation
https://modal.com/docs/guide/cron
📖
Documentation
https://modal.com/docs/guide/webhooks
📖
Documentation
https://modal.com/docs/guide/webhook-urls
📖
Documentation
https://modal.com/docs/guide/webhook-proxy-auth
📖
Documentation
https://modal.com/docs/reference/cli/token
📖
Documentation
https://modal.com/docs/reference/cli/profile
📖
Documentation
https://modal.com/docs/guide/environments

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/modal-com/refs/heads/main/openapi/modal-com-webendpoints-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/modal-com/refs/heads/main/json-schema/modal-function-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/modal-com/refs/heads/main/json-schema/modal-sandbox-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/modal-com/refs/heads/main/json-ld/modal-com-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/modal-com-webendpoints-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

modal-com-webendpoints-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Modal Dicts and Queues Apps Web Endpoints API
  description: 'Modal Dicts and Queues — distributed in-memory primitives for

    cross-container state. Dicts are key-value stores; Queues are FIFO

    message queues used to coordinate work across Modal functions and

    sandboxes.

    '
  version: 0.1.0
  contact:
    name: Modal Labs
    url: https://modal.com
servers:
- url: https://api.modal.com/v1
security:
- ModalToken: []
tags:
- name: WebEndpoints
  description: HTTP/ASGI/WSGI web endpoints backed by Modal Functions.
paths:
  /web-endpoints:
    get:
      tags:
      - WebEndpoints
      summary: List Web Endpoints
      operationId: listWebEndpoints
      responses:
        '200':
          description: A page of web endpoints.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebEndpoint'
  /web-endpoints/{endpoint_id}:
    get:
      tags:
      - WebEndpoints
      summary: Get Web Endpoint
      operationId: getWebEndpoint
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The web endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebEndpoint'
  /web-endpoints/{endpoint_id}/labels:
    put:
      tags:
      - WebEndpoints
      summary: Set Web Endpoint Custom URL Label
      operationId: setWebEndpointLabel
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
      responses:
        '204':
          description: Label set.
components:
  schemas:
    WebEndpoint:
      type: object
      properties:
        endpoint_id:
          type: string
        function_id:
          type: string
        kind:
          type: string
          enum:
          - fastapi_endpoint
          - asgi_app
          - wsgi_app
          - web_server
        url:
          type: string
          format: uri
        custom_label:
          type: string
        auth:
          type: string
          enum:
          - none
          - proxy_token
          - bearer
          - custom
        methods:
          type: array
          items:
            type: string
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ModalToken:
      type: http
      scheme: bearer