How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Redocly Tasks API

Operations related to tasks.

Redocly Tasks API is one of 16 APIs that Redocly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{host}/api.

4 operations 2 paths 7 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Server
https://{host}/api
Authentication
API Key, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Redocly Tasks API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as accessToken (UserCookie). It accepts HTTP bearer tokens (ApiKey). By default, every request must be authenticated.

  • UserCookie — Default authentication scheme for interaction between browser and API.
  • ApiKey — API key is required to access the API. You can get your API key from the [BlueHarvest dashboard](https://app.blueharvest.cloud).

Paths & Operations 4

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

Tasks 4

Operations related to tasks.

POST
/orgs/{orgId}/projects/{projectId}/scout/tasks
Process next job
startNextJob 3 params → 200204400
GET
/orgs/{orgId}/projects/{projectId}/scout/tasks
List all tasks
getAllTasks 8 params → 200400
GET
/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}
Get task
getJobById 4 params → 200400404
PATCH
/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}
Update job
updateJob 4 params body → 200400404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Job (20 properties), Page (6 properties), Problem (6 properties), GitCommitCheck (4 properties). Each schema is shown below with its type and property counts.

PatchJob
object
2 properties 1 required
JobMetadata
object
Additional information about job.
3 properties
JobList
object
3 properties 3 required
Job
object
20 properties 11 required
Problem
object
6 properties 4 required
GitCommitCheck
object
4 properties 2 required
Page
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

redocly-tasks-api-openapi.yml Raw ↑

Other APIs Redocly publishes across the network.

Redocly Realm
Redocly Reunite
Redocly Revel
Redocly Reef
Redocly Redoc
Redocly CLI
Redocly Respect Monitoring
Arazzo Specification (Redocly Tooling)
Redocly Health API
Redocly Metadata API
Redocly Remotes API
Redocly Search API
Where this information came from

This is an independent, third-party profile of Redocly Tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.