Skip to content

Commit

Permalink
SVD page added
Browse files Browse the repository at this point in the history
  • Loading branch information
janand-octo authored Jul 12, 2024
1 parent e5484d1 commit 7366f16
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 7 deletions.
7 changes: 6 additions & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,12 @@ navigation:
- page: SDXL Controlnet
path: docs/media-gen-solution/rest-apis/generate/images/controlnet-sdxl.mdx
- page: SD1.5 Controlnet
path: docs/media-gen-solution/rest-apis/generate/images/controlnet-sd15.mdx
path: docs/media-gen-solution/rest-apis/generate/images/controlnet-sd15.mdx
- section: Videos
contents:
- page: Stable Video Diffusion
path: docs/media-gen-solution/rest-apis/generate/videos/svd.mdx

- page: Inference models
path: docs/getting-started/inference-models.mdx
- page: Create an API token
Expand Down
41 changes: 35 additions & 6 deletions fern/docs/media-gen-solution/rest-apis/generate/videos/svd.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,47 @@
---
title: Stable Video Diffusion REST API
subtitle: Animate and add motion to your images
slug: media-gen-solution/rest-apis/video-gen
slug: media-gen-solution/rest-apis/generate/videos/svd
---

Our video generation model is accessible via REST API. Below, you'll find straightforward examples using cURL/Python SDK and TypeScript SDK for our video generation endpoints, complete with explanations of all parameters.
Generate an videos using a Stable Video Diffusion (SVD) model.

The endpoint URL for video generation is `https://image.octoai.run/generate/svd`.
OctoAI's SVDL API supports image-to-video use cases. For text-to-video use cases, utilize our Image Gen APIs such as SDXL, SD15, SD3, Juggernaut XI APIs followed by the SVD API.

This encompasses image-to-video conversion. Additionally, we offer support for a text-to-video workflow, which involves utilizing the text-to-image API (Image Gen API) followed by the image-to-video API.
You need to create an [OctoAI Authentication Token](getting-started/how-to-create-octoai-access-token) to access this API.

## Request payload
### **How to use**

**Parameters:**
Invoke `https://image.octoai.run/generate/svd` endpoint with a `POST` request.

The headers of the request must include an Authentication Token in the authorization field. The accept header should be set to `application/json` to receive the image encoded as base64 in a JSON response.

**Generating a video with an image**: The only required parameter is `image`. It should be in base64 encoded string format.

<Note>
For more details about all parameters, please see the request schema below.
</Note>


### **Output**

3-4 secs long video with resolution closest to the input image. For all supported resolutions, refer `Parameters` section below.

### **Pricing**

***$0.15*** per video, any resolution, 25 steps; billed per video


Check [Pricing Page](https://octo.ai/docs/getting-started/pricing-and-billing) for more details.

### **Request Details**

**Headers**:

`Authorization` (Required): Your `OCTOAI_TOKEN`
`Content-Type` (Required): Set to `application/json`

**Parameters**:

- `image` (base64 encoded image, required) - Starting point image encoded in base64 string
- `height` (int; optional) - Integer representing the height of video/animation to generate- If not provided, the output height will be inferred from the input 'image', and the closest resolution supported will be chosen.
Expand Down

0 comments on commit 7366f16

Please sign in to comment.