Connect to the Oviond REST API

Use the Oviond REST API with Bearer authentication and the production API base URL.

Use the Oviond REST API to manage Oviond resources programmatically.

Who this is for

This article is for developers, technical operators, and agencies building custom workflows around Oviond.

Before you start

You will need:

  1. access to your Oviond account,

  2. an Oviond API key,

  3. a safe place to store the key,

  4. the API base URL: `https://api.oviond.com`.

Do not expose API keys in screen captures, prompts, shared documents, source code, or support tickets.

Steps

1. Open the API docs

Use the live API documentation to confirm exact endpoints, methods, request bodies, and response shapes:

`https://api.oviond.com/docs`

2. Generate an API key

Generate an API key from the API keys area in the Oviond app.

Store the key securely as a secret or environment variable.

3. Use the production base URL

Send requests to:

`https://api.oviond.com`

4. Add Bearer authentication

Add the API key to the Authorization header:

Authorization: Bearer YOUR_API_KEY

5. Send JSON requests

For requests with a body, send JSON with:

Content-Type: application/json

6. Start with a safe read request

Before creating or changing anything, test the connection with a safe read request from the API docs.

Expected result

Your integration should be able to authenticate with the Oviond REST API and call supported endpoints for account, clients, projects, pages, widgets, data sources, templates, themes, automations, users, media, and other resources.

Troubleshooting

401 Unauthorized

The API key is missing, invalid, or not sent as a Bearer token.

403 Forbidden

The authenticated account or key does not have permission for that action.

404 Not Found

Check the endpoint path and resource ID.

422 Validation error

Check the request body against the OpenAPI schema.

429 Too Many Requests

The account has hit the rate limit. Wait before retrying.

What to send support if stuck

Send Oviond support:

  1. endpoint path,

  2. HTTP method,

  3. status code,

  4. redacted request body,

  5. error response,

  6. what you expected to happen.

Never send your API key.

Related articles

Did this answer your question?
😞
😐
😁