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

Precog Pipelines API

The Pipelines API from Precog — 18 operation(s) for pipelines.

Precog Pipelines API is one of 12 APIs that Precog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Pipelines. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

This API exposes 26 operations across 18 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, http://localhost:30000.

26 operations 18 paths 35 schemas 2 DELETE13 GET1 PATCH4 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.precog.cloud
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Precog Pipelines API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 26

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

Pipelines 26
GET
/pipelines/{pipeline-id}/metadata
Get metadata related to this pipeline
get-pipelines-pipeline-id-metadata 1 param → 200401404
GET
/pipelines/{pipeline-id}/dataset-properties
Get dataset properties related to the in-band datasets present in this pipeline
get-pipeline-id-dataset-properties 1 param → 200422401404
GET
/pipelines
Get pipelines
get-pipelines → 200401
POST
/pipelines
Create pipeline
post-pipelines body → 201400401422
GET
/pipelines/status
Get the pipeline status
get-pipelines-status → 200401
GET
/pipelines/{pipeline-id}
Get a pipeline
get-pipelines-pipeline-id 1 param → 200401404
DELETE
/pipelines/{pipeline-id}
Deletes the given pipeline
delete-pipelines-pipeline-id 1 param → 204404
GET
/pipelines/{pipeline-id}/metrics
Get the pipeline metrics
1 param → 200401404
GET
/pipelines/{pipeline-id}/datasets
Get the pipeline datasets
get-pipelines-pipeline-id-datasets 1 param → 200401404
PATCH
/pipelines/{pipeline-id}/datasets
Add (or remove) datasets to (or from) the provided pipeline.
patch-pipelines-pipeline-id-datasets 1 param body → 204400401404422
GET
/pipelines/{pipeline-id}/details
Get pipeline details
get-pipelines-pipeline-id-details 1 param → 200401404
GET
/pipelines/{pipeline-id}/status
Get the pipeline datasets status
get-pipelines-pipeline-id-status 1 param → 200401404
POST
/pipelines/{pipeline-id}/loads
Start a pipeline load
post-pipelines-pipeline-id-loads 1 param body → 202204400401402404502
PUT
/pipelines/{pipeline-id}/rename
Rename a pipelne.
put-pipelines-pipeline-id-rename 1 param body → 204400401404422
PUT
/pipelines/{pipeline-id}/pii-config
Set PII handling policy for a pipeline.
put-pipelines-pipeline-id-pii-config 1 param body → 204401404
PUT
/pipelines/{pipeline-id}/vectorize
Set the vectorization opt-in flag for a pipeline.
put-pipelines-pipeline-id-vectorize 1 param body → 204400401404
POST
/pipelines/{pipeline-id}/encode
Embed query text against the pipeline's vector model.
post-pipelines-pipeline-id-encode 1 param body → 200400401404
GET
/pipelines/{pipeline-id}/semantic-contexts
Get existing semantic contexts of this pipeline
get-pipelines-pipeline-id-semantic-contexts 1 param → 200400401404422
POST
/pipelines/{pipeline-id}/semantic-contexts
Add a semantic context to the pipeline
post-pipelines-pipeline-id-semantic-contexts 1 param body → 201400401404422
GET
/pipelines/{pipeline-id}/semantic-contexts/{semantic-context-id}
Get the details of the particular semantic context
get-pipelines-pipeline-id-semantic-contexts-semantic-context-id 2 params → 200400401404422
PUT
/pipelines/{pipeline-id}/semantic-contexts/{semantic-context-id}
Replace details of a semantic context
put-pipelines-pipeline-id-semantic-contexts-semantic-context-id 2 params body → 200400401404422
DELETE
/pipelines/{pipeline-id}/semantic-contexts/{semantic-context-id}
Delete the semantic context
delete-pipelines-pipeline-id-semantic-contexts-semantic-context-id 2 params → 200400401404422
PUT
/pipelines/{pipeline-id}/schedule
Schedule a pipeline.
put-pipelines-pipeline-id-schedule 1 param body → 204400401404422
GET
/pipelines/{pipeline-id}/schedule
Get the pipeline schedule
get-pipelines-pipeline-id-schedule 1 param → 200401404
PUT
/pipelines/{pipeline-id}/notification
Set email addresses to be notified on pipeline events.
put-pipelines-pipeline-id-notification 1 param body → 204400401404422
GET
/pipelines/{pipeline-id}/notification
Get email addresses associated with the pipeline
get-pipelines-pipeline-id-notification 1 param → 200401404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are pipeline (8 properties), initial-load-params (5 properties), pipeline-details (5 properties), outofband-state (4 properties). Each schema is shown below with its type and property counts.

foreignKey
object
Foreign key
2 properties 2 required
table
object
Table schema
4 properties
pipeline-dataset-status
object
4 properties 2 required
pipeline-notification
object
1 property 1 required
pipeline
object
8 properties 3 required
initial-load-params
object
5 properties 1 required
pipeline-listing
object
2 properties 2 required
pipeline-name
object
1 property 1 required
inband-state
object
4 properties 2 required
pipeline-metadata
object
Tables in this pipeline
1 property
dataset-update-legacy
object
3 properties 2 required
column
object
Column
4 properties 2 required
outofband-state
object
4 properties 2 required
pipeline-status
object
3 properties 2 required
aggregated-pipeline-metrics
object
1 property
reuse-previous-primary-key
Legacy boolean or new strategy object.
dataset
object
3 properties 3 required
epoch-millis
integer
primary-key-property
object
Primary key for a given dataset
1 property 1 required
drifted-dataset
object
Drift information for a single dataset.
3 properties 2 required
dataset-metadata
object
Dataset tables
2 properties
dataset-properties
object
Dataset properties for a particular dataset in a pipeline
1 property
dataset-status
object
4 properties 1 required
id
object
1 property 1 required
pipeline-load-state
object
2 properties 2 required
pipeline-schedule
object
1 property 1 required
dataset-update-new
object
2 properties 2 required
initial-load-params-message-limit
object
1 property 1 required
action
object
3 properties 3 required
pipeline-details
object
5 properties 5 required
pipeline-datasets-properties
object
Datasets properties used in the in-band datasets in this pipeline
2 properties 2 required
simple-pipeline-metric
object
2 properties
error-message
object
1 property 1 required
dataset-telemetry
object
3 properties 1 required
dataset-update

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

precog-pipelines-api-openapi.yml Raw ↑

Other APIs Precog publishes across the network.

Precog Admin API
Precog Data Model API
Precog Datasets API
Precog Destinations API
Precog Issues API
Precog Kinds API
Precog Loads API
Precog Log API
Precog Semantic Model API
Precog Sources API
Precog Stripe API
Where this information came from

This is an independent, third-party profile of Precog Pipelines 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.