Modal

Modal Workspaces API

Modal workspaces.

Documentation GitHub OpenAPI

Documentation

https://modal.com/docs/guide/apps

https://modal.com/docs/reference/modal.Function

https://modal.com/docs/reference/modal.App

https://modal.com/docs/guide/sandboxes

https://modal.com/docs/reference/modal.Sandbox

https://modal.com/docs/guide/volumes

https://modal.com/docs/reference/modal.Volume

https://modal.com/docs/guide/images

https://modal.com/docs/reference/modal.Image

https://modal.com/docs/guide/secrets

https://modal.com/docs/reference/modal.Secret

https://modal.com/docs/guide/dicts

https://modal.com/docs/guide/queues

https://modal.com/docs/reference/modal.Dict

https://modal.com/docs/reference/modal.Queue

https://modal.com/docs/guide/cron

https://modal.com/docs/guide/webhooks

https://modal.com/docs/guide/webhook-urls

https://modal.com/docs/guide/webhook-proxy-auth

https://modal.com/docs/reference/cli/token

https://modal.com/docs/reference/cli/profile

https://modal.com/docs/guide/environments

Specifications

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

Schemas & Data

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

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

Other Resources

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

OpenAPI Specification

openapi: 3.1.0
info:
  title: Modal Dicts and Queues Apps Workspaces 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: Workspaces
  description: Modal workspaces.
paths:
  /workspaces/current:
    get:
      tags:
      - Workspaces
      summary: Get Current Workspace
      operationId: getCurrentWorkspace
      responses:
        '200':
          description: The current workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
components:
  schemas:
    Workspace:
      type: object
      properties:
        workspace_id:
          type: string
        slug:
          type: string
        name:
          type: string
        plan:
          type: string
          enum:
          - starter
          - team
          - enterprise
  securitySchemes:
    ModalToken:
      type: http
      scheme: bearer