Clerk Frontend Api — Client

naftiko: 1.0.0-alpha2
info:
  label: Clerk Frontend Api — Client
  description: 'Clerk Client capability. 6 operations. Lead operation: Get Current Client.'
  tags:
  - Clerk
  - Client
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_PUBLISHABLE_KEY: CLERK_PUBLISHABLE_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-frontend-api-client
    baseUri: ''
    description: Clerk clerk-frontend-api Client business capability.
    resources:
    - name: v1-client
      path: /v1/client
      operations:
      - name: getClient
        method: GET
        description: Get Current Client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putClient
        method: PUT
        description: Create New Client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postClient
        method: POST
        description: Create New Client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteClientSessions
        method: DELETE
        description: Delete Client's Sessions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-client-handshake
      path: /v1/client/handshake
      operations:
      - name: handshakeClient
        method: GET
        description: Generate and Return a New Session Token for a Given Client.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Clerk-Proxy-Url
          in: header
          type: string
          description: The URL of the proxy
          required: false
        - name: Clerk-Secret-Key
          in: header
          type: string
          description: The secret key of the proxy
          required: false
        - name: redirect_url
          in: query
          type: string
          description: The URL to redirect back to after the handshake
          required: false
        - name: format
          in: query
          type: string
          description: The supported format of the handshake payload.
          required: false
        - name: organization_id
          in: query
          type: string
          description: 'The organization ID or slug to attempt to set as active for the session. If this param is present but has no value,

            the personal account will be set as active. If the organization cannot be set as act'
          required: false
        - name: satellite_fapi
          in: query
          type: string
          description: The Frontend API of the satellite domain
          required: false
    - name: v1-agents-tasks
      path: /v1/agents/tasks
      operations:
      - name: createAgentTask
        method: GET
        description: Create Session from Agent Task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ticket
          in: query
          type: string
          description: The agent task ticket value obtained from the Backend API.
          required: true