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

# Trigger Scout Run

> Trigger a Scout screening run for an existing candidate. Returns 202 once queued; subscribe to the scout.completed webhook for results.



## OpenAPI

````yaml https://api.ropes.ai/api/docs/openapi.json post /api/public/candidates/{candidateId}/scout
openapi: 3.0.0
info:
  title: Ropes Public API
  version: 1.0.0
  description: >-
    Public API for Ropes. Authenticate using your API key in the x-api-key
    header.
servers:
  - url: https://api.ropes.ai
    description: Production server
  - url: http://localhost:3001
    description: Local development server
security: []
paths:
  /api/public/candidates/{candidateId}/scout:
    post:
      tags:
        - Scout
      summary: Trigger Scout Run
      description: >-
        Trigger a Scout screening run for an existing candidate. Returns 202
        once queued; subscribe to the scout.completed webhook for results.
      parameters:
        - schema:
            type: string
            description: The unique identifier of the candidate
          required: true
          description: The unique identifier of the candidate
          name: candidateId
          in: path
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TriggerScoutRequest'
      responses:
        '202':
          description: Scout run queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerScoutResponse'
              examples:
                queued:
                  summary: Run queued
                  value:
                    status: processing
                    candidateIdentifier: '973325'
                    message: >-
                      Scout run queued. Subscribe to the scout.completed webhook
                      to be notified.
        '400':
          description: >-
            Invalid input - phone, profile URLs, resume files, or the candidate
            has no valid email on record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '403':
          description: >-
            Candidate is synced from an ATS integration, or Scout is disabled
            for the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '404':
          description: Candidate not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '409':
          description: A Scout run is already in progress for this candidate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '429':
          description: >-
            Rate limit exceeded - contact support@ropes.ai for further
            assistance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '503':
          description: Resume processing temporarily unavailable - retry shortly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    TriggerScoutRequest:
      type: object
      properties:
        phone:
          type: string
          description: The candidate's phone number, ideally in E.164 format.
        linkedinUrl:
          type: string
          description: URL of the candidate's LinkedIn profile.
        githubUrl:
          type: string
          description: URL of the candidate's GitHub profile.
        resumes:
          type: array
          items:
            type: string
            format: binary
          description: >-
            Up to 10 resume files (PDF, DOC, or DOCX; max 10 MB each). Optional:
            without one, Scout verifies experience from LinkedIn and re-checks
            resumes from any prior run.
      required:
        - phone
      additionalProperties: false
    TriggerScoutResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - processing
          description: The Scout run has been queued.
        candidateIdentifier:
          type: string
          description: Identifier of the candidate being screened.
        message:
          type: string
          description: Human-readable confirmation.
      required:
        - status
        - candidateIdentifier
        - message
      additionalProperties: false
    ScoutErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        message:
          type: string
          description: Error message (alternative field)
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````