> ## Documentation Index
> Fetch the complete documentation index at: https://docs.venice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Character

> This is a preview API and may change. Returns a single character by its slug.

## Experimental Endpoint

<Warning>
  This is an experimental endpoint and may be subject to change.
</Warning>

## Postman Collection

For additional examples, please see this [Postman Collection](https://www.postman.com/veniceai/workspace/062d2eda-cd10-4f2f-83b4-083178d85fc5/request/38652128-8cca56f0-e7b7-4afa-855a-c41f9a6d53e2?action=share\&source=copy-link\&creator=48156591\&ctx=documentation).


## OpenAPI

````yaml GET /characters/{slug}
openapi: 3.0.0
info:
  description: The Venice.ai API.
  termsOfService: https://venice.ai/legal/tos
  title: Venice.ai API
  version: '20260626.184905'
  x-guidance: >-
    Venice.ai is an OpenAI-compatible inference API supporting text, image,
    audio, and video generation.


    **Authentication options:**

    - API Key: Use Bearer token in Authorization header

    - x402 Wallet: Use USDC credits via EVM or Solana wallet (no account
    required)


    **For x402 wallet access:**

    1. POST /x402/top-up without headers to get payment requirements

    2. Choose one of the returned Base or Solana payment options and sign a USDC
    payment using the x402 SDK

    3. POST /x402/top-up with PAYMENT-SIGNATURE header to add credits

    4. Call any inference endpoint with SIGN-IN-WITH-X header


    **Pricing:** Prepaid credits consumed per request. Check /models for
    available models and their capabilities.
servers:
  - url: https://api.venice.ai/api/v1
security:
  - BearerAuth: []
tags:
  - description: >-
      Generate speech/audio, transcribe audio, and manage asynchronous audio
      generation jobs.
    name: Audio
  - description: >-
      Given a list of messages comprising a conversation, the model will return
      a response. Supports multimodal inputs including text, images, audio
      (input_audio), and video (video_url) for compatible models.
    name: Chat
  - description: List and describe the various models available in the API.
    name: Models
  - description: Generate and manipulate images using AI models.
    name: Image
  - description: Generate videos using AI models.
    name: Video
  - description: List and retrieve character information for use in completions.
    name: Characters
  - description: >-
      Billing and usage analytics. **Beta**: This API is currently in beta and
      may be unstable. Endpoints, request/response schemas, and behavior may
      change without notice.
    name: Billing
  - description: Proxy JSON-RPC requests to blockchain nodes. Billed per credit.
    name: Crypto RPC
  - description: >-
      Wallet-based API access using the x402 protocol. No API key required —
      authenticate with an EVM or Solana wallet.


      **How it works:**

      1. **Authenticate** — Send a `SIGN-IN-WITH-X` header (base64-encoded
      signed SIWX payload) with any request. EVM wallets sign an EIP-4361 SIWE
      message; Solana wallets sign the Solana SIWX message with Ed25519. See the
      `siwx` security scheme for the exact format.

      2. **Top up** — `POST /x402/top-up` without a payment header returns an
      `accepts` array with Base and Solana USDC payment options. Choose one
      entry, sign it using the x402 SDK (`npm install x402`), and re-submit with
      the `PAYMENT-SIGNATURE` header (the legacy `X-402-Payment` and `X-PAYMENT`
      names are also accepted).

      3. **Use any endpoint** — All inference endpoints (chat, image, audio,
      video, embeddings) accept `siwx` as an alternative to `BearerAuth`.
      Charges are deducted from your USDC credit balance.

      4. **Monitor balance** — `GET /x402/balance/{walletAddress}` returns your
      current balance. The `X-Balance-Remaining` response header on inference
      calls also reports it.


      **Quick start (5 lines):**

      ```

      import { VeniceClient } from '@venice-ai/x402-client'

      const venice = new VeniceClient(process.env.WALLET_KEY)

      await venice.topUp(10) // $10 USDC on a supported x402 rail

      const res = await venice.chat({ model: 'zai-org-glm-5-1', messages: [{
      role: 'user', content: 'Hello!' }] })

      ```


      **Payment:** USDC on Base (chain ID 8453) or Solana mainnet. Minimum
      top-up: $5. Alternatively, stake DIEM tokens for daily credits (1 DIEM =
      $1/day).
    name: x402
externalDocs:
  description: Venice.ai API documentation
  url: https://docs.venice.ai
paths:
  /characters/{slug}:
    get:
      tags:
        - Characters
        - Preview
      summary: /api/v1/characters/{slug}
      description: >-
        This is a preview API and may change. Returns a single character by its
        slug.
      operationId: getCharacterBySlug
      parameters:
        - description: The slug of the character to retrieve
          in: path
          name: slug
          required: true
          schema:
            example: alan-watts
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      adult:
                        type: boolean
                        description: Whether the character is considered adult content
                        example: false
                      author:
                        type: string
                        description: >-
                          Short anonymized identifier derived from the character
                          author
                        example: k3x9q
                      createdAt:
                        type: string
                        description: Date when the character was created
                        example: '2024-12-20T21:28:08.934Z'
                      description:
                        type: string
                        nullable: true
                        description: Description of the character
                        example: >-
                          Alan Watts (6 January 1915 – 16 November 1973) was a
                          British and American writer, speaker, and self-styled
                          "philosophical entertainer", known for interpreting
                          and popularizing Buddhist, Taoist, and Hindu
                          philosophy for a Western audience.
                      featured:
                        type: boolean
                        description: >-
                          Whether the character is featured in public discovery
                          surfaces
                        example: false
                      id:
                        type: string
                        description: Unique ID of the character
                        example: 2f460055-7595-4640-9cb6-c442c4c869b0
                      name:
                        type: string
                        description: Name of the character
                        example: Alan Watts
                      shareUrl:
                        type: string
                        nullable: true
                        description: Share URL of the character
                        example: https://venice.ai/c/alan-watts
                      photoUrl:
                        type: string
                        nullable: true
                        description: URL of the character photo
                        example: >-
                          https://outerface.venice.ai/api/characters/2f460055-7595-4640-9cb6-c442c4c869b0/photo
                      slug:
                        type: string
                        description: >-
                          Slug of the character to be used in the completions
                          API
                        example: alan-watts
                      stats:
                        type: object
                        properties:
                          averageRating:
                            type: number
                            description: Average rating for the character
                            example: 4.7
                          imports:
                            type: number
                            description: Number of imports for the character
                            example: 112
                          ratingCount:
                            type: number
                            description: Number of ratings for the character
                            example: 24
                          ratingSum:
                            type: number
                            description: Sum of all rating values for the character
                            example: 113
                          userRating:
                            type: number
                            nullable: true
                            description: >-
                              The authenticated user rating for the character
                              when available
                        required:
                          - averageRating
                          - imports
                          - ratingCount
                          - ratingSum
                          - userRating
                      tags:
                        type: array
                        items:
                          type: string
                        description: Tags associated with the character
                        example:
                          - AlanWatts
                          - Philosophy
                          - Buddhism
                          - Taoist
                          - Hindu
                      updatedAt:
                        type: string
                        description: Date when the character was last updated
                        example: '2025-02-09T03:23:53.708Z'
                      webEnabled:
                        type: boolean
                        description: Whether the character is enabled for web use
                        example: true
                      modelId:
                        type: string
                        description: API model ID for the character
                        example: venice-uncensored-1-2
                    required:
                      - adult
                      - author
                      - createdAt
                      - description
                      - featured
                      - id
                      - name
                      - shareUrl
                      - photoUrl
                      - slug
                      - stats
                      - tags
                      - updatedAt
                      - webEnabled
                      - modelId
                  object:
                    type: string
                    enum:
                      - character
                required:
                  - data
                  - object
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
        '404':
          description: Character not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
        '500':
          description: An unknown error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
components:
  schemas:
    StandardError:
      type: object
      properties:
        error:
          type: string
          description: A description of the error
      required:
        - error
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````