> ## 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.

# API Reference

> Manage Goldsky subgraphs, pipelines, and Edge endpoints programmatically via the REST API. Full OpenAPI reference with a machine-readable spec for agents and tooling.

The Goldsky REST API lets you manage subgraphs, Turbo Pipelines, and Edge endpoints programmatically — the same operations available through the [CLI](/reference/cli), exposed as a REST API. Every endpoint is documented in the reference pages in this section, grouped by product.

## Base URL

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

## Authentication

All endpoints require a Bearer token. Create a Goldsky API key from your [Project Settings](https://app.goldsky.com/dashboard/settings) and pass it in the `Authorization` header. API keys are scoped to a single project.

```bash theme={null}
curl -H "Authorization: Bearer <your-api-key>" \
  https://api.goldsky.com/api/v1/subgraphs
```

Errors are returned as [RFC 9457 problem+json](https://api.goldsky.com/api/errors) — each carries a `type` URL that resolves to a human-readable explanation and a `detail` describing what to fix.

## Interactive docs & machine-readable spec

<CardGroup cols={2}>
  <Card title="Interactive API explorer" icon="terminal" href="https://api.goldsky.com/api/v1/docs" arrow={true}>
    Try requests live against your project from the hosted API explorer.
  </Card>

  <Card title="OpenAPI spec (JSON)" icon="file-code" href="https://api.goldsky.com/api/v1/docs/openapi.json" arrow={true}>
    The full machine-readable OpenAPI 3 spec — point your codegen, client, or agent at this URL.
  </Card>
</CardGroup>

## What's covered

* **Subgraphs** — deploy, list, tag, pause/resume, delete, read logs, and manage webhooks.
* **Turbo Pipelines** — create, deploy, monitor, pause/resume, and manage pipelines.
* **Edge endpoints** — manage Edge endpoints, API keys, and read metrics.

Browse the grouped endpoint reference in the sidebar, or jump straight to the [interactive explorer](https://api.goldsky.com/api/v1/docs).


## Related topics

- [CLI Reference](/reference/cli.md)
- [Turbo CLI Reference](/turbo-pipelines/cli-reference.md)
- [Compose CLI Reference](/compose/cli-reference.md)
- [Compose app manifest configuration reference](/compose/app-configuration.md)
- [Turbo SQL Functions Reference](/turbo-pipelines/reference/sql-functions.md)