Skip to main content
POST
Generates the values of a recording AI field on a list of recordings or on the recordings of a view, asynchronously. By default only the recordings without a value are processed, and only those with a ready transcript that the creator can edit. Set estimateOnly to get the recording count and estimatedCredits without starting the generation. See Generations.

Authorizations

X-Claap-Key
string
header
required

Path Parameters

fieldId
string
required

Recording AI field identifier

Body

application/json
creatorEmail
string<email>
required

Email address of the generation author. It must belong to an active workspace member.

recordingIds
string[]

Generate the field on these recordings, at most 1,000 identifiers: use viewId for larger sets. Exactly one of recordingIds and viewId is required.

Required array length: 1 - 1000 elements
viewId
string

Generate the field on the recordings of this view instead of listing their identifiers. Use GET /v1/recordings/views to discover views.

mode
enum<string>
default:FillMissing

FillMissing only generates the recordings without a value, Recompute regenerates every recording.

Available options:
FillMissing,
Recompute
estimateOnly
boolean
default:false

Return totalCount and estimatedCredits without starting the generation.

Response

Recording AI field generation was successfully started

result
object
required

The outcome of an AI field generation request.