Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iconik Jobs API

Asynchronous job tracking and orchestration.

iconik Jobs API is one of 6 APIs that iconik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://app.iconik.io/API, https://eu.iconik.io/API.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://app.iconik.io/API/assets/v1
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

iconik Jobs API declares 2 security schemes for authenticating requests. An API key is passed in the header as App-ID (appId). An API key is passed in the header as Auth-Token (authToken). By default, every request must be authenticated.

  • appId — The iconik application ID generated in the web UI.
  • authToken — The iconik auth token paired with the application ID.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 5

Asynchronous job tracking and orchestration.

GET
/jobs/v1/jobs/
List jobs
listJobs 2 params → 200
POST
/jobs/v1/jobs/
Create a job
createJob body → 201
GET
/jobs/v1/jobs/{job_id}/
Get a job
getJob 1 param → 200404
PATCH
/jobs/v1/jobs/{job_id}/
Update a job
updateJob 1 param body → 200
DELETE
/jobs/v1/jobs/{job_id}/
Delete a job
deleteJob 1 param → 204

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Job (7 properties), JobCreate (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Job
object
7 properties
JobCreate
object
3 properties 3 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iconik-jobs-api-openapi.yml Raw ↑

Other APIs iconik publishes across the network.

iconik Assets API
iconik Collections API
iconik Files API
iconik Metadata API
iconik Search API