> ## 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.

# Create Candidate

> Create a new candidate.



## OpenAPI

````yaml https://api.ropes.ai/api/docs/openapi.json post /api/public/candidates/new
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/new:
    post:
      tags:
        - Candidates
      summary: Create Candidate
      description: Create a new candidate.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCandidateRequest'
      responses:
        '201':
          description: Successfully created candidate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCandidateResponse'
        '400':
          description: Bad request - Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict - Candidate already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CreateCandidateRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: The full name of the candidate
        email:
          type: string
          format: email
          description: The email address of the candidate
        integrationSource:
          type: string
          description: Integration source. Must be provided with externalId.
        externalId:
          type: string
          minLength: 1
          description: >-
            External ID from the integration source. Must be provided with
            integrationSource.
      required:
        - name
        - email
      additionalProperties: false
    CreateCandidateResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the operation was successful
        identifier:
          type: string
          description: Unique identifier for the newly created candidate
      required:
        - success
        - identifier
    ErrorResponse:
      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

````