Get Character - Charager Gateway

Get Character

curl --request GET \
  --url https://api.charactergateway.com/v1/characters/:slug \
  --header 'authorization: <authorization>'

{
  "slug": "",
  "data": {},
  "tags": [],
  "locale": "en",
  "type": "character",
  "is_draft": false,
  "is_public": false,
  "is_verified": false,
  "is_nsfw": false,
  "n_interactions": 0,
  "trend_score": 0,
  "created_at": "2025-11-26T22:45:34.316Z",
  "updated_at": "2025-11-26T22:45:34.316Z"
}

GET

/

v1

/

characters

/

:slug

Get Character

curl --request GET \
  --url https://api.charactergateway.com/v1/characters/:slug \
  --header 'authorization: <authorization>'

{
  "slug": "",
  "data": {},
  "tags": [],
  "locale": "en",
  "type": "character",
  "is_draft": false,
  "is_public": false,
  "is_verified": false,
  "is_nsfw": false,
  "n_interactions": 0,
  "trend_score": 0,
  "created_at": "2025-11-26T22:45:34.316Z",
  "updated_at": "2025-11-26T22:45:34.316Z"
}

Headers

authorization

string

required

API key for authentication

Example:

"Bearer sk-..."

Path Parameters

slug

string

required

The unique slug identifier for the character

Example:

"c:kate"

Response

Character details successfully retrieved

slug

string

default:""

Unique identifier for the character

data

object

Character data containing details and configurations

Show child attributes

data.name

string

default:""

The character's name

data.short_description

string

default:""

Brief description of the character

data.long_description

string | null

Detailed description of the character

data.first_message

string[] | null

Initial messages the character can send

data.convo_examples

object[] | null

Example conversations with the character

Show child attributes

data.convo_examples.role

enum<string>

default:assistant

Role in the conversation

Available options:

assistant,

user

data.convo_examples.content

string

default:""

Message content

data.creator_comment

string | null

Comment from the character creator

data.image_prompts

object[] | null

Prompts for generating character images

Show child attributes

data.image_prompts.prompt

string

required

Text prompt for image generation

data.image_prompts.url

string | null

URL to the generated image

data.reference_image

object

Reference image for the character

Show child attributes

data.reference_image.prompt

string

required

Text prompt for image generation

data.reference_image.url

string | null

URL to the generated image

data.consistent_images

object[] | null

Consistently styled images for the character

Show child attributes

data.consistent_images.prompt

string

required

Text prompt for the consistent image

data.consistent_images.reference_image_url

string

required

URL to the reference image used

data.consistent_images.url

string

required

URL to the consistent image

tags

string[]

Tags associated with the character

locale

string

default:en

Locale of the character

type

string

default:character

Type of the entity, typically 'character'

is_draft

boolean

default:false

Whether the character is in draft status

is_public

boolean

default:false

Whether the character is publicly available

is_verified

boolean

default:false

Whether the character has been verified

is_nsfw

boolean

default:false

Whether the character contains mature content

n_interactions

number | null

default:0

Number of interactions with the character

trend_score

number | null

default:0

Trend score of the character

created_at

string

default:2025-11-26T22:45:34.316Z

When the character was created

updated_at

string

default:2025-11-26T22:45:34.316Z

When the character was last updated

Chat Completion

⌘I