Convai

Convai Narrative API

The Narrative API from Convai — 11 operation(s) for narrative.

GitHub OpenAPI

Operations 11

POST /character/toggle-is-narrative-driven Toggle Narrative Mode #
POST /character/narrative/create-section Create Narrative Section #
POST /character/narrative/edit-section Edit Narrative Section #
POST /character/narrative/get-section Get Narrative Section #
POST /character/narrative/list-sections List Narrative Sections #
POST /character/narrative/delete-section Delete Narrative Section #
POST /character/narrative/create-trigger Create Narrative Trigger #
POST /character/narrative/update-trigger Update Narrative Trigger #
POST /character/narrative/get-trigger Get Narrative Trigger #
POST /character/narrative/list-triggers List Narrative Triggers #
POST /character/narrative/delete-trigger Delete Narrative Trigger #

Documentation

📖
Documentation
https://docs.convai.com/api-docs/api-reference/core-api-reference
📖
Documentation
https://docs.convai.com/api-docs/api-reference/live-api-reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/openapi/convai-com-narrative-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/json-schema/convai-character-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/json-schema/convai-interaction-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/json-ld/convai-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/convai-com-narrative-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

convai-com-narrative-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Convai Design Narrative API
  version: '1.0'
  description: 'Configure narrative-driven characters using sections and triggers. Sections

    define discrete narrative beats; triggers move the character between

    sections based on conditions. Used to build branching, scripted experiences

    on top of Convai''s conversational AI.

    '
servers:
- url: https://api.convai.com
security:
- ConvaiApiKey: []
tags:
- name: Narrative
paths:
  /character/toggle-is-narrative-driven:
    post:
      summary: Toggle Narrative Mode
      operationId: toggleNarrativeDriven
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              - is_narrative_driven
              properties:
                character_id:
                  type: string
                is_narrative_driven:
                  type: boolean
      responses:
        '200':
          description: Updated
  /character/narrative/create-section:
    post:
      summary: Create Narrative Section
      operationId: createSection
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Section'
      responses:
        '200':
          description: Section created
          content:
            application/json:
              schema:
                type: object
                properties:
                  section_id:
                    type: string
  /character/narrative/edit-section:
    post:
      summary: Edit Narrative Section
      operationId: editSection
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Section'
      responses:
        '200':
          description: Section updated
  /character/narrative/get-section:
    post:
      summary: Get Narrative Section
      operationId: getSection
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              - section_id
              properties:
                character_id:
                  type: string
                section_id:
                  type: string
      responses:
        '200':
          description: Section
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Section'
  /character/narrative/list-sections:
    post:
      summary: List Narrative Sections
      operationId: listSections
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              properties:
                character_id:
                  type: string
      responses:
        '200':
          description: Section list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Section'
  /character/narrative/delete-section:
    post:
      summary: Delete Narrative Section
      operationId: deleteSection
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              - section_id
              properties:
                character_id:
                  type: string
                section_id:
                  type: string
      responses:
        '200':
          description: Section deleted
  /character/narrative/create-trigger:
    post:
      summary: Create Narrative Trigger
      operationId: createTrigger
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Trigger'
      responses:
        '200':
          description: Trigger created
          content:
            application/json:
              schema:
                type: object
                properties:
                  trigger_id:
                    type: string
  /character/narrative/update-trigger:
    post:
      summary: Update Narrative Trigger
      operationId: updateTrigger
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Trigger'
      responses:
        '200':
          description: Trigger updated
  /character/narrative/get-trigger:
    post:
      summary: Get Narrative Trigger
      operationId: getTrigger
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              - trigger_id
              properties:
                character_id:
                  type: string
                trigger_id:
                  type: string
      responses:
        '200':
          description: Trigger
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trigger'
  /character/narrative/list-triggers:
    post:
      summary: List Narrative Triggers
      operationId: listTriggers
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              properties:
                character_id:
                  type: string
      responses:
        '200':
          description: Trigger list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Trigger'
  /character/narrative/delete-trigger:
    post:
      summary: Delete Narrative Trigger
      operationId: deleteTrigger
      tags:
      - Narrative
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              - trigger_id
              properties:
                character_id:
                  type: string
                trigger_id:
                  type: string
      responses:
        '200':
          description: Trigger deleted
components:
  schemas:
    Section:
      type: object
      required:
      - character_id
      - section_name
      - objective
      properties:
        character_id:
          type: string
        section_id:
          type: string
        section_name:
          type: string
        objective:
          type: string
        behavior_tree_code:
          type: string
        updates_player_persona:
          type: boolean
    Trigger:
      type: object
      required:
      - character_id
      - trigger_name
      properties:
        character_id:
          type: string
        trigger_id:
          type: string
        trigger_name:
          type: string
        trigger_message:
          type: string
        destination_section:
          type: string
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY