Skip to main content

​
Create Character

POST /api/characters
Creates a character owned by the authenticated user and returns the created character object. Characters created with this endpoint are always private (isPublic: false) and are scoped to the same API key owner.

​
Request body

FieldTypeRequiredDescription
namestringYesCharacter name (1-60 chars)
descriptionstringNoOptional character description (max 300 chars)
imagesarray<string>Yes (JSON)1-10 HTTP(S) image URLs
images or images[]fileYes (multipart)1-10 local image files
Supported image sources:
  • multipart/form-data local file uploads (images or images[])
  • JSON HTTP(S) image URLs (images)
Not supported:
  • Base64 / data URI values
  • Direct S3 keys

​
JSON request (image URLs)

curl -X POST "https://prismvideos.com/api/characters" \
  -H "Authorization: Bearer prism_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Spokesperson",
    "description": "Warm, confident presenter with studio lighting",
    "images": [
      "https://images.example.com/person-front.jpg",
      "https://images.example.com/person-side.jpg"
    ]
  }'

​
Multipart request (local uploads)

curl -X POST "https://prismvideos.com/api/characters" \
  -H "Authorization: Bearer prism_sk_your_key_here" \
  -F "name=Product Spokesperson" \
  -F "description=Warm, confident presenter with studio lighting" \
  -F "images[]=@./person-front.png" \
  -F "images[]=@./person-side.png"

​
Response

201 Created 
{
  "data": {
    "id": "d2a7e0d5-1705-43b5-be96-85b9c5f25b80",
    "name": "Product Spokesperson",
    "description": "Warm, confident presenter with studio lighting",
    "created_at": 1773361092291
  }
}

​
Response fields

​
Character object

FieldTypeDescription
idstringUnique character identifier
namestringCharacter name
descriptionstring or nullCharacter description
created_atnumberUnix timestamp in milliseconds

​
Errors

StatusErrorWhen
400validation_errorMissing/invalid name, unsupported image source, or image count out of range
401unauthorizedMissing or invalid API key
403forbiddenAPI key lacks templates:read scope
500server_errorUnexpected server error while creating character
See Errors for the full error reference.