---
updatedAt: 2026-05-27T07:59:25.000Z
agentTools:
  projectIndex: https://docs.d-id.com/llms.txt
---

# Create an Express Avatar

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Videos Endpoints",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://api.d-id.com/"
    }
  ],
  "paths": {
    "/scenes/avatars": {
      "post": {
        "operationId": "Create1",
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAvatarResponseDto"
                },
                "examples": {
                  "Example 1": {
                    "value": {
                      "id": "52907745-7672-470e-a803-a2f8feb52944",
                      "object": "scene_avatar",
                      "created_at": "2020-09-03T13:56:54.995",
                      "status": "created"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "BadRequestError | InvalidFileSizeError | InvalidFaceError",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JsonError"
                },
                "examples": {
                  "Example 1": {
                    "value": {
                      "kind": "BadRequestError",
                      "description": "invalid source url"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "AuthorizationError",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JsonError"
                },
                "examples": {
                  "Example 1": {
                    "value": {
                      "kind": "AuthorizationError",
                      "description": "user unauthenticated"
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "InsufficientCreditsError",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JsonError"
                },
                "examples": {
                  "Example 1": {
                    "value": {
                      "kind": "InsufficientCreditsError",
                      "description": "not enough credits"
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Create an Express Avatar",
        "tags": [
          "Scenes (Express Avatars)"
        ],
        "security": [
          {
            "basic": []
          },
          {
            "bearer": []
          }
        ],
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAvatarRequestDto"
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "JsonError": {
        "properties": {
          "kind": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "details": {},
          "internal": {
            "type": "string"
          }
        },
        "required": [
          "kind",
          "description"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "UserData": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1000,
        "pattern": "^(?!\\s*$).+$"
      },
      "SecuredUrl": {
        "type": "string",
        "pattern": "^(?:https):\\/\\/[\\S]+$"
      },
      "VideoPath": {
        "type": "string",
        "example": "https://path.to.directory/movie.mp4",
        "pattern": "(https|s3):.*\\.(?:mp4|MP4|mov|MOV|mpeg|MPEG)"
      },
      "SceneAvatarStatus": {
        "enum": [
          "draft",
          "created",
          "started",
          "training-started",
          "error",
          "done",
          "rejected",
          "validating"
        ],
        "type": "string"
      },
      "CreateAvatarResponseDto": {
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the avatar"
          },
          "status": {
            "$ref": "#/components/schemas/SceneAvatarStatus",
            "description": "The status of the avatar"
          },
          "object": {
            "type": "string",
            "enum": [
              "scene_avatar"
            ],
            "nullable": false,
            "description": "An identifier of this avatar"
          },
          "created_at": {
            "type": "string",
            "description": "Avatar creation time as iso-8601 string"
          }
        },
        "required": [
          "id",
          "status",
          "object",
          "created_at"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "CreateAvatarRequestDto": {
        "properties": {
          "source_url": {
            "$ref": "#/components/schemas/VideoPath",
            "description": "The URL of the source video to create an avatar from"
          },
          "consent_id": {
            "type": "string",
            "description": "Unique identifier of a valid consent video"
          },
          "name": {
            "type": "string",
            "description": "A name for the avatar"
          },
          "webhook": {
            "$ref": "#/components/schemas/SecuredUrl",
            "description": "A webhook URL for sending the payload including animate details\nIn a case of empty value, the webhook will not be triggered",
            "example": "https://host.domain.tld/to/webhook"
          },
          "user_data": {
            "$ref": "#/components/schemas/UserData",
            "description": "Non-sensitive custom data that will be added to the scene response and webhook."
          },
          "is_greenscreen": {
            "type": "boolean",
            "description": "Whether the video is a green screen video"
          }
        },
        "required": [
          "source_url"
        ],
        "type": "object",
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "basic": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl"
    ]
  }
}
```