labelixa-com Agents API

openapi: 3.2.0
info:
  title: Labelixa Com Agents API
  version: 0.4.0
  description: 'Operations tagged Agents across 2 of this provider''s published API definitions: labelixa-com-api-openapi.json, labelixa-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Agents
paths:
  /v1/agents/pairing-codes:
    post:
      summary: Create agent pairing code
      description: Creates a one-time pairing code for the DirectPrint agent (201). The code is shown in this response only. Requires an account on a plan with printing (Starter and above, or the free print trial).
      operationId: agent_kodu_v1_agents_pairing_codes_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EslestirmeKoduIstegi'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Agents
  /v1/agents/pair:
    post:
      summary: Pair agent
      description: 'Exchanges a pairing code for the agent''s credentials (201). Needs no API key: the code itself is the credential, and the token is returned only here. Invalid, expired and used codes all return the same 400. Attempts are rate-limited per IP (429 with `Retry-After`).'
      operationId: agent_eslestir_v1_agents_pair_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EslestirmeIstegi'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Agents
  /v1/agents:
    get:
      summary: List agents
      description: 'The workspace''s agents with their liveness: `son_gorulme` (last seen) and how many seconds ago. There is no connected true/false flag; the reader sets its own threshold. Requires an account on a plan with printing (Starter and above, or the free print trial).'
      operationId: agent_listesi_v1_agents_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Agents
  /v1/agents/{agent_id}:
    delete:
      summary: Remove agent
      operationId: agent_kaldir_v1_agents__agent_id__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Removes an agent from the workspace. 404 when not found.
      tags:
      - Agents
  /v1/agents/heartbeat:
    post:
      summary: Agent heartbeat
      description: The agent's liveness report. Called by the DirectPrint agent, authenticated with a signed request (`X-Agent-Id`, `X-Agent-Zaman`, `X-Agent-Tekil`, `X-Agent-Imza`); an invalid signature, timestamp window or nonce returns 401. The raw body is verified before it is parsed.
      operationId: agent_yoklama_v1_agents_heartbeat_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Agents
  /v1/agents/connect/start:
    post:
      summary: Start agent connection
      description: 'Code-free setup, step 1: the agent opens a connection request and receives the address (`adres`) to open in the browser, where the signed-in user approves it. Needs no API key; rate-limited per IP like pairing.'
      operationId: agent_baglanti_baslat_v1_agents_connect_start_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaglantiBaslatIstegi'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Agents
  /v1/agents/connect/poll:
    post:
      summary: Poll agent connection
      description: 'Code-free setup, polling step: 202 until the user approves; once approved the agent credentials are returned once with 200. Unknown, expired and rejected connections return the same 400; polling too often returns 429 with `Retry-After`.'
      operationId: agent_baglanti_yokla_v1_agents_connect_poll_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaglantiYoklaIstegi'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Agents
  /v1/agents/devices/register:
    post:
      summary: 'Agent: register printer'
      description: The agent registers a printer it found, so the user does not have to add it in the panel first. If a device with the same name exists it is returned (200) instead of creating a duplicate. Only the name reaches the cloud, never the address or queue. Called by the DirectPrint agent, authenticated with a signed request (`X-Agent-Id`, `X-Agent-Zaman`, `X-Agent-Tekil`, `X-Agent-Imza`); an invalid signature, timestamp window or nonce returns 401.
      operationId: agent_cihaz_kaydet_v1_agents_devices_register_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Agents
  /v1/agents/devices/{cihaz_id}/test-print:
    post:
      summary: 'Agent: queue test print'
      description: 'Last setup step: the agent requests a test label for a device it maps. The job goes through the normal queue, so paper coming out proves the whole chain. Called by the DirectPrint agent, authenticated with a signed request (`X-Agent-Id`, `X-Agent-Zaman`, `X-Agent-Tekil`, `X-Agent-Imza`); an invalid signature, timestamp window or nonce returns 401. Someone else''s resource and a non-existent one return the same 404.'
      operationId: agent_test_baskisi_v1_agents_devices__cihaz_id__test_print_post
      parameters:
      - name: cihaz_id
        in: path
        required: true
        schema:
          type: string
          title: Cihaz Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Agents
  /v1/agents/devices:
    post:
      summary: 'Agent: list cloud printers'
      description: 'For the agent''s setup wizard: the workspace''s cloud printers with only the fields needed for mapping (no network data). Called by the DirectPrint agent, authenticated with a signed request (`X-Agent-Id`, `X-Agent-Zaman`, `X-Agent-Tekil`, `X-Agent-Imza`); an invalid signature, timestamp window or nonce returns 401.'
      operationId: agent_cihazlari_v1_agents_devices_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Agents
  /v1/agents/jobs/claim:
    post:
      summary: Claim next print job
      description: The agent asks for its next print job; the cloud never connects to the agent, so no inbound port is needed. 204 when there is no job (a normal answer, not an error); the server may hold the request open until a job arrives (long polling). Called by the DirectPrint agent, authenticated with a signed request (`X-Agent-Id`, `X-Agent-Zaman`, `X-Agent-Tekil`, `X-Agent-Imza`); an invalid signature, timestamp window or nonce returns 401.
      operationId: agent_is_al_v1_agents_jobs_claim_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Agents
  /v1/agents/jobs/{job_id}/result:
    post:
      summary: Report print job result
      description: 'The agent reports a job''s outcome. This is not a print confirmation: success maps to `dispatched` (bytes delivered). A failure does not necessarily mean nothing was printed; the stage (`asama`) and copies sent (`gonderilen_kopya`) carry the difference so a partly printed job is not resent. Called by the DirectPrint agent, authenticated with a signed request (`X-Agent-Id`, `X-Agent-Zaman`, `X-Agent-Tekil`, `X-Agent-Imza`); an invalid signature, timestamp window or nonce returns 401. Someone else''s resource and a non-existent one return the same 404.'
      operationId: agent_is_sonuc_v1_agents_jobs__job_id__result_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Agents
components:
  schemas:
    EslestirmeIstegi:
      properties:
        kod:
          type: string
          title: Kod
        surum:
          type: string
          title: Surum
          default: ''
      type: object
      required:
      - kod
      title: EslestirmeIstegi
    BaglantiBaslatIstegi:
      properties:
        surum:
          type: string
          maxLength: 32
          title: Surum
          default: ''
        bilgisayar:
          type: string
          maxLength: 256
          title: Bilgisayar
          default: ''
      type: object
      title: BaglantiBaslatIstegi
    BaglantiYoklaIstegi:
      properties:
        baglanti:
          type: string
          maxLength: 128
          minLength: 16
          title: Baglanti
      type: object
      required:
      - baglanti
      title: BaglantiYoklaIstegi
    EslestirmeKoduIstegi:
      properties:
        takma_ad:
          type: string
          title: Takma Ad
      type: object
      required:
      - takma_ad
      title: EslestirmeKoduIstegi
    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
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
x-refined-from:
- labelixa-com-api-openapi.json
- labelixa-com-openapi.json