{spaceId}/recordings/{recordingId}/insightsCreate insight
This will create a new AI insight for a prompt and additional customisations / tweaks that you want to apply only to this generation.
Note: Currently prompts cannot be created using API - this makes sense as we don't expect prompts to change frequently.
Authorization
x-api-key<token>
In: header
Request Body
application/jsonOptionalpromptIdRequiredstring
Id of the prompt to use for this insight generation.
How to get prompt id:
- Go to insights tab of a recording in your dashboard
- Find a suitable prompt from the prompt library or create your own prompt
- Generate an insight with this prompt (optional: tweak the prompt as you see fit)
- Now use the Get insights endpoint to find the promptId
tweakQuerystring
Any additional tweaks or requests you want to inject into the prompt used to generate the insight.
This is a good way to provide requests specific to this recording without having to edit the prompt itself.
Path Parameters
spaceIdRequiredstring
ID of the workspace. You can find from the url in dashboard when you open the workspace or using the list workspaces endpoint.
recordingIdRequiredstring
ID of the recording. You can find from the url in dashboard when you open the workspace or using the list recordings endpoint.
AI models can take a few minutes to complete so, this endpoint can take much longer than our other endpoints