Voice

Server

Download schema

获取account · voice profile

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/account/voice-profile

获取account · voice profile › Responses

请求成功

VoiceProfileResponse

required

删除account · voice profile

DELETE

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/account/voice-profile

删除account · voice profile › Responses

请求成功

DeleteVoiceProfileResponse

deleted

boolean · required

创建或执行account · voice profile · enrollments

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/account/voice-profile/enrollments

创建或执行account · voice profile · enrollments › Request Body

CreateVoiceProfileEnrollmentRequest

consentVersion

string · required

创建或执行account · voice profile · enrollments › Responses

请求成功

CreateVoiceProfileEnrollmentResponse

object · required

VoiceProfileModelManifest · required

POST/v1/account/voice-profile/enrollments

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/account/voice-profile/enrollments \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "consentVersion": "consentVersion"
}'

Example Request Body

{
  "consentVersion": "consentVersion"
}

json

Example Responses

{
  "enrollment": {
    "id": "id",
    "consentVersion": "consentVersion",
    "expiresAt": "expiresAt"
  },
  "model": {
    "runtime": "sherpa-onnx",
    "runtimeVersion": "1.13.2",
    "modelVersion": "3dspeaker-campplus-zh-en-advanced-v1",
    "fileName": "3dspeaker_speech_campplus_sv_zh_en_16k-common_advanced.onnx",
    "sha256": "aa3cfc16963a10586a9393f5035d6d6b57e98d358b347f80c2a30bf4f00ceba2",
    "sizeBytes": 28281164,
    "embeddingDimension": 192,
    "sampleRate": 16000,
    "downloadPath": "downloadPath"
  }
}

json

application/json

设置account · voice profile · enrollments · enrollmentId

PUT

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/account/voice-profile/enrollments/{enrollmentId}

设置account · voice profile · enrollments · enrollmentId › path Parameters

enrollmentId

string · required

设置account · voice profile · enrollments · enrollmentId › Request Body

SaveVoiceProfileEnrollmentRequest

modelVersion

string · const · required

Const value: 3dspeaker-campplus-zh-en-advanced-v1

embeddings

array[] · required

expectedRevision

number | null · required

设置account · voice profile · enrollments · enrollmentId › Responses

请求成功

GenericResponse

获取account · voice profile · models · modelVersion

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/account/voice-profile/models/{modelVersion}

获取account · voice profile · models · modelVersion › path Parameters

modelVersion

string · required

获取account · voice profile · models · modelVersion › Responses

请求成功

GenericResponse

创建或执行sessions · sessionId · speakers · speakerId · voice opt out

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/sessions/{sessionId}/speakers/{speakerId}/voice-opt-out

创建或执行sessions · sessionId · speakers · speakerId · voice opt out › path Parameters

sessionId

string · required

speakerId

string · required

创建或执行sessions · sessionId · speakers · speakerId · voice opt out › Request Body

GenericRequest

创建或执行sessions · sessionId · speakers · speakerId · voice opt out › Responses

请求成功

OptOutSessionSpeakerResponse

optedOut

boolean · required

deletedIdentity

boolean · required

object · required

获取workspace · voice identities

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities

获取workspace · voice identities › Responses

请求成功

WorkspaceVoiceIdentityListResponse

WorkspaceVoiceIdentity[] · required

GET/v1/workspace/voice-identities

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workspace/voice-identities

Example Responses

{
  "identities": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "displayName": "displayName",
      "status": "candidate",
      "hasPreview": true,
      "modelVersion": "3dspeaker-campplus-zh-en-advanced-v1",
      "sampleCount": 0,
      "confidence": 0,
      "firstSeenSessionId": "firstSeenSessionId",
      "lastSeenAt": "lastSeenAt",
      "expiresAt": "expiresAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt",
      "occurrences": [
        {
          "sessionId": "sessionId",
          "sessionTitle": "sessionTitle",
          "speakerId": "speakerId",
          "updatedAt": "updatedAt"
        }
      ]
    }
  ]
}

json

application/json

获取workspace · voice identities · identityId

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/{identityId}

获取workspace · voice identities · identityId › path Parameters

identityId

string · required

获取workspace · voice identities · identityId › Responses

请求成功

WorkspaceVoiceIdentityDetailResponse

WorkspaceVoiceIdentity · required

WorkspaceVoiceIdentityUtterance[] · required

GET/v1/workspace/voice-identities/{identityId}

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workspace/voice-identities/:identityId

Example Responses

{
  "identity": {
    "id": "id",
    "workspaceId": "workspaceId",
    "displayName": "displayName",
    "status": "candidate",
    "hasPreview": true,
    "modelVersion": "3dspeaker-campplus-zh-en-advanced-v1",
    "sampleCount": 0,
    "confidence": 0,
    "firstSeenSessionId": "firstSeenSessionId",
    "lastSeenAt": "lastSeenAt",
    "expiresAt": "expiresAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "occurrences": [
      {
        "sessionId": "sessionId",
        "sessionTitle": "sessionTitle",
        "speakerId": "speakerId",
        "updatedAt": "updatedAt"
      }
    ]
  },
  "utterances": [
    {
      "sessionId": "sessionId",
      "sessionTitle": "sessionTitle",
      "speakerId": "speakerId",
      "segmentId": "segmentId",
      "text": "text",
      "createdAt": "createdAt"
    }
  ]
}

json

application/json

删除workspace · voice identities · identityId

DELETE

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/{identityId}

删除workspace · voice identities · identityId › path Parameters

identityId

string · required

删除workspace · voice identities · identityId › Responses

请求成功

DeleteWorkspaceVoiceIdentityResponse

deleted

boolean · required

anonymizedSessions

number · required

更新workspace · voice identities · identityId

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/{identityId}

更新workspace · voice identities · identityId › path Parameters

identityId

string · required

更新workspace · voice identities · identityId › Request Body

UpdateWorkspaceVoiceIdentityRequest

displayName

string

status

string · enum

Enum values:

active

conflicted

disabled

更新workspace · voice identities · identityId › Responses

请求成功

GenericResponse

创建或执行workspace · voice identities · identityId · merge

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/{identityId}/merge

创建或执行workspace · voice identities · identityId · merge › path Parameters

identityId

string · required

创建或执行workspace · voice identities · identityId · merge › Request Body

MergeWorkspaceVoiceIdentityRequest

targetIdentityId

Identifier · required

创建或执行workspace · voice identities · identityId · merge › Responses

请求成功

GenericResponse

获取workspace · voice identities · identityId · preview

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/{identityId}/preview

获取workspace · voice identities · identityId · preview › path Parameters

identityId

string · required

获取workspace · voice identities · identityId · preview › Responses

请求成功

GenericResponse

创建或执行workspace · voice identities · identityId · split

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/{identityId}/split

创建或执行workspace · voice identities · identityId · split › path Parameters

identityId

string · required

创建或执行workspace · voice identities · identityId · split › Request Body

SplitWorkspaceVoiceIdentityRequest

sessionId

Identifier · required

speakerId

Identifier · required

创建或执行workspace · voice identities · identityId · split › Responses

请求成功

GenericResponse

获取workspace · voice identities · model

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/model

获取workspace · voice identities · model › Responses

请求成功

GenericResponse

获取workspace · voice identities · model · download

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/voice-identities/model/download

获取workspace · voice identities · model · download › Responses

请求成功

GenericResponse

Reviews Billing