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/epicdirectories:epicdirectories-jobs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: EpicDirectories Jobs API
  description: API-first directory data platform.
  version: '1.0'
  contact: {}
servers:
- url: https://api.epicdirectories.com
  description: Production
- url: http://localhost:3333
  description: Local development
tags:
- name: Jobs
paths:
  /v1/directories/{directoryId}/jobs:
    post:
      operationId: JobsController_create
      summary: Create and queue a new job
      parameters:
      - name: directoryId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobDto'
      responses:
        '201':
          description: Job created and queued
        '400':
          description: Invalid job payload
        '404':
          description: Directory not found
      tags:
      - Jobs
      security:
      - bearer: []
    get:
      operationId: JobsController_findAll
      summary: List jobs for directory
      parameters:
      - name: directoryId
        required: true
        in: path
        schema:
          type: string
      - name: jobType
        required: false
        in: query
        description: Filter by job type
        schema:
          enum:
          - import
          - media_process
          - recipe_build
          - recipe_rebuild_all
          - enrichment
          type: string
      - name: status
        required: false
        in: query
        description: Filter by status
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Page number
        schema:
          default: 1
          type: number
      - name: limit
        required: false
        in: query
        description: Items per page
        schema:
          default: 50
          type: number
      responses:
        '200':
          description: Paginated list of jobs
        '404':
          description: Directory not found
      tags:
      - Jobs
      security:
      - bearer: []
  /v1/directories/{directoryId}/jobs/{jobId}:
    get:
      operationId: JobsController_findOne
      summary: Get job details with queue status
      parameters:
      - name: directoryId
        required: true
        in: path
        schema:
          type: string
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Job details with BullMQ queue state
        '404':
          description: Job or directory not found
      tags:
      - Jobs
      security:
      - bearer: []
  /v1/directories/{directoryId}/jobs/{jobId}/cancel:
    post:
      operationId: JobsController_cancel
      summary: Cancel a pending/queued job
      parameters:
      - name: directoryId
        required: true
        in: path
        schema:
          type: string
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Job cancelled
        '400':
          description: Job is in a state that cannot be cancelled
        '404':
          description: Job or directory not found
      tags:
      - Jobs
      security:
      - bearer: []
  /v1/directories/{directoryId}/jobs/{jobId}/retry:
    post:
      operationId: JobsController_retry
      summary: Retry a failed job
      parameters:
      - name: directoryId
        required: true
        in: path
        schema:
          type: string
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Job re-queued
        '400':
          description: Job is not in a retriable state
        '404':
          description: Job or directory not found
      tags:
      - Jobs
      security:
      - bearer: []
components:
  schemas:
    CreateJobDto:
      type: object
      properties:
        jobType:
          type: string
          description: Type of job
          enum:
          - import
          - media_process
          - recipe_build
          - recipe_rebuild_all
          - enrichment
        input:
          type: object
          description: Job input configuration
      required:
      - jobType
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    apiKey:
      type: apiKey
      in: header
      name: x-api-key