research

Get interview previews (v3)

Supports original MP3 and WAV audio alongside the existing study media. Get one sample interview by run id and business profile: its status (running, succeeded, or failed), the customer twin's name, and the transcript so far, with the file or video each question showed. A sample belongs to the user who started it, so an API key cannot read one.

get/api/v1/research/interview-previews-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/interview-previews-v3/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

The sample's run id.

Query parameters

businessProfileIdstring uuid required

The profile the sample was started on.

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

runIdstring uuid required
status'running' | 'succeeded' | 'failed' required

The sample interview's own outcome, not any campaign synthesis.

customerNamestring required

Changes

No recorded changes to this operation across all 1 revision of this API.