> For the complete documentation index, see [llms.txt](https://captic-2.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://captic-2.gitbook.io/docs/your-captic-system/local-api.md).

# Local API

The Captic system’s **HMI (Human-Machine Interface)** is web-based and uses a local **REST API** under the hood. You can leverage this API in a **standalone manner** to build custom applications, dashboards, or integrations tailored to your needs.

## Why use the Local API?

* **Flexibility**: Create custom interfaces that suit your workflow.
* **Integration**: Connect the Captic system with your existing tools or third-party applications.
* **Automation**: Automate tasks and processes programmatically.

## Notes & Limitations

* **Application-Specific**: Some API endpoints may not be implemented depending on your specific use case or application.

{% hint style="info" %}
Build your vision, your way! If you have any questions or need assistance with the API, we’re here to help: <support@captic.com>
{% endhint %}

## General Endpoints

These endpoints relate to the general functionality of your Captic system.

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/status" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/status/toggle\_operation\_mode" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/settings" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/settings" method="put" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/manual\_step" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

## Data Collection Endpoints

Behavior related to data collection can be controlled using the following endpoints:

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/collection/new\_frame" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/collection/latest\_frame" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

## Vision Endpoints

The vision functionality of your Captic system can be controlled using the following endpoints:

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/vision/models" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/vision/model" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/vision/model" method="put" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/vision/predict" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/vision/fetch\_frame" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/vision/results" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

## Calibration Endpoints

If your output is a Robot, the vision system will require calibration.&#x20;

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/calibration" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/calibration/recalibrate" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

## Output Endpoints

These are the endpoints to manipulate the downstream devices (= output);

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/outputs" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output" method="put" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output/start" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output/stop" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output/reset" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output/status" method="get" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}

{% openapi src="/files/K2OhwWaS6i45IMtP34Yw" path="/output/send" method="post" %}
[openapi (1).json](https://482575286-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F22HCD2cZG8ud6cPRBzVQ%2Fuploads%2FuuNWWFAtvojnMSZ2Tosm%2Fopenapi%20\(1\).json?alt=media\&token=1bc5ce23-1dcd-4bb5-8456-64655c4c151d)
{% endopenapi %}