Skip to main content

Introduction

Welcome to the API documentation for Vessel Agent, provided by STR8 Industries, Inc.. This API allows developers and system integrators to interact programmatically with the system for full control and system management.

Base URL​

Every request example in this documentation uses <base-url> as a placeholder for your deployment's actual base URL (scheme + host) — for example http://localhost:8080 in local development, or https://vessel-agent.str8-industries.com in production. Substitute it with the appropriate value for your environment.

Conventions​

  • HTTP Methods — The API supports standard HTTP methods: GET, POST, PUT, and DELETE, depending on the endpoint's purpose.
  • JSON Format — Unless otherwise specified, all API requests and responses use JSON (application/json). Set the Content-Type: application/json header for requests and expect JSON in responses, except where individual endpoints indicate otherwise.
  • Error Handling — Errors are typically returned as JSON objects in the format {"error": {"code": "xxx"}}, where code identifies the issue. However, some endpoints may return empty bodies or include additional fields for more context, such as {"error": {"code": "xxx", "message": "yyy"}}. Please check each endpoint's description for details.