Speko Docs
API Reference

Voice library

Search every indexed voice by description, similarity, or filters, and read one voice's index entry.

POST
/v1/voices/search

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

{
  "results": [
    {
      "vendor": "string",
      "voiceId": "string",
      "name": "string",
      "gender": "string",
      "languages": [
        "string"
      ],
      "accent": "string",
      "description": "string",
      "styles": [
        "string"
      ],
      "previewUrl": "string",
      "attach": [
        "string"
      ],
      "routerPinnable": true,
      "provenance": "string",
      "score": 0
    }
  ],
  "total": 0,
  "facets": {
    "providers": [
      {
        "vendor": "string",
        "count": 0
      }
    ],
    "accents": [
      {
        "accent": "string",
        "count": 0
      }
    ]
  },
  "indexedTotal": 0
}

{
  "error": "Invalid request",
  "code": "VALIDATION_ERROR",
  "issues": [
    {
      "path": "",
      "message": "At least one search criterion is required"
    }
  ]
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}
{
  "error": {
    "code": "VOICE_NOT_FOUND"
  }
}
GET
/v1/voices/{vendor}/{voiceId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

vendor*string
voiceId*string

Case-sensitive, exactly as the provider spells it.

Response Body

application/json

application/json

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "vendor": "string",
  "voiceId": "string",
  "name": "string",
  "gender": "string",
  "languages": [
    "string"
  ],
  "accent": "string",
  "styles": [
    "string"
  ],
  "description": "string",
  "previewUrl": "string",
  "models": [
    "string"
  ],
  "routerModels": [
    "string"
  ],
  "source": "string",
  "provenance": "string",
  "routerPinnable": true,
  "verifiedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}
{
  "error": {
    "code": "VOICE_NOT_FOUND"
  }
}