# Archetype AI Documentation

## Docs

- [List Job Events](https://docs.archetypeai.app/api-reference/batch/events/list-job-events.md): Retrieve a paginated list of events for a specific job
- [List Inputs](https://docs.archetypeai.app/api-reference/batch/io/list-inputs.md): Retrieve a paginated list of inputs for a specific job
- [List Outputs](https://docs.archetypeai.app/api-reference/batch/io/list-outputs.md): Retrieve a paginated list of outputs for a specific job
- [Cancel Job](https://docs.archetypeai.app/api-reference/batch/jobs/cancel-job.md): Cancel a running or pending job
- [Create Job](https://docs.archetypeai.app/api-reference/batch/jobs/create-job.md): Create a new batch or training job
- [Delete Job](https://docs.archetypeai.app/api-reference/batch/jobs/delete-job.md): Permanently delete a job and its associated data
- [Get Job](https://docs.archetypeai.app/api-reference/batch/jobs/get-job.md): Retrieve details of a specific job by ID
- [Get Queue Depths](https://docs.archetypeai.app/api-reference/batch/jobs/get-queue-depths.md): Retrieve global queue depths grouped by pipeline type
- [List Jobs](https://docs.archetypeai.app/api-reference/batch/jobs/list-jobs.md): Retrieve a paginated list of jobs with optional filters
- [Retry Job](https://docs.archetypeai.app/api-reference/batch/jobs/retry-job.md): Retry a failed or cancelled job
- [List Job Progress](https://docs.archetypeai.app/api-reference/batch/progress/list-job-progress.md): Retrieve paginated progress entries for a specific job
- [Get Pipeline](https://docs.archetypeai.app/api-reference/batch/registry/pipelines/get-pipeline.md): Retrieve details of a specific pipeline from the registry
- [Get Pipeline Schema](https://docs.archetypeai.app/api-reference/batch/registry/pipelines/get-pipeline-schema.md): Retrieve the configuration schema for a specific pipeline
- [List Pipelines](https://docs.archetypeai.app/api-reference/batch/registry/pipelines/list-pipelines.md): Retrieve a paginated list of pipelines from the registry
- [Error Handling](https://docs.archetypeai.app/api-reference/errors.md): Understanding and handling API errors
- [List All Files](https://docs.archetypeai.app/api-reference/files/get-all-metadata.md): Retrieve metadata for all uploaded files
- [Get Files Info](https://docs.archetypeai.app/api-reference/files/get-info.md): Get summary information about all uploaded files
- [Get File Metadata](https://docs.archetypeai.app/api-reference/files/get-metadata.md): Retrieve complete metadata for a specific uploaded file
- [Upload File](https://docs.archetypeai.app/api-reference/files/upload.md): Upload a file to the Newton Platform for processing
- [Cancel Job](https://docs.archetypeai.app/api-reference/fine-tune/cancel-job.md): Cancel a fine-tune job
- [Create Job](https://docs.archetypeai.app/api-reference/fine-tune/create-job.md): Create a fine-tune job for the authenticated organization
- [Delete Job](https://docs.archetypeai.app/api-reference/fine-tune/delete-job.md): Delete a fine-tune job
- [Get Job](https://docs.archetypeai.app/api-reference/fine-tune/get-job.md): Fetch a fine-tune job by ID
- [Get Job Metrics](https://docs.archetypeai.app/api-reference/fine-tune/get-job-metrics.md): Fetch training and evaluation metrics for a fine-tune job
- [Get Node Status](https://docs.archetypeai.app/api-reference/fine-tune/get-node-status.md): Fetch the current status of the fine-tune runner node
- [List Jobs](https://docs.archetypeai.app/api-reference/fine-tune/list-jobs.md): List fine-tune jobs for the authenticated organization
- [Stop Job](https://docs.archetypeai.app/api-reference/fine-tune/stop-job.md): Stop a running fine-tune job
- [Overview](https://docs.archetypeai.app/api-reference/introduction.md): Complete reference for APIs
- [Create Lens Session](https://docs.archetypeai.app/api-reference/lens/create-session.md): Create a new lens session for processing sensor data
- [Destroy Lens Session](https://docs.archetypeai.app/api-reference/lens/destroy-session.md): Destroy an active lens session and free up resources
- [Lens API Examples](https://docs.archetypeai.app/api-reference/lens/examples.md): Complete examples for CSV streaming and RTSP camera integration
- [Get Lens Info](https://docs.archetypeai.app/api-reference/lens/get-info.md): Retrieve high-level information about all lenses in your organization
- [Get Lens Metadata](https://docs.archetypeai.app/api-reference/lens/get-metadata.md): Retrieve detailed metadata for all lenses available to your organization
- [Get Sessions Info](https://docs.archetypeai.app/api-reference/lens/get-sessions-info.md): Get summary information about all lens sessions in your organization
- [Get Sessions Metadata](https://docs.archetypeai.app/api-reference/lens/get-sessions-metadata.md): Get detailed metadata for all active lens sessions
- [Clone Lens](https://docs.archetypeai.app/api-reference/lens/lens-clone.md): Creates a copy of a lens template
- [Delete Lens](https://docs.archetypeai.app/api-reference/lens/lens-delete.md): Deletes a lens template
- [Modify Lens](https://docs.archetypeai.app/api-reference/lens/lens-modify.md): Modifies an existing lens template
- [Register Lens](https://docs.archetypeai.app/api-reference/lens/lens-register.md): Register a new lens configuration that can be used to create sessions
- [Session Events Process](https://docs.archetypeai.app/api-reference/lens/sessions-events-process.md): Sends an event to an active session to process
- [Lens Events API (WebSocket)](https://docs.archetypeai.app/api-reference/lens/websocket-events.md): Real-time control and data streaming for lens sessions via WebSocket
- [Quick Reference](https://docs.archetypeai.app/api-reference/quick-reference.md): Essential API commands and patterns for quick reference.
- [Activity Monitor](https://docs.archetypeai.app/code-examples/command-line-demos/activity-monitor/activity-monitor.md): Monitor and analyze video content via a command-line interface. Supports both local video files and real-time RTSP streams.
- [Machine State Lens](https://docs.archetypeai.app/code-examples/command-line-demos/machine-state/machine-state.md): Classify machine states from time-series sensor data using Newton's few-shot learning capabilities via command-line interface.
- [Google Sheets Integration](https://docs.archetypeai.app/code-examples/machine-state/sensor-analysis-with-sheets.md): Analyze time-series sensor data and log results to Google Sheets for collaborative monitoring and visualization.
- [Google Sheets API Credentials](https://docs.archetypeai.app/code-examples/machine-state/setup/credentials-setup.md): Configure OAuth 2.0 credentials to enable Google Sheets integration with Cookbook demos.
- [Telegram Bot Setup](https://docs.archetypeai.app/code-examples/telegram-alerts/setup/bot-setup.md): Set up a Telegram bot for remote video monitoring control
- [RTSP Configuration](https://docs.archetypeai.app/code-examples/telegram-alerts/setup/rtsp-setup.md): Set up RTSP on Tapo C100 and access it over the Internet
- [Real-time Camera Alerts](https://docs.archetypeai.app/code-examples/telegram-alerts/telegram-alerts.md): Two ways to run smart video monitoring with Newton and receive alerts in Telegram. Choose terminal for quick testing or Telegram for full remote control.
- [Fine-Tuning](https://docs.archetypeai.app/core-concepts/customization/fine-tuning.md)
- [Lens Customization](https://docs.archetypeai.app/core-concepts/customization/lens-customization.md)
- [N-Shot Examples](https://docs.archetypeai.app/core-concepts/customization/n-shot-examples.md)
- [Overview](https://docs.archetypeai.app/core-concepts/customization/overview.md)
- [Files](https://docs.archetypeai.app/core-concepts/files/files.md)
- [Overview](https://docs.archetypeai.app/core-concepts/introduction/introduction.md)
- [Lens Parameters](https://docs.archetypeai.app/core-concepts/lenses/lens-parameter.md): A comprehensive reference for configuring lens parameters across all Archetype AI lens types.
- [Lens Processors](https://docs.archetypeai.app/core-concepts/lenses/lens-processors.md)
- [Activity Monitor](https://docs.archetypeai.app/core-concepts/lenses/lens-templates/activity-monitor.md)
- [Machine State Lens](https://docs.archetypeai.app/core-concepts/lenses/lens-templates/machine-state.md)
- [Test Lens](https://docs.archetypeai.app/core-concepts/lenses/lens-templates/test-lens.md)
- [What is a Lens?](https://docs.archetypeai.app/core-concepts/lenses/overview.md)
- [CSV File Reader](https://docs.archetypeai.app/core-concepts/streams/data-connectors/readers/csv-reader.md)
- [JSONL File Reader](https://docs.archetypeai.app/core-concepts/streams/data-connectors/readers/jsonl-file-reader.md)
- [RTSP Video Reader](https://docs.archetypeai.app/core-concepts/streams/data-connectors/readers/rtsp-video-reader.md)
- [Video File Reader](https://docs.archetypeai.app/core-concepts/streams/data-connectors/readers/video-reader.md)
- [SSE Writer](https://docs.archetypeai.app/core-concepts/streams/data-connectors/writers/sse-writer.md)
- [Data Streams](https://docs.archetypeai.app/core-concepts/streams/data-streams.md)
- [Data Events](https://docs.archetypeai.app/core-concepts/streams/events/data-events.md): Data events allow a developer to specify and package multimodal sensor data as input and/or output of a lens.
- [Events](https://docs.archetypeai.app/core-concepts/streams/events/overview.md)
- [Session Events](https://docs.archetypeai.app/core-concepts/streams/events/session-events.md): Session events allow developers to query, validate, and control the lifecycle of active lens sessions through an event-driven interface.
- [SSE Streaming](https://docs.archetypeai.app/core-concepts/streams/events/sse-streaming.md): Server-Sent Events provide real-time streaming of lens session output with automatic reader tracking and lifecycle management.
- [Stream Events](https://docs.archetypeai.app/core-concepts/streams/events/stream-events.md): Configure input and output data streams to connect sensors, files, and applications to lens sessions.
- [Batch Manager](https://docs.archetypeai.app/developer-console/batch-manager.md)
- [Getting Started](https://docs.archetypeai.app/developer-console/introduction.md)
- [Activity Monitor Lens](https://docs.archetypeai.app/developer-console/workbench/activity.md): Learn how to use the Activity Monitor lens with video files in the workbench.
- [Machine State Lens](https://docs.archetypeai.app/developer-console/workbench/machine-state.md): Learn how to use the Machine State Lens with CSV files.
- [Developer Quickstart](https://docs.archetypeai.app/introduction/getting-started.md): This quickstart tutorial allows you to create and run a custom lens which analyzes a video and generates a continuous description of the video.
- [Overview](https://docs.archetypeai.app/introduction/overview.md)
- [Environment Variables](https://docs.archetypeai.app/libraries/environment-variables.md): Configure environment variables for the Archetype AI platform.
- [Overview](https://docs.archetypeai.app/libraries/libraries.md): Set up your development environment to use the Archetype API with a client library in your preferred language
- [Python](https://docs.archetypeai.app/libraries/python.md)
- [Error Codes](https://docs.archetypeai.app/support/error-codes.md)
- [Request Access](https://docs.archetypeai.app/support/request-access.md)
- [Support](https://docs.archetypeai.app/support/support.md): This page covers common issues you might encounter when working with the Archetype API and provides step-by-step solutions.
- [Troubleshooting](https://docs.archetypeai.app/support/troubleshooting.md): Common issues and solutions when working with Archetype's APIs