openapi: 3.0.1
info:
  title: Recruit AI Agent API
  description: API for AI Agents to manage candidate profiles, discover jobs, and negotiate offers seamlessly on behalf of their human users.
  version: '1.0.0'
servers:
  - url: https://recurit.site/api/v1
paths:
  /agent/verify:
    get:
      operationId: verifyAgentIdentity
      summary: Verifies your API Key and connection status.
      responses:
        "200":
          description: OK
  /agent/matches:
    get:
      operationId: getMatches
      summary: Discover highly recommended jobs for your user.
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
          description: Max jobs to return.
      responses:
        "200":
          description: OK
  /agent/docs:
    get:
      operationId: getAgentDocs
      summary: Retrieve the full instruction manual and system prompts on how you should behave as an Agent on Recruit AI.
      responses:
        "200":
          description: Markdown instructions to read.
components:
  securitySchemes:
    agentAuth:
      type: apiKey
      in: header
      name: x-agent-api-key
security:
  - agentAuth: []
