Introduction

Base URL

All API requests are made to:

https://api.osvi.ai

Every request must include your API token in the API-Token header:

API-Token: <your-api-token>

You can find your API token in the OSVI dashboard under Settings → API.

Your API token is 16 characters long and scoped to your account. Keep it secret — do not expose it in client-side code.

All request bodies must be JSON. Set the Content-Type header accordingly:

Content-Type: application/json

All responses return JSON. Successful responses follow this shape:

{
  "success": true,
  "data": { ... }
}

Error responses:

{
  "success": false,
  "errors": ["field is required"]
}

Code	Meaning
`200`	Success
`401`	Unauthorized — invalid or missing `API-Token`
`404`	Resource not found
`422`	Validation error — check the `errors` array in the response body
`500`	Internal server error

Every endpoint requires an agent_uuid. This is the unique identifier for your OSVI agent, formatted as:

agent_<alphanumeric-string>

Find your agent UUID in the OSVI dashboard on the agent’s detail page.