Digital Humans

Get All Digital Humans

Changed on

Get all of your digital humans.

get/v1/digital-humans

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/digital-humans
  • Auth
    HTTPBearer (a scheme the document does not define)

Query parameters

page_sizeinteger

Max digital humans per page

pageinteger

Page number (1-based)

type'voicemail_custom' | 'voicemail_ai' | 'replay_smart' | 'replay_strict' | 'red_team' | 'scenario' | 'workflow' | 'persona' | 'journey'

What kind of digital human this is. Stored in test_cases.type; tags are free-form labels.

Only digital humans of this type

tagstring nullable

Only digital humans carrying this exact tag

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

total_countinteger required

Total number of digital humans in the org

pageinteger required

Current page (1-based)

page_sizeinteger required

Page size

total_pagesinteger required

Total number of pages

Changes

  • 52d6410644bbRevision changes
    • info

      added the optional property // to the response with the status

  • 8f67ec69adcfRevision changes
    • info

      added the new optional query request parameter tag

    • info

      added the new optional query request parameter type

    • info

      added the optional property // to the response with the status