Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Auto Content Engine Discovery API
description: 'The GEN Auto Content Engine API takes a raw idea all the way to a published video — agent setup, idea research, vidsheet production, layer composition, render, and publish.
## The 5-step journey
Every operation belongs to one phase of a 5-step user journey. Each operation carries an `x-phase` extension you can filter on:
| Phase | Meaning |
|-------|---------|
| `setup` | Step 1 — Set Up Your Agent (identity, voice, personality, API keys, workspaces) |
| `ideas` | Step 2 — Generate Content Ideas (trending data, research, refinement, preferences) |
| `convert` | Step 3 — Convert Idea to Vidsheet (clone template or build custom engine) |
| `edit` | Step 4 — Edit & Generate (cells, layers, creation cards, trigger + poll) |
| `export` | Step 5 — Export & Publish (render, download, publish to social) |
Full journey-oriented docs: https://api.gen.pro
## Authentication
All endpoints require authentication via one of:
- **API Key** (recommended): Pass your API key in the `X-API-Key` header. Create keys on the agent''s API page in the GEN dashboard.
- **JWT**: Pass a Bearer JWT in the `Authorization: Bearer ` header.
## Base URLs
```
https://api.gen.pro/v1 — agent setup, vidsheets, generations, renders, publishing
https://agent.gen.pro/v1 — content ideas, research, conversations, chat
https://agent-core.gen.pro/v1 — agent core (brand profile, watchlists, scheduled tasks)
https://python.gen.pro — social publishing integration (connect, schedule, remove posts)
```
Each operation carries its own `servers` entry, so a generated client or a
hand-written call goes to the backend that serves the route.
## Credits
All `/v1/vidsheet/` endpoints require an active GEN credit balance.
If your organization has no usable credits, requests return `422` with error code `usable_gen_credit_required`.
Credits can be funded with x402 by calling `POST /v1/x402_credit_purchase`
with `workspace_id` plus `amount_usd` or `credits`. If `network` is omitted,
GEN returns every configured payment option in `payment_methods` and
`payment_required.accepts`; show the Sui, Solana, and Base options to the
user or calling agent and sign one selected accept entry. Workspace funding
wallets are backend settlement infrastructure; the user-facing payment
choices are the returned payment methods.'
version: 1.0.0
contact:
name: GEN Support
url: https://gen.pro
license:
name: Proprietary
servers:
- url: https://api.gen.pro/v1
description: Auto Content Engine API
- url: https://agent.gen.pro/v1
description: Agent Chat API
- url: https://agent-core.gen.pro/v1
description: Agent Core API (watchlists)
- url: https://python.gen.pro
description: Publishing integration API (social connect and scheduling)
security:
- apiKey: []
- bearerAuth: []
tags:
- name: Discovery
description: Identify the authenticated user, their workspaces, and agents.
paths:
/me:
get:
operationId: getMe
x-mcp-tool: gen_discover
x-mcp-branch: platform.me
x-phase: setup
summary: Get current user
description: Returns the authenticated user's profile. Use this to verify your API key works.
tags:
- Discovery
responses:
'200':
description: Current user
content:
application/json:
schema:
$ref: '#/components/schemas/User'
example:
id: abc123
email: user@example.com
name: Jane Doe
username: janedoe
created_at: '2025-01-15T10:30:00Z'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/ApiValidationError'
/workspaces:
get:
operationId: listWorkspaces
x-mcp-tool: gen_discover
x-mcp-branch: platform.workspaces
x-phase: setup
summary: List workspaces
description: Returns organizations where the authenticated user is an owner or manager.
tags:
- Discovery
responses:
'200':
description: List of workspaces
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Workspace'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/ApiValidationError'
/agents:
get:
operationId: listAgents
x-mcp-tool: gen_discover
x-mcp-branch: agent.capabilities
x-phase: setup
summary: List agents
description: Returns all agents the authenticated user has access to across their workspaces.
tags:
- Discovery
parameters:
- name: workspace_id
in: query
description: Filter by workspace (organization) ID
schema:
type: string
responses:
'200':
description: List of agents
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Agent'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/ApiValidationError'
/video_recreate_job:
post:
operationId: postVideoRecreateJob
x-phase: setup
summary: Vidsheet action —
tags:
- Discovery
requestBody:
required: true
content:
application/json:
schema:
type: object
description: JSON request body.
required:
- agent_id
- user_job
properties:
agent_id:
type: string
description: Agent context; the controller reads params[:agent_id] (`require_agent!`).
user_job:
type: object
properties:
data:
description: JSON object (`JSON.parse`d by the controller).
project_id: {}
container_id: {}
container_type: {}
project_node_ids:
type: array
items: {}
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
user_job_id: {}
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/ApiValidationError'
x-mcp-tool: gen_vidsheet_action
x-mcp-branch: <flat ops>
components:
schemas:
User:
type: object
properties:
id:
type: string
email:
type: string
name:
type: string
username:
type: string
created_at:
type: string
ApiError:
type: object
required:
- code
properties:
code:
type: string
description: The stable machine-readable failure code.
message:
type: string
description: Human-readable failure detail.
errors:
type: array
description: Field-level validation failures.
items:
type: object
retryable:
type: boolean
description: Whether retrying can succeed without changing the request.
new_change_set_required:
type: boolean
description: Whether the caller must begin a new edit group.
funding_error_kind:
type: string
description: The credit or payment failure category.
Error:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable error message.
error_code:
type: string
description: Machine-readable error code.
Workspace:
type: object
properties:
id:
type: string
name:
type: string
Agent:
type: object
properties:
id:
type: string
name:
type: string
responses:
ApiValidationError:
description: Validation failed or the request could not be processed.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
Unauthorized:
description: Missing or invalid authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Unauthorized
error_code: unauthorized
securitySchemes:
apiKey:
type: apiKey
in: header
name: X-API-Key
description: Personal Access Token (PAT). Create one in Settings > API Keys.
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Bearer JWT issued by the GEN dashboard sign-in.