Made in 10Docs
GuidesAPI
ReferencePresenting

Set a character's presenting

Replaces the whole setting; what is left out goes back to its default (`deck_ids` to none, `mode` to `on_demand`, `instruction` to empty).

PUT
/characters/{character_id}/presenting

Authorization

secretKey
headerAuthorizationBearer <sk_live_… or sk_test_… (a prefix and 40 base62 characters)>

A secret key from the dashboard, sent as Authorization: Bearer sk_live_…. Live keys run real, charged calls; test keys (sk_test_…) run calls of at most 60 seconds, 20 a day per organization, never charged. Each key sees only its own env's calls, meetings, webhooks, memories and analytics. Publishable keys (pk_…) are refused.

Path Parameters

character_id*string

The character's id.

Match^chr_[0-9A-Za-z]{20}$
Example"chr_4fT9kQ2mXw7LbN3pZs8V"

Request Body

application/json
  1. body
deck_ids?array<>

The decks, in order; a repeat keeps its first place.

Itemsitems <= 10
mode?PresentingMode

on_demand (the default): the character shows a slide when the conversation calls for one. walk_the_deck: it presents the first deck from its first slide, stopping for questions.

Value in"on_demand""walk_the_deck"
instruction?string

How to present the material.

Lengthlength <= 2000

Response Body

The setting as it now is.

application/json
  1. response
mode*PresentingMode

on_demand (the default): the character shows a slide when the conversation calls for one. walk_the_deck: it presents the first deck from its first slide, stopping for questions.

Value in"on_demand""walk_the_deck"
instruction*string
Lengthlength <= 2000
deck_ids*array<>
decks*array<>

The same decks with their titles and their slides' state.

Example Request
curl -X PUT 'https://api.daxov.com/v1/characters/chr_4fT9kQ2mXw7LbN3pZs8V/presenting' \  -H 'Content-Type: application/json' \  -d '{  "deck_ids": [    "doc_1Qm6Tx3KcW8vRp5ZbN2h"  ],  "mode": "walk_the_deck",  "instruction": "Keep it under five minutes and stop for questions after the prices."}'
Example Response
{  "mode": "on_demand",  "instruction": "string",  "deck_ids": [    "doc_1Qm6Tx3KcW8vRp5ZbN2h"  ],  "decks": [    {      "id": "doc_1Qm6Tx3KcW8vRp5ZbN2h",      "title": "string",      "slides": {        "status": "processing",        "count": 0,        "error": "string"      }    }  ]}