Skip to content

Enterprise

The Enterprise endpoint provides a single URL with multiple actions via the ?action= query parameter. This is a compatibility layer designed for API key users who prefer a unified endpoint.

All actions available here are also accessible through the standard REST endpoints.


Execute an enterprise action.

Auth: Required

Query ParamTypeRequiredDescription
actionstringYesThe action to perform (see below)

List all projects. Equivalent to GET /projects.

Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=listProjects" \
-H "Authorization: $LVZ_KEY"

Create a new project. Equivalent to POST /projects.

Body FieldTypeRequiredDescription
namestringYesProject name
descriptionstringNoProject description
Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=createProject" \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "API Integration Test"}'

Register a video and get a presigned upload URL. Returns a job_id and upload_url.

Body FieldTypeRequiredDescription
namestringYesVideo display name
selected_insightsstringNoJSON string of module names
initial_promptstringNoCustom analysis prompt
project_idstringNoAssign to a project

Response:

{
"job_id": "a1b2c3d4-...",
"upload_url": "https://s3.eu-central-003.backblazeb2.com/..."
}
Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=registerUpload" \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Demo Video", "selected_insights": "[\"visualelements\",\"transcription\"]"}'

Start processing a registered video. Equivalent to POST /processing/\{job_id\}/start.

Body FieldTypeRequiredDescription
job_idstringYesThe video’s job ID
selected_insightsstringNoOverride module selection

Response:

{
"job_id": "a1b2c3d4-...",
"status": "queued"
}
Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=process" \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"job_id": "a1b2c3d4-..."}'

Get processing status. Equivalent to GET /processing/\{job_id\}/status.

Body FieldTypeRequiredDescription
job_idstringYesThe video’s job ID
Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=getStatus" \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"job_id": "a1b2c3d4-..."}'

Get analysis results. Equivalent to GET /results/job/\{job_id\}.

Body FieldTypeRequiredDescription
job_idstringYesThe video’s job ID
modulesstring[]NoFilter by module names

Response:

{
"job_id": "a1b2c3d4-...",
"status": "completed",
"segments": [...]
}
Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=getResults" \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"job_id": "a1b2c3d4-...", "modules": ["transcription"]}'

Ask the AI agent a question about a video. Equivalent to POST /chat/ask.

Body FieldTypeRequiredDescription
job_idstringYesThe video’s job ID
querystringYesNatural language question
modulesstring[]NoLimit context to specific modules

Response:

{
"answer": "The video discusses three main topics...",
"job_id": "a1b2c3d4-...",
"segments_used": 342
}
Terminal window
curl -X POST "https://api.lynxvizion.com/api/enterprise?action=askAgent" \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"job_id": "a1b2c3d4-...", "query": "What are the key topics discussed?"}'