GET
/
api
/
v1
/
characters
Get Characters
curl --request GET \
  --url https://api.jobsim.work/api/v1/characters/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "role": "<string>",
    "name": "<string>",
    "character": "<string>",
    "organization_id": "<string>",
    "_id": "<string>",
    "channels": [
      "<string>"
    ],
    "mentions": [
      "<string>"
    ],
    "periodic_tasks": [
      {
        "name": "<string>",
        "description": "<string>",
        "runs": 123,
        "run_freq": "<string>",
        "jitter_hrs": 123
      }
    ],
    "reply_strategy": [
      {
        "type": "<string>",
        "action": "<string>",
        "mention": "<string>",
        "probability": 123,
        "prompt": "<string>"
      }
    ],
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "core_persona": [
      "<string>"
    ],
    "responsibility": [
      "<string>"
    ],
    "situational_behaviors": [
      {}
    ],
    "timing": {},
    "memory_policy": {}
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

is_active
boolean | null
default:true

Response

Successful Response

role
string
required
name
string
required
character
string
required
organization_id
string
required
_id
string | null
channels
string[]
mentions
string[]
periodic_tasks
PeriodicTask · object[]
reply_strategy
ReplyStrategy · object[]
is_active
boolean
default:true
created_at
string<date-time>
updated_at
string<date-time>
metadata
Metadata · object
core_persona
string[] | null
responsibility
string[] | null
situational_behaviors
Situational Behaviors · object[] | null
timing
Timing · object
memory_policy
Memory Policy · object