Skip to content

Getting started

Overview

Move's UGC API enables businesses and groups to construct tailored workflows or applications, addressing their unique requirements for mocap animation. Our API is built on GraphQL, a modern query language that enables clients to specify exactly what data they need from the server. See the official docs if you are new to GraphQL.

We recommend that you always use one of our UGC SDKs to bypass making graphql requests. Currently we support the following languages:

Creating a file

mutation CreateFile {
    videoFile: createFile(type: "mp4") {
        id
        presignedUrl
    }
}

This will return a presigned URL that you can use to upload your video file to our servers.

See the usage section for more info on how handle files.

Creating a singlecam take

Once the upload is complete, you can create a singlecam take and singlecam job from the video file.

See usage section for more info on how to create a singlecam take and job.

Creating a multicam job

⚠️ Warning: The multicam API is still in beta. Bugs are likely to occur. Please report any issues to support@move.ai

See here for more info on how to create a multicam job.

For more info on how creating a File, Take or Job works, see the API reference.

Implementing a custom webhook

You can also implement a custom webhook to receive updates on the status of your job.

mutation CreateWebhook {
    webhook: upsertWebhookEndpoint(
        url: "https://your-webhook-url.com", 
        secret: "your-secret",
        events: ["ugc.job.state.completed"],
        uid: "your-unique-id-for-webhook"
    ) {
        uid
        secret
        url
        events
    }
}

For more info on how creating a Webhook works, see the integration guide on webhooks.