POST
/
v1
/
edits
  curl --location --request POST 'https://api.golivecosmos.com/v1/edits' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data-raw '{
      "commands": ["image-to-video"],
      "assets": [
        { "type": "image", "src": "https://picsum.photos/200/300" }
      ],
      "options": { "fps": 24, "duration": 5 }
  }'

{
  "type": "edit",
  "id": "647f79a222e224369dbf7e92",
  "attributes": {
    "createdAt": "2023-06-06T18:22:41.557Z",
    "status": "queued",
    "commands": [
      "image-to-video"
    ],
    "options": {
      "fps": 24,
      "duration": 5
    },
    "assets": [
    { "type": "image", "src": "https://picsum.photos/200/300" }
    ]
  },
  "relationships": {
    "organization": {
      "links": {
        "self": "/v1/organizations/647f79a222e224369dbf7e90"
      },
      "data": {
        "type": "organization",
        "id": "647f79a222e224369dbf7e90"
      }
    }
  }
}

With this endpoint, you can create and edit images and video. Send a request to create an edit with the URLs of the files to edit, the edit command to perform on the files, and any custom options. See the table below for all the available edit commands and supported file types and options.

​
Cosmos Commands Library

CommandDescriptionInput formatsCosmos output formatsOptions
image-to-videoConverts image to video.jpeg, .png, .webp.mp4Frames per second
Name: fps
Type: float

Duration of output video in seconds
Name: duration
Type: float
gif-to-videoConverts Gif to video.gif.mp4-
image-to-webpConverts image to Webp.jpeg, .png, .webp.webp-
resize-imageUpscale or downscale image.jpeg, .png, .webp.jpeg, .png, .webp Scale of output
Name: scale
Type: float

Format of output
Name: format
Type: string
modify-video-speedSpeed up or slow down video.mp4, .mov.mp4 Speed of output
Name: speed
Type: float

video-to-gifConverts video to Gif.mp4, .mov.gif-
video-to-oggConverts video to Ogg.mp4, .mov.ogv-
video-to-webmConverts video to Webm.mp4, .mov.webm-
extract-framesConverts video frames to images.mp4, .mov.webp-

​
Body

​
assets
array
required

An array of objects represent a media file. An asset object should have a type and source URL.

​
commands
array
required

An array of edit commands to apply to the assets in this request. The supported commands are listed in the Cosmos Commands Library table above.

​
options
object

The options to customize the edits applied to the assets. See Cosmos Command Library table for a list of supported options for each edit command.

​
Response

​
type
string

Indicates the type of document returned in the response.

​
attributes
object

The attributes of the Edit document response.

  curl --location --request POST 'https://api.golivecosmos.com/v1/edits' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data-raw '{
      "commands": ["image-to-video"],
      "assets": [
        { "type": "image", "src": "https://picsum.photos/200/300" }
      ],
      "options": { "fps": 24, "duration": 5 }
  }'

{
  "type": "edit",
  "id": "647f79a222e224369dbf7e92",
  "attributes": {
    "createdAt": "2023-06-06T18:22:41.557Z",
    "status": "queued",
    "commands": [
      "image-to-video"
    ],
    "options": {
      "fps": 24,
      "duration": 5
    },
    "assets": [
    { "type": "image", "src": "https://picsum.photos/200/300" }
    ]
  },
  "relationships": {
    "organization": {
      "links": {
        "self": "/v1/organizations/647f79a222e224369dbf7e90"
      },
      "data": {
        "type": "organization",
        "id": "647f79a222e224369dbf7e90"
      }
    }
  }
}