> ## Documentation Index > Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Interview > Read one interview's public metadata and a bounded page of transcript messages. ## OpenAPI ````yaml /api-reference/openapi.json get /api/public/v1/interviews/{interview_id} openapi: 3.1.0 info: title: User Intuition Public API description: >- ## Public Integration API Programmatic access to User Intuition for external integrators: manage studies, participants, interviews, reports, and panels. ### Authentication All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`, created in the dashboard) or a dashboard JWT: ``` Authorization: Bearer ``` ### Base URLs - **Production:** `https://api.userintuition.ai` - **Staging:** `https://staging.userintuition.ai` ### Support For API support, contact support@userintuition.ai version: 1.0.0 contact: name: User Intuition Support email: support@userintuition.ai servers: - url: https://api.userintuition.ai description: Production - url: https://staging.userintuition.ai description: Staging security: - BearerAuth: [] paths: /api/public/v1/interviews/{interview_id}: get: tags: - public-interviews summary: Get Interview description: >- Read one interview's public metadata and a bounded page of transcript messages. operationId: getInterview parameters: - name: interview_id in: path required: true schema: type: string title: Interview Id example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee - name: message_offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Message Offset - name: message_limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: >- Maximum segments; the response also stops near 20 KB of transcript text default: 50 title: Message Limit description: >- Maximum segments; the response also stops near 20 KB of transcript text - name: redact_pii in: query required: false schema: type: boolean description: >- Mask email addresses, phone numbers, and US Social Security numbers in transcript and screener text; omit participant email and recording links. Pattern masking cannot detect every identifier. default: false title: Redact Pii description: >- Mask email addresses, phone numbers, and US Social Security numbers in transcript and screener text; omit participant email and recording links. Pattern masking cannot detect every identifier. - name: X-UI-Organization-ID in: header required: false schema: anyOf: - type: string maxLength: 128 - type: 'null' description: >- Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet. title: X-Ui-Organization-Id description: >- Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublicInterview' '422': description: Public API error. X-Request-ID matches error.request_id. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' default: description: Public API error. X-Request-ID matches error.request_id. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' components: schemas: PublicInterview: properties: id: type: string title: Id study_id: anyOf: - type: string - type: 'null' title: Study Id description: The study this interview belongs to participant: anyOf: - $ref: '#/components/schemas/PublicInterviewParticipant' - type: 'null' description: >- null for synthetic, anonymous panel, external-panel, or open-link interviews participant_source: type: string enum: - byop - panel - external_panel - link - synthetic - unknown title: Participant Source description: >- Recruitment source; synthetic, anonymous panel and open-link respondents have no public person identity status: anyOf: - type: string - type: 'null' title: Status quality: anyOf: - type: string - type: 'null' title: Quality description: 'Quality rating: Excellent, Good, Fair, or Poor' ended_because: anyOf: - type: string enum: - completed - participant_left - time_limit - technical_error - screened_out - type: 'null' title: Ended Because description: >- Why the interview ended; null if the stored reason cannot be classified started_at: anyOf: - type: string format: date-time - type: 'null' title: Started At description: Date and time the interview took place ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At description: Date and time the interview ended interview_format: anyOf: - type: string enum: - chat - video - voice - type: 'null' title: Interview Format description: Stored interview mode; null when the historical mode is unknown language: anyOf: - type: string - type: 'null' title: Language description: >- Current configured study language, not a detected transcript language; historical interviews may have used an earlier configuration duration_seconds: anyOf: - type: integer - type: 'null' title: Duration Seconds description: Interview length in seconds (ended_at - started_at) pii_redacted: type: boolean title: Pii Redacted description: >- True when common structured identifiers were masked and direct identity/media links omitted; this does not guarantee all PII was detected default: false messages: anyOf: - items: $ref: '#/components/schemas/PublicTranscriptSegment' type: array - type: 'null' title: Messages description: >- Spoken segments (up to message_limit and about 20 KB). Each has id, role, message, text_offset, and start_s/end_s when stored timing exists. total_message_segments: type: integer title: Total Message Segments default: 0 next_message_offset: anyOf: - type: integer - type: 'null' title: Next Message Offset audio_recording_url: anyOf: - type: string - type: 'null' title: Audio Recording Url video_recording_url: anyOf: - type: string - type: 'null' title: Video Recording Url screener_responses: anyOf: - items: $ref: '#/components/schemas/PublicScreenerResponse' type: array - type: 'null' title: Screener Responses description: The participant's screener answers for this interview. type: object required: - id - participant_source title: PublicInterview description: Interview detail with bounded, paged speech segments. PublicApiErrorResponse: type: object required: - detail - error properties: detail: description: Legacy error detail; may be a string, list, or object. error: $ref: '#/components/schemas/PublicApiError' PublicInterviewParticipant: properties: id: anyOf: - type: string - type: 'null' title: Id description: BYOP invitation ID, not a deduplicated person ID email: anyOf: - type: string - type: 'null' title: Email type: object title: PublicInterviewParticipant PublicTranscriptSegment: properties: id: type: string title: Id description: Original transcript turn ID; split segments retain the same ID role: type: string enum: - participant - moderator title: Role message: type: string title: Message text_offset: anyOf: - type: integer - type: 'null' title: Text Offset description: Character offset within the original turn start_s: anyOf: - type: number - type: 'null' title: Start S description: Stored seconds from interview start end_s: anyOf: - type: number - type: 'null' title: End S description: Stored seconds from interview start additionalProperties: false type: object required: - id - role - message title: PublicTranscriptSegment PublicScreenerResponse: properties: question: anyOf: - type: string - type: 'null' title: Question description: The screener question text type: anyOf: - type: string - type: 'null' title: Type description: single_select, multi_select, or text_input answer: anyOf: - type: string - type: 'null' title: Answer description: The participant's answer (option text(s) or free text) type: object title: PublicScreenerResponse PublicApiError: type: object required: - code - message - field - request_id - outcome - recovery_action - docs_url properties: code: type: string message: type: string field: anyOf: - type: string - type: 'null' request_id: type: string format: uuid outcome: type: string enum: - not_started - failed - unknown recovery_action: type: string docs_url: type: string format: uri securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.