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

# Analyse a Pineyard call

> Analyse a call placed by Pineyard. No upload is needed: the recording is already stored.

**Required scope:** `speech.upload`

<Note>Requires speech analysis enabled for your workspace. Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json post /speech/calls/analyse-call
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /speech/calls/analyse-call:
    post:
      summary: Analyse a Pineyard call
      description: >-
        Analyse a call placed by Pineyard. No upload is needed: the recording is
        already stored.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                callId:
                  type: string
                  format: uuid
                campaignContactId:
                  type: string
                  format: uuid
                scorecardId:
                  type: string
                  format: uuid
              required:
                - scorecardId
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                    enum:
                      - UPLOADING
                      - PROCESSING
                      - COMPLETED
                      - FAILED
                      - INGEST_FAILED
                  fileName:
                    type: string
                  fileSizeBytes:
                    type: number
                  durationSeconds:
                    type: number
                    nullable: true
                  score:
                    type: number
                    nullable: true
                  outcomeLabel:
                    type: string
                    nullable: true
                  summary:
                    type: string
                    nullable: true
                  errorMessage:
                    type: string
                    nullable: true
                  callDate:
                    type: string
                    nullable: true
                  createdAt:
                    type: string
                  completedAt:
                    type: string
                    nullable: true
                  rep:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                    required:
                      - id
                      - name
                  scorecard:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                    required:
                      - id
                      - name
                required:
                  - id
                  - status
                  - fileName
                  - fileSizeBytes
                  - durationSeconds
                  - score
                  - outcomeLabel
                  - summary
                  - errorMessage
                  - callDate
                  - createdAt
                  - completedAt
                  - rep
                  - scorecard
        '400':
          description: >-
            - `call_required`: Neither callId nor campaignContactId was given.

            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_request`: The input was rejected.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '402':
          description: >-
            - `insufficient_credits`: Wallet balance too low (and no active
            trial).
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `feature_not_available`: This feature is not enabled for your
            workspace or plan.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `call_not_found`: Speech analysis or dialer call not found.

            - `feature_not_available`: This feature is not enabled for your
            workspace or plan.

            - `rep_not_found`: Rep not found.

            - `scorecard_not_found`: Scorecard not found.
        '409':
          description: '- `already_analysed`: Call already analysed.'
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '422':
          description: |-
            - `no_agent`: Call has no agent.
            - `no_recording`: Call has no available recording.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).

            - `recording_fetch_failed`: Recording download failed.

            - `upstream_unavailable`: A connected service (messaging or speech)
            is unavailable.
        '503':
          description: |-
            - `database_unavailable`: The service is temporarily unavailable.
            - `not_configured`: Speech analysis is not available right now.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.