Requests and Responses

Currently we only have 2 API endpoints, which are execute Prompts and execute Workflows. You can use the endpoints to deploy individual prompts or the whole workflow.

Prompt ID

All prompts have a unique id used to reference it. You can find the id at the end of the URL:

The prompt ID for this example is 3132

Execute Prompt

Execute a prompt

POSThttps://pms.chasm.net/api/prompts/execute/{id}

Authorization

bearerAuth

Path parameters

id*string

The prompt ID

Body

application/json

inputobject

Response

201400401403422429500502503

Successfully executed prompt

Request

JavaScriptCurlPython

const response = await fetch('https://pms.chasm.net/api/prompts/execute/{id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

API Examples

This example API involves a prompt that uses a character's information as inputs to generate a background story.

These are some sample parameters to make the prompt API work:

Parameters	Description	Example
{{ Your API Key }}	Your API token	eyJhbGciOiJ......vd7OADOMAQ
input	Your list of inputs in the prompt.	{ "name": "Alaric", "age": "30", "physical traits": "strong, kind" }
URL	URL to execute a specific prompt by its ID	https://pms.chasm.net/api/prompts/execute/3129

Sample Request

Curl

curl --location 'https://pms.chasm.net/api/prompts/execute/3129' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ Your API Key }}' \
--data '{"input":{"name":"Alaric","age":30,"physical traits":"strong, kind"}}'

JavaScript - Fetch

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer {{ Your API Key }}");

const raw = JSON.stringify({
  "input": {
    "name": "Alaric",
    "age": 30,
    "physical traits": "strong, kind"
  }
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://pms.chasm.net/api/prompts/execute/3129", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Python - Requests

import requests
import json

url = "https://pms.chasm.net/api/prompts/execute/3129"

payload = json.dumps({
  "input": {
    "name": "Alaric",
    "age": 30,
    "physical traits": "strong, kind"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{ Your API Key }}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Sample Response

{
    "result": {
        "content": "Name: Alaric\n Age: 30\n Physical Traits: Strong and muscular, with a commanding presence\n Backstory: Alaric is a seasoned warrior, known for his strength and kindness. He hails from a noble lineage and has been a protector of his people for many years. His unwavering dedication to justice and his ability to inspire others make him a natural leader.",
        "status": "length",
        "completionTime": 3147.252650976181,
        "tokens_in": 236,
        "tokens_out": 227,
        "amount_usd": 0.000513,
        "amount_credit": 0.0513,
        "credit_balance": 443.21589
    }
}

---

Workflow ID

All workflows have a unique id used to reference it. You can find the id at the end of the URL:

The workflow ID for this example is 785

Execute Workflow

Execute a workflow

POSThttps://pms.chasm.net/api/workflows/execute/{id}

Authorization

bearerAuth

Path parameters

id*string

The workflow ID

Body

application/json

inputobject

Response

201400401403422429500502

Successfully executed workflow

Request

JavaScriptCurlPython

const response = await fetch('https://pms.chasm.net/api/workflows/execute/{id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

API Examples

This example API involves a workflow that combines the information of two characters from a previously generated prompt and creates a story based on the given input.

These are some sample parameters to make the workflow API work:

Parameters	Description	Example
{{ Your API Key }}	Your API token	eyJhbGciOiJ......vd7OADOMAQ
input	The list of global inputs in the workflow.	{ "name": "Alaric", "age": "30", "physical traits": "strong, kind", "name2": "Mary", "age2": "28", "physical traits2": "swift" }
URL	URL to execute a specific workflow by its ID	https://pms.chasm.net/api/workflows/execute/785

Sample Request

Curl

curl --location 'https://pms.chasm.net/api/workflows/execute/785' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ Your API Key }}' \
--data '{"input":{"name":"Alaric","age":"30","physical traits":"strong, kind","name2":"Mary","age2":"28","physical traits2":"swift"}}'

JavaScript - Fetch

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer {{ Your API Key }}");

const raw = JSON.stringify({
  "input": {
    "name": "Alaric",
    "age": "30",
    "physical traits": "strong, kind",
    "name2": "Mary",
    "age2": "28",
    "physical traits2": "swift"
  }
});

const requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://pms.chasm.net/api/workflows/execute/785", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Python - Requests

import requests
import json

url = "https://pms.chasm.net/api/workflows/execute/785"

payload = json.dumps({
  "input": {
    "name": "Alaric",
    "age": "30",
    "physical traits": "strong, kind",
    "name2": "Mary",
    "age2": "28",
    "physical traits2": "swift"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{ Your API Key }}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Sample Response

{
    "Intro": "Alaric and Mary found themselves face to face on the battlefield. Alaric, with his imposing stature, swung his sword with the force of a thunderstorm, while Mary, swift and agile, darted around him like a playful breeze.\n\"Ha! You're quick, I'll give you that,\" Alaric grunted, impressed by Mary's nimbleness as she dodged his attacks.",
    "Climax": "Mary's eyes sparkling with mischief as she evaded Alaric's powerful strikes with ease.\nDespite their differences in fighting styles, they found a strange harmony in their battle, a mutual respect growing between them with every exchange.\nAs their fight drew to a close, both combatants paused, panting and grinning at each other.",
    "Resolution": "You fight well, Mary,\" Alaric said.\n\"Likewise, Alaric.\" Mary replied, a playful glint in her eyes.\nWith a nod of mutual respect, they sheathed their swords, their fight ending not with animosity, but with newfound camaraderie. As they walked away from the battlefield, their laughter echoed in the air, two warriors who had met as adversaries and emerged as unlikely friends."
}