Skip to main content
POST
Create Session from Character
See Session errors for the error codes session endpoints return.

Authorizations

Authorization
string
header
required

Your Vivix API key. Keep it on your server.

Body

application/json
character_id
string
required

Saved character to start from, shaped like chr_…. Send it in the JSON body, not in the URL path.

idempotency_key
string

Client-generated key used to prevent duplicate session allocation when a create request is retried. On a 429/5xx/timeout, retry the create call with the same idempotency_key; it is safe and will not allocate a duplicate session.

model
string

Overrides the saved model.

max_duration_seconds
integer

Requested maximum session duration in seconds. If omitted, the service-configured default applies. An explicit value must be greater than 3 (minimum 4); 0 is rejected. The service may still close the session for account limits, idle timeout, failures, or maintenance.

recording_mode
string

on or off. Send off to disable recording.

output
object

Overrides the saved output; shallow-merged with the saved object.

delivery
object

Overrides the saved delivery; shallow-merged with the saved object.

Response

200 - application/json

Success

code
integer
required

0 on success; any other value is an error code.

message
string
required

success, or an English error description.

data
object
required