{
  "opencollection": "1.0.0",
  "info": {
    "name": "Vyond API Documentation",
    "version": "1.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Content Generation",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create content generation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rest/v1/generations/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new task for content generation"
        },
        {
          "info": {
            "name": "Create content generation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rest/v2/generations/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new task for content generation"
        },
        {
          "info": {
            "name": "Get content generation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rest/v2/generations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get content generation details by ID"
        }
      ]
    },
    {
      "info": {
        "name": "SCIM",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/scim/v2/Users",
            "params": [
              {
                "name": "startIndex",
                "value": "",
                "type": "query"
              },
              {
                "name": "count",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get users in the account with optional filter and pagination"
        },
        {
          "info": {
            "name": "Create user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/scim/v2/Users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new user in the account"
        },
        {
          "info": {
            "name": "Get user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/scim/v2/Users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get information of user in the account by user ID"
        },
        {
          "info": {
            "name": "Update user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/scim/v2/Users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update information of user in the account by user ID"
        },
        {
          "info": {
            "name": "Patch user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/scim/v2/Users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update individual attributes of user in the account by user ID. The operation follows the [syntax defined in the SCIM specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2).<br><br>Here are some examples:<br><br>**Update userName**<br>The `userName` must be equal to the email address, except for special circumstances. Therefore, update both fields together.<br>\n```json\n{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n     "
        },
        {
          "info": {
            "name": "Get schemas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/scim/v2/Schemas",
            "params": [
              {
                "name": "startIndex",
                "value": "",
                "type": "query"
              },
              {
                "name": "count",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get SCIM schemas"
        },
        {
          "info": {
            "name": "Get schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/scim/v2/Schemas/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get SCIM schema by ID"
        }
      ]
    },
    {
      "info": {
        "name": "Parameter",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get API parameters information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rest/v1/parameters/",
            "params": [
              {
                "name": "feature",
                "value": "",
                "type": "query"
              },
              {
                "name": "parameterKeys",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get information (e.g. data type and values) of API parameters, some values may be filtered based on user plan and account available features."
        }
      ]
    },
    {
      "info": {
        "name": "Turbo",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Turbo video generation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rest/v1/turbo/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new Turbo video generation task from a prompt and optional reference files"
        },
        {
          "info": {
            "name": "Get Turbo video generation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rest/v1/turbo/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get the status and download URL of a Turbo video generation task by ID"
        }
      ]
    },
    {
      "info": {
        "name": "User",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get current user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rest/v1/users/me",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get information of current user based on the authorization"
        }
      ]
    },
    {
      "info": {
        "name": "Video Export",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Export video",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rest/v1/videos/:videoId/exports",
            "params": [
              {
                "name": "videoId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create export video task"
        }
      ]
    },
    {
      "info": {
        "name": "Video",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get video export download URL",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rest/v1/videos/:videoId/exports/:conversionId",
            "params": [
              {
                "name": "videoId",
                "value": "",
                "type": "path"
              },
              {
                "name": "conversionId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the download URL for a completed video export"
        }
      ]
    },
    {
      "info": {
        "name": "Webhook",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List webhooks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rest/v1/webhooks/",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List webhooks owned by the user"
        },
        {
          "info": {
            "name": "Create webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rest/v1/webhooks/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Register a new webhook on Vyond, default enabled"
        },
        {
          "info": {
            "name": "Update webhook",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/rest/v1/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update an existing webhook"
        },
        {
          "info": {
            "name": "Delete webhook",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/rest/v1/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete an existing webhook"
        }
      ]
    }
  ],
  "bundled": true
}