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

> Get rate parameters from your Quikly profile for use with Get Rate.

**Required scope:** `read`

Returns role, seniority, location, currency, and current rate from your
profile. Use this in n8n to dynamically populate the Get Rate node instead
of hardcoding values.

**Profile fields used:**
- `profile.role` → role (default: fullstack)
- `profile.seniority` → seniority (default: senior)
- `profile.location` → myLocation (default: Argentina)
- `profile.proposalDefaults.hourlyRate` → currentRate (default: 50)
- `profile.proposalDefaults.currency` → currency (default: USD)
- `profile.providerType` → providerType (default: freelancer)



## OpenAPI

````yaml /openapi/openapi-external.json get /ai/rate-params
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-params:
    get:
      tags:
        - AI Services
      summary: Get Rate Params
      description: >-
        Get rate parameters from your Quikly profile for use with Get Rate.


        **Required scope:** `read`


        Returns role, seniority, location, currency, and current rate from your

        profile. Use this in n8n to dynamically populate the Get Rate node
        instead

        of hardcoding values.


        **Profile fields used:**

        - `profile.role` → role (default: fullstack)

        - `profile.seniority` → seniority (default: senior)

        - `profile.location` → myLocation (default: Argentina)

        - `profile.proposalDefaults.hourlyRate` → currentRate (default: 50)

        - `profile.proposalDefaults.currency` → currency (default: USD)

        - `profile.providerType` → providerType (default: freelancer)
      operationId: get_rate_params_api_external_v1_ai_rate_params_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateParamsResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    RateParamsResponse:
      properties:
        role:
          type: string
          title: Role
          default: professional
        seniority:
          type: string
          title: Seniority
          default: senior
        myLocation:
          type: string
          title: Mylocation
          default: Argentina
        currency:
          type: string
          title: Currency
          default: USD
        currentRate:
          type: string
          title: Currentrate
          default: '50'
        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
      type: object
      title: RateParamsResponse
      description: >-
        Schema for rate params fetched from user profile. Used by n8n Get Rate
        node.
  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

````