Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goldsky.com/llms.txt

Use this file to discover all available pages before exploring further.

The Goldsky API lets you create, deploy, monitor, and manage Turbo Pipelines programmatically — the same operations available through the CLI, exposed as a REST API.

​
Base URL

https://api.goldsky.com/api/v1

​
Authentication

All endpoints require a Bearer token. Create a Goldsky API key from your Project Settings and pass it in the Authorization header. API keys are scoped to a single project. 
curl -H "Authorization: Bearer <your-api-key>" \
  https://api.goldsky.com/api/v1/pipelines/

​
Endpoints

MethodPathDescription
GET/pipelines/List all pipelines
POST/pipelines/Create a pipeline
GET/pipelines/{name}Get a pipeline
DELETE/pipelines/{name}Delete a pipeline
POST/pipelines/validateValidate a pipeline definition
PUT/pipelines/{name}/pausePause a pipeline
PUT/pipelines/{name}/resumeResume a pipeline
PUT/pipelines/{name}/restartRestart a pipeline
GET/pipelines/{name}/logsGet pipeline logs
GET/pipelines/{name}/logs/error-countGet pipeline error count
GET/pipelines/{name}/statusGet pipeline status
GET/pipelines/{name}/stateGet pipeline state
Select any endpoint in the sidebar to see its parameters and try it interactively.