GET /api/actor

Retrieve all activated characters. You have to use result.[].actor_id to call /api/speak .

Request

Headers

Parameters

  • None

Example with cURL 
    curl --request GET \
        --url https://typecast.ai/api/actor \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer $API_TOKEN"

Response

Status Code

status code

value

401

Authorization Error

200

JSON Object that has result, actor list(JSON Array)

Element of result consists of followings

key

description

actor_id

string that represents actor’s unique id that is used when creating speak.

name

object that represents actor’s name and key is language code.

en

english name of the actor.

ko

korean name of the actor.
Example 
{
  "result": [
      {
        "actor_id": "5c3c52c9ea9791000747155b",
        "name": {
          "en": "Byumsoo",
          "ko": "범수"
        }
      },
      {
        "actor_id": "5c3c52c9ea9791000747155c",
        "name": {
          "en": "Camila",
          "카밀라": "카밀라"
        }
      }
  ]
}