API Overview and Authentication

How to authenticate with the OptoGlide API and an overview of the core endpoints for generation, assets, and analytics.

The OptoGlide REST API provides programmatic access to creative generation, asset management, and analytics, letting you integrate OptoGlide into your own tools and workflows.

Base URL

All API requests are made to https://api.optoglide.ai/v1.

Authentication

OptoGlide uses API key authentication. Generate a key from Workspace Settings > API Access, and include it in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

API keys are scoped to a workspace and can be restricted to specific permissions, read-only access to assets, for example, without generation or billing access.

Core endpoint groups

/generations – Submit a brief and generate creative assets programmatically, and poll for generation status.
/assets – List, search, retrieve, and manage assets stored in Creative Asset Library, including metadata and tags.
/brand – Read brand guideline configuration, useful for validating content generated outside the platform.
/workflows – Trigger and check the status of approval workflows for a given project.
/analytics – Retrieve creative performance data, including engagement, watch time, and CTR, at the asset level.

Rate limits

API requests are rate-limited based on your plan: 60 requests per minute on Growth plans, and custom limits on Enterprise plans. Rate limit status is returned in the X-RateLimit-Remaining response header.

Example request

curl https://api.optoglide.ai/v1/generations \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"studio": "video", "brief": "60-second product launch video for our new analytics dashboard"}'

Next steps

See the SDK overview for higher-level client libraries, or the integrations documentation for pre-built connections that do not require custom API code.