Generate Backstory API is implemented as Server Sent Event (SSE). Given some initial description about the character and their name, this API can generate a description for the character.
Headers
Request Body
# Output Format:# The response will be streamed as Server-Sent Events (SSE).# Each event will have a 'data' field containing a string with a part of the backstory.# Example of a single event:data: You step off the train, greeted by the bustling city sounds.# Multiple events will be received, each containing a portion of the backstory.# The full backstory can be assembled by concatenating the 'data' from all events.
{"ERROR":"Invalid API key provided."}
Here are some sample codes to demonstrate the request format for the endpoint -->
import jsonfrom sseclient import SSEClientimport requestsurl ="https://api.convai.com/character/generate-backstory"headers ={'CONVAI-API-KEY':'<Your-API-Key>','Accept':'text/event-stream'}form_data ={"inputText":"Lawyer in the New York City. Achiever. Stubborn.","charName":"Mindy"}# Create a session to manage cookies and keep-alivesession = requests.Session()# Send the POST request with form-data and stream the responseresponse = session.post(url, headers=headers, data=form_data, stream=True)# Create an SSE client from the responseclient =SSEClient(response)# Process the eventsfull_response =""for event in client.events():if event.data: full_response += event.dataprint(full_response)
curl-XPOST'https://api.convai.com/character/generate-backstory' \-H 'CONVAI-API-KEY: <Your-API-Key>' \-H 'Accept: text/event-stream' \-d 'inputText=Lawyer in the New York City. Achiever. Stubborn.' \-d 'charName=Mindy'
Name
Type
Description
Name
Type
Description
CONVAI-API-KEY*
String
The unique api-key provided for every user. Found under the Key icon when logged into your Convai account.
inputText
String
High level character description.
charName
String
Character name for which description is being generated.