PanoptesClient reference¶

Generated from specs/panoptes.yaml, cross-referenced against vars_client.generated.panoptes. Regenerate with just docs-generate after just generate picks up spec changes -- do not hand-edit this file.

See also: data models.

auth¶

Exchange an API key for a JWT. Header format is Authorization: APIKEY <key>¶

POST /panoptes/v1/auth

result = await client.panoptes.panoptes.v1.auth.post()

Returns: Optional[AuthorizationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

health¶

Health check¶

GET /panoptes/v1/health

result = await client.panoptes.panoptes.v1.health.get()

Returns: Optional[HealthStatus]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

image¶

Resolve image location¶

GET /panoptes/v1/images/{camera_id}/{deployment_id}/{name}

result = await client.panoptes.panoptes.v1.images.by_camera_id(camera_id).by_deployment_id(deployment_id).by_name(name).get()

Returns: Optional[ImageParams]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Upload an image¶

POST /panoptes/v1/images/{camera_id}/{deployment_id}/{name}

# body: MultipartBody
result = await client.panoptes.panoptes.v1.images.by_camera_id(camera_id).by_deployment_id(deployment_id).by_name(name).post(body)

Returns: Optional[ImageParams]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError