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

# Get Rate Recommendation

> Get AI-powered rate recommendation based on role, seniority, and location.

**Required scope:** `read`

Note: Uses the system's AI API key. For high volume usage, consider
configuring your own API key in your user profile.



## OpenAPI

````yaml /openapi/openapi-external.json post /ai/rate-recommendation
openapi: 3.1.0
info:
  title: Quikly.ai External API
  version: 1.0.0
  description: >-
    REST API for external integrations with Quikly.ai. Authenticate using an API
    key passed in the X-API-Key header. Use these endpoints from n8n, Zapier,
    custom scripts, or any HTTP client.
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: Proposals
    description: Create, read, update, and manage client proposals.
  - name: Profile
    description: Read and update the authenticated user's profile.
  - name: Templates
    description: Manage reusable proposal templates.
  - name: AI Services
    description: >-
      AI-powered analysis: rate recommendations, brief analysis,
      differentiators.
  - name: Public API
  - name: Usage
    description: Query API usage and quota information.
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events.
  - name: Agent
    description: Interact with the AI agent for automated workflows.
  - name: Lead Sessions
    description: Track and manage lead capture sessions.
paths:
  /ai/rate-recommendation:
    post:
      tags:
        - AI Services
      summary: Get Rate Recommendation
      description: >-
        Get AI-powered rate recommendation based on role, seniority, and
        location.


        **Required scope:** `read`


        Note: Uses the system's AI API key. For high volume usage, consider

        configuring your own API key in your user profile.
      operationId: get_rate_recommendation_api_external_v1_ai_rate_recommendation_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RateRecommendationRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateRecommendationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    RateRecommendationRequest:
      properties:
        role:
          type: string
          title: Role
        seniority:
          type: string
          title: Seniority
        myLocation:
          type: string
          title: Mylocation
        providerType:
          anyOf:
            - type: string
            - type: 'null'
          title: Providertype
          default: freelancer
        clientLocation:
          anyOf:
            - type: string
            - type: 'null'
          title: Clientlocation
        companySize:
          anyOf:
            - type: string
            - type: 'null'
          title: Companysize
        industry:
          anyOf:
            - type: string
            - type: 'null'
          title: Industry
        clientType:
          anyOf:
            - type: string
            - type: 'null'
          title: Clienttype
        language:
          type: string
          enum:
            - es
            - en
          title: Language
          default: en
        currency:
          type: string
          title: Currency
          default: USD
        currentRate:
          anyOf:
            - type: number
            - type: string
          title: Currentrate
        apiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Apikey
        aiProvider:
          anyOf:
            - type: string
              enum:
                - gemini
                - openai
                - anthropic
            - type: 'null'
          title: Aiprovider
          default: gemini
        openaiApiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Openaiapikey
        anthropicApiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Anthropicapikey
      type: object
      required:
        - role
        - seniority
        - myLocation
        - currentRate
      title: RateRecommendationRequest
      description: Schema for rate recommendation request.
    RateRecommendationResponse:
      properties:
        rate:
          type: string
          title: Rate
        reasoning:
          type: string
          title: Reasoning
        success:
          type: boolean
          title: Success
          default: true
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        inferredLocation:
          anyOf:
            - type: string
            - type: 'null'
          title: Inferredlocation
      type: object
      required:
        - rate
        - reasoning
      title: RateRecommendationResponse
      description: Schema for rate recommendation response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from Quikly.ai Settings → API Keys.
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````