Skip to content
torqee Developers
Esc
↑↓navigate↵open⌘Jpreview

Search transcripts

Searches transcript text in the workspace and returns matching transcripts with revision metadata, session summaries, and snippets. Results can be filtered by revision kind. Requires the torqee:transcripts:read scope.

GET/api/v1/transcripts/search
Authorization
AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 authorization code flow with PKCE. Audience must be the connect URL.

Scopes:torqee:transcripts:read
or
AuthorizationBearer token · headerrequired

Workspace API key issued from the torqee web app. Pass the torqee_-prefixed key as the bearer token. API keys carry the same read scopes as OAuth tokens.

Query parameters
querystringrequired
min length 1
limitinteger
min 1 · max 100
revisionKindstring

Transcript revision: committed is realtime and final is generated after recording.

Allowed:committedfinal
Responses
200

Transcripts that match the query, with session context

itemsobject[]required
Show properties
Array of object
transcriptIdstringrequired
revisionKindstringrequired

Transcript revision: committed is realtime and final is generated after recording.

Allowed:committedfinal
sessionobjectrequired
Show properties
idstringrequired
labelstring | nullrequired
statusstringrequired
startedAtstring | nullrequired
endedAtstring | nullrequired
createdAtstringrequired
snippetstringrequired
nextCursorstring | nullrequired
400

Invalid search parameters

errorstringrequired
Allowed:invalid_request
401

Missing or invalid credentials

errorstringrequired
Allowed:unauthorized
403

Membership revoked or insufficient scope

errorstringrequired
Allowed:insufficient_scopeforbidden
404

Tenant database could not be resolved for the workspace

errorstringrequired
Allowed:workspace_not_found
500

Unexpected server error

errorstringrequired
Allowed:internal_server_error
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://connect.torqee.app/api/v1/transcripts/search?query=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "items": [
    {
      "transcriptId": "string",
      "revisionKind": "committed",
      "session": {
        "id": "string",
        "label": "string",
        "status": "string",
        "startedAt": "string",
        "endedAt": "string",
        "createdAt": "string"
      },
      "snippet": "string"
    }
  ],
  "nextCursor": "string"
}

Was this page helpful?