REST API

Use OpenAtman REST APIs for secure, predictable integrations.

Authentication

Include your API key in the x-api-key header on every request.

Example Request

curl --location 'http://127.0.0.1:8091/API/v1.0/face/match/upload' \
--header 'x-api-key: YOUR_OPENATMAN_VISION_API_KEY' \
--form 'image1=@"/path/to/image1.jpg"' \
--form 'image2=@"/path/to/image2.jpg"' \
--form 'threshold_percent="75"'

HTTP Errors

400: Invalid request body or missing fields.

401: Invalid or missing API key.

403: Access denied for the current key.

404: Endpoint path not found.

429: Rate limit exceeded.

500: Internal server error.

404 Troubleshooting

For 404 errors, verify host, version prefix, and exact route path (for example /API/v1.0/face/match/upload). Also check that the endpoint is enabled in your current environment.