OceanirDocs
API

API

OpenAPI specification

The OpenAPI specification is a machine-readable description of Oceanir’s HTTP API. Developer tools can use it to import endpoints, inspect request fields, and generate client code.

For explanations and examples, read the endpoint reference. You do not need to read the JSON file to use Oceanir.

Download the schema

The specification uses OpenAPI 3.1 and is served as JSON.

Download OpenAPI JSON

https://oceanir.ai/openapi.json

Use it in your tools

  1. Download the JSON file, or copy the specification URL above.
  2. Use your API client’s OpenAPI import feature.
  3. Configure your Oceanir API key in the client’s private credential settings.
  4. Review the generated request before sending it. Importing a schema does not grant API access.

See authentication for accepted headers and Quickstart for a complete first request.

Using an AI client instead?

MCP has its own connection protocol and tool catalog. Follow Connect a client to set that up.