POST /aiworkflow/aipackage

One route, several operations. The action field — sent in the request body — selects what the call does: create a resource by hand, regenerate it, allow its download, or request a signed upload URL.

Naming: abstract = eBook, mindmap = Mind Map, questions = Quiz.

🚧

action goes in the BODY, not in the query string

Unlike other routes of this API that dispatch on ?action=, here the field is part of the JSON. Sending ?action=regenerate in the URL has no effect — the call falls through to the behaviour without action, which generates the whole package in the old model (and consumes credits).

📘

Authorization

Requires the account API key in the Authorization header, without the Bearer prefix.

Available Operations

The four upload actions are detailed on Upload an eBook PDF.

Two operations of the same route use other HTTP methods and have their own page:

HTTP Method & Path

POST /aiworkflow/aipackage

Base URL: https://api-v2.pandavideo.com.br

Authentication Requirements

Parameters

Request Body

Content-Type: application/json

video_id is required by every action. The remaining fields depend on the action.

action: create — create a resource by hand

Creates a Mind Map or a Quiz with the content you send, without going through the AI and without consuming credits. Useful to import material you already have.

{
  "action": "create",
  "video_id": "{video_id}",
  "lang": "pt-BR",
  "resource": "questions",
  "questions": [
    {
      "enunciate": "Which vitamin is synthesised through sun exposure?",
      "options": [
        { "text": "Vitamin A", "correct": false },
        { "text": "Vitamin D", "correct": true }
      ]
    }
  ],
  "questions_config": { "num_answers": 2, "allow_skip": false }
}

action: regenerate — regenerate in the same language

Deletes the resource and generates it again, in the same language, in a single call. Consumes credits.

⚠️

An omitted config field reuses the one from the previous generation — it does not reset to defaults.

If the eBook was generated with layout: magazine and you regenerate without sending abstract_config, it comes out magazine again. To go back to defaults, send the object with the values you want explicitly.

{
  "action": "regenerate",
  "video_id": "{video_id}",
  "resource": "abstract",
  "lang": "en",
  "abstract_config": { "layout": "modern", "accent_color": "#3F55EE" }
}

action: set_download — allow or block the download

{
  "action": "set_download",
  "video_id": "{video_id}",
  "resource": "abstract",
  "allow_download": true
}

Response (200):

{ "status": "updated", "resource": "abstract", "allow_download": true }

⚠️

The permission is per resource, not per language. Allowing abstract applies to all languages of that video's eBook. You cannot allow the English eBook while keeping the Portuguese one blocked.

The flag is stored in config.ai.allow_download of GET /videos/{video_id}, keyed by resource — for example { "abstract": true, "questions": false }.

⚠️

set_download does not check whether the resource exists. Calling it for a resource the video does not have still returns 200 and stores the flag, which then applies if that resource is created later. Do not use this call to test whether a resource exists — read config.ai.resources[] instead.

Without action — whole package, old model

Kept for backward compatibility. Generates eBook, Mind Map and Quiz together, in one language, in the v1 format (a file without a language suffix).

🚧

For new content, prefer POST /aiworkflow, which generates one resource at a time and accepts several languages in to_langs, writing schema_version: 2 in the output file.

Response

The response body depends on the action — the upload actions return the signed URL, set_download returns the updated state, and create and regenerate return the job that was created.

Error Responses

• 400: unknown action, a field required by the chosen action is missing, or an unknown field inside a *_config (strict object).
• 401: missing or invalid API key.
• 402: not enough AI credits (regenerate and package generation).
• 404: video not found. Note that set_download does not return 404 for a resource that does not exist — see the warning above.
• 500: internal error.

Validation errors come back as { "errCode": "BadRequest", "errMsg": "..." }, and errMsg names the offending field.

Example Usage

cURL

# Allow the eBook download
curl -X POST "https://api-v2.pandavideo.com.br/aiworkflow/aipackage" \
  -H "Authorization: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "set_download",
    "video_id": "{video_id}",
    "resource": "abstract",
    "allow_download": true
  }'

# Regenerate the Portuguese Quiz
curl -X POST "https://api-v2.pandavideo.com.br/aiworkflow/aipackage" \
  -H "Authorization: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "regenerate",
    "video_id": "{video_id}",
    "resource": "questions",
    "lang": "pt-BR",
    "questions_config": { "num_questions": 5, "num_answers": 4 }
  }'