Skip to main content
Ctrl+K

PyAntz 2.0.3 documentation

Guide:

  • Getting started
  • Writing jobs
  • Job library

API reference:

  • pyantz package
    • pyantz.api package
      • pyantz.api.endpoints package
        • pyantz.api.endpoints.get_jobs package
        • pyantz.api.endpoints.get_parameters package
        • pyantz.api.endpoints.pipelines package
    • pyantz.infrastructure package
      • pyantz.infrastructure.config package
        • pyantz.infrastructure.config.parameters package
        • pyantz.infrastructure.config.runners package
        • pyantz.infrastructure.config.variables package
      • pyantz.infrastructure.distributed_queue package
        • pyantz.infrastructure.distributed_queue.common package
        • pyantz.infrastructure.distributed_queue.sql package
      • pyantz.infrastructure.runner package
        • pyantz.infrastructure.runner._remotes package
        • pyantz.infrastructure.runner.local package
        • pyantz.infrastructure.runner.slurm package
      • pyantz.infrastructure.virtual package
    • pyantz.jobs package
      • pyantz.jobs.analysis package
      • pyantz.jobs.branching package
      • pyantz.jobs.files package
      • pyantz.jobs.subproc package
      • pyantz.jobs.testing package
      • pyantz.jobs.wrappers package
    • pyantz.virtual package
  • .rst

pyantz.api.endpoints package

Contents

  • Subpackages
  • Module contents
    • router

pyantz.api.endpoints package#

Subpackages#

  • pyantz.api.endpoints.get_jobs package
    • Submodules
    • pyantz.api.endpoints.get_jobs.endpoint module
    • pyantz.api.endpoints.get_jobs.models module
    • Module contents
  • pyantz.api.endpoints.get_parameters package
    • Submodules
    • pyantz.api.endpoints.get_parameters.endpoints module
    • pyantz.api.endpoints.get_parameters.models module
    • Module contents
  • pyantz.api.endpoints.pipelines package
    • Submodules
    • pyantz.api.endpoints.pipelines.endpoints module
    • pyantz.api.endpoints.pipelines.models module
    • Module contents

Module contents#

The API endpoints.

router = <fastapi.routing.APIRouter object>#

Every endpoint of the api, under /api/v1.0.

Parameters:
  • scope (Scope)

  • receive (Receive)

  • send (Send)

Return type:

None

previous

pyantz.api package

next

pyantz.api.endpoints.get_jobs package

Contents
  • Subpackages
  • Module contents
    • router

By Ian Green

© Copyright 2026, Ian Green.