Lingopal Jobs API

Work with reusable registered jobs, their workflows, status, and outputs.

GitHub OpenAPI
Business capability
Localisation & Versioning Management BC-3700.60

Operations 5

GET /v2/jobs List registered jobs #
GET /v2/jobs/{job_id} Get registered job #
PATCH /v2/jobs/{job_id} Update registered job #
DELETE /v2/jobs/{job_id} Delete registered job #
GET /v2/jobs/{job_id}/status Get registered job status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/lingopal:lingopal-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lingopal-jobs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Lingopal API v2 Jobs API
  description: Lingopal v2 public API for text translation, storage uploads, registered jobs, job workflows, and job outputs.
  version: v2
servers:
- url: https://api.lingopal.ai
security:
- APIKeyHeader: []
tags:
- name: Jobs
  description: Inspect registered job metadata and processing status.
paths:
  /v2/jobs:
    get:
      tags:
      - Jobs
      summary: List registered jobs
      description: Lists accessible, non-deleted jobs with filtering and sorting.
      operationId: listJobs
      security:
      - APIKeyHeader: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      - name: job_type
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - video
            - audio
            - document
            type: string
          - type: 'null'
          title: Job Type
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Q
      - name: sort_by
        in: query
        required: false
        schema:
          enum:
          - created_at
          - updated_at
          - name
          type: string
          default: created_at
          title: Sort By
      - name: sort_order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          default: desc
          title: Sort Order
      responses:
        '200':
          description: Paginated registered jobs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResponse'
        '401':
          description: Invalid authentication token.
        '403':
          description: 'Authentication credentials were not provided, or the authenticated account is restricted (detail.code: ACCOUNT_RESTRICTED).'
        '422':
          description: Request validation error.
  /v2/jobs/{job_id}:
    get:
      tags:
      - Jobs
      summary: Get registered job
      description: Returns metadata for a reusable registered job.
      operationId: getJob
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`.
          examples:
          - job_123
          title: Job Id
        description: Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`.
      responses:
        '200':
          description: Registered job metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
              example:
                job_id: job_123
                name: Product Demo
                job_type: video
                source_url: https://cdn.example.com/uploads/product-demo.mp4
                created_at: '2026-07-07T16:00:00Z'
                updated_at: '2026-07-07T16:05:00Z'
                links:
                  self: /v2/jobs/job_123
                  status: /v2/jobs/job_123/status
                  translations: /v2/jobs/job_123/translations
                  subtitles: /v2/jobs/job_123/subtitles
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              example:
                detail: Job Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Jobs
      summary: Update registered job
      description: Updates the display name of an accessible registered job.
      operationId: updateJob
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Reusable registered job ID.
          title: Job Id
        description: Reusable registered job ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobRequest'
      responses:
        '200':
          description: Updated registered job metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
              example:
                job_id: job_123
                name: Product Demo
                job_type: video
                source_url: https://cdn.example.com/uploads/product-demo.mp4
                created_at: '2026-07-07T16:00:00Z'
                updated_at: '2026-07-07T16:05:00Z'
                links:
                  self: /v2/jobs/job_123
                  status: /v2/jobs/job_123/status
                  translations: /v2/jobs/job_123/translations
                  subtitles: /v2/jobs/job_123/subtitles
        '401':
          description: Invalid authentication token.
        '403':
          description: 'Authentication credentials were not provided, or the authenticated account is restricted (detail.code: ACCOUNT_RESTRICTED).'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              example:
                detail: Job Not Found
        '422':
          description: Request validation error.
    delete:
      tags:
      - Jobs
      summary: Delete registered job
      description: Marks an accessible registered job as deleted and queues permanent cleanup.
      operationId: deleteJob
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Reusable registered job ID.
          title: Job Id
        description: Reusable registered job ID.
      responses:
        '202':
          description: Job accepted for permanent cleanup.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteJobResponse'
        '401':
          description: Invalid authentication token.
        '403':
          description: 'Authentication credentials were not provided, or the authenticated account is restricted (detail.code: ACCOUNT_RESTRICTED).'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              example:
                detail: Job Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v2/jobs/{job_id}/status:
    get:
      tags:
      - Jobs
      summary: Get registered job status
      description: Returns current processing status for a reusable registered job.
      operationId: getJobStatus
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`.
          examples:
          - job_123
          title: Job Id
        description: Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`.
      responses:
        '200':
          description: Current job processing status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusResponse'
              example:
                job_id: job_123
                job_type: video
                status: processing
                stage: translating
                sub_stage: dubbing
                workflows:
                  translation:
                    status: processing
                    languages:
                    - target_language: es
                      status: processing
                    - target_language: fr
                      status: queued
                outputs:
                  transcript: true
                  subtitles: false
                updated_at: '2026-07-07T16:10:00Z'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              example:
                detail: Job Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeleteJobResponse:
      properties:
        job_id:
          type: string
          title: Job Id
        status:
          type: string
          const: pending_purge
          title: Status
          default: pending_purge
      type: object
      required:
      - job_id
      title: DeleteJobResponse
    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
    UpdateJobRequest:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
      additionalProperties: false
      type: object
      required:
      - name
      title: UpdateJobRequest
    JobLanguageStatus:
      properties:
        target_language:
          type: string
          title: Target Language
          description: Target locale code.
        status:
          type: string
          enum:
          - queued
          - processing
          - completed
          - failed
          title: Status
          description: Current status for this language.
      type: object
      required:
      - target_language
      - status
      title: JobLanguageStatus
    JobWorkflowStatus:
      properties:
        status:
          type: string
          enum:
          - queued
          - processing
          - completed
          - failed
          title: Status
          description: Current aggregate workflow status.
        languages:
          items:
            $ref: '#/components/schemas/JobLanguageStatus'
          type: array
          title: Languages
      type: object
      required:
      - status
      title: JobWorkflowStatus
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JobStatusResponse:
      properties:
        job_id:
          type: string
          title: Job Id
          description: Reusable registered job ID.
        job_type:
          type: string
          enum:
          - video
          - audio
          - document
          title: Job Type
          description: Registered job type.
        status:
          type: string
          enum:
          - queued
          - processing
          - completed
          - failed
          title: Status
          description: Current active workflow processing status.
        stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage
          description: Best-effort internal processing stage.
        sub_stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Sub Stage
          description: Best-effort internal processing sub-stage.
        workflows:
          additionalProperties:
            $ref: '#/components/schemas/JobWorkflowStatus'
          propertyNames:
            enum:
            - translation
            - subtitles
            - transcription
            - republish
          type: object
          title: Workflows
          description: Current workflow statuses keyed by v2 workflow type.
        outputs:
          additionalProperties:
            type: boolean
          type: object
          title: Outputs
          description: Best-effort output availability flags.
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Processing error when the job failed.
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Last job update timestamp.
      type: object
      required:
      - job_id
      - job_type
      - status
      title: JobStatusResponse
      examples:
      - job_id: job_123
        job_type: video
        outputs:
          subtitle: false
          transcript: true
        stage: translating
        status: processing
        sub_stage: dubbing
        updated_at: '2026-07-07T16:10:00Z'
        workflows:
          translation:
            languages:
            - status: processing
              target_language: es
            - status: queued
              target_language: fr
            status: processing
    JobListResponse:
      properties:
        jobs:
          items:
            $ref: '#/components/schemas/JobResponse'
          type: array
          title: Jobs
        total_count:
          type: integer
          minimum: 0
          title: Total Count
        limit:
          type: integer
          maximum: 100
          minimum: 1
          title: Limit
        offset:
          type: integer
          minimum: 0
          title: Offset
      type: object
      required:
      - jobs
      - total_count
      - limit
      - offset
      title: JobListResponse
    JobResponse:
      properties:
        job_id:
          type: string
          title: Job Id
          description: Reusable registered job ID.
        name:
          type: string
          title: Name
          description: Job display name.
        job_type:
          type: string
          enum:
          - video
          - audio
          - document
          title: Job Type
          description: Registered job type.
        source_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Url
          description: Original or registered source URL.
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
          description: Job creation timestamp.
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Job update timestamp.
        links:
          additionalProperties:
            type: string
          type: object
          title: Links
          description: Related v2 job links.
      type: object
      required:
      - job_id
      - name
      - job_type
      title: JobResponse
      examples:
      - created_at: '2026-07-07T16:00:00Z'
        job_id: job_123
        job_type: video
        links:
          self: /v2/jobs/job_123
          status: /v2/jobs/job_123/status
          subtitles: /v2/jobs/job_123/subtitles
          translations: /v2/jobs/job_123/translations
        name: Product Demo
        source_url: https://cdn.example.com/uploads/product-demo.mp4
        updated_at: '2026-07-07T16:05:00Z'
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
x-provenance:
  method: harvested
  publisher: Lingopal
  source: https://docs.lingopal.ai/openapi/v2.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)