> ## Documentation Index
> Fetch the complete documentation index at: https://woku.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Capture a woku review or NPS response from the mobile SDK



## OpenAPI

````yaml /openapi-v1.json post /v1/captures
openapi: 3.0.0
info:
  title: Woku Client API v1
  description: >-
    Public REST API for programmatic management of woku Voice-of-Customer
    programs: trackers, VoC instruments (NPS, woku, CES, CSAT), action plans,
    support tickets, multi-channel sending and response capture. Requests are
    company-scoped by the API key; never send a company id.
  version: 1.0.0
  contact:
    name: Woku
    url: https://woku.app
    email: team@woku.app
servers:
  - url: https://clientapi.woku.app
    description: Production
security: []
tags: []
paths:
  /v1/captures:
    post:
      tags:
        - v1 - captures
      summary: Capture a woku review or NPS response from the mobile SDK
      operationId: V1CapturesController_capture
      parameters:
        - name: authorization
          required: true
          in: header
          schema:
            type: string
        - name: x-woku-idempotency-key
          required: true
          in: header
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CaptureBodyDto'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/V1CaptureBodyDto'
      responses:
        '201':
          description: Capture accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CaptureResultDto'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponseDto'
      security:
        - PublishableKey: []
        - bearer: []
components:
  schemas:
    V1CaptureBodyDto:
      type: object
      properties:
        dispatchToken:
          type: string
          description: >-
            Opaque invitation or prepared journey-entry response token. Consumed
            after saving feedback; never stored on the review.
          maxLength: 64
        id:
          type: string
          description: Client-generated idempotency id
        kind:
          type: string
          enum:
            - woku
            - nps
            - csat
            - ces
          example: woku
        language:
          type: string
          description: Spoken language. Required when the capture includes an audio file.
          enum:
            - es
            - en
        targetId:
          type: string
          description: >-
            Target id: the wokuId for a woku capture, the (optional) npsToolId
            for an NPS capture, or the (required) csatToolId/cesToolId for a
            CSAT/CES capture (those tools are always custom).
        rating:
          type: number
          description: Woku star rating 1-5
          example: 5
        score:
          type: number
          description: NPS score 0-10
          example: 9
        comment:
          type: string
          description: Free-text comment
          maxLength: 3000
        audio:
          $ref: '#/components/schemas/V1CaptureAudioDto'
        respondent:
          $ref: '#/components/schemas/V1CaptureRespondentDto'
      required:
        - kind
    V1CaptureResultDto:
      type: object
      properties:
        id:
          type: string
          description: Client submission id, echoed without replacing the server id.
        kind:
          type: string
          enum:
            - woku
            - nps
            - csat
            - ces
        remoteId:
          type: string
          description: Server id of the created feedback resource.
        status:
          type: string
          enum:
            - accepted
      required:
        - kind
        - status
    ValidationErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 400
        message:
          description: Array of validation error messages
          example:
            - email must be a valid email
            - password must be at least 8 characters
          type: array
          items:
            type: string
        error:
          type: string
          description: Error type
          example: Bad Request
      required:
        - statusCode
        - message
        - error
    V1CaptureAudioDto:
      type: object
      properties:
        uri:
          type: string
          description: Device-local URI of the recorded audio
        mimeType:
          type: string
          description: Audio MIME type, e.g. audio/m4a
        durationMs:
          type: number
          description: Duration in milliseconds
    V1CaptureRespondentDto:
      type: object
      properties:
        email:
          type: string
          description: Respondent email
        phone:
          type: string
          description: Respondent phone
        externalId:
          type: string
          description: Host-app external id (e.g. CRM id)
  securitySchemes:
    PublishableKey:
      type: apiKey
      in: header
      name: x-woku-key
      description: Publishable capture key (pk_...), capture endpoints only.
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Company secret API key.

````