# Get a context

`GET /contexts/{slug}`

:::code-group
```bash title="cURL"
curl --request GET \
  --url https://{host}/api/contexts/{slug} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Pinecone-Api-Version: <x-pinecone-api-version>'
```

```python title="Python"
import requests

url = "https://{host}/api/contexts/{slug}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Pinecone-Api-Version": "<x-pinecone-api-version>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript title="JavaScript"
const options = {method: "GET", headers: {"Authorization": "Bearer <token>", "X-Pinecone-Api-Version": "<x-pinecone-api-version>"}};

fetch("https://{host}/api/contexts/{slug}", options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php title="PHP"
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/contexts/{slug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Pinecone-Api-Version: <x-pinecone-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go title="Go"
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/contexts/{slug}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Pinecone-Api-Version", "<x-pinecone-api-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java title="Java"
HttpResponse<String> response = Unirest.get("https://{host}/api/contexts/{slug}")
  .header("Authorization", "Bearer <token>")
  .header("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
  .asString();
```

```ruby title="Ruby"
require 'uri'
require 'net/http'

url = URI("https://{host}/api/contexts/{slug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Pinecone-Api-Version"] = '<x-pinecone-api-version>'

response = http.request(request)
puts response.read_body
```
:::

:::code-group
```json title="200"
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "workspace": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "guide": "<string>",
  "manifest": {
    "curate": {
      "chunks": null,
      "artifacts": null
    },
    "optimize": {
      "schedule": "<string>",
      "latency_threshold_ms": 123,
      "min_group_size": 123,
      "eval_pass_rate_threshold": 123,
      "max_iterations": 123
    },
    "search": {
      "instructions": "<string>"
    }
  },
  "semantic_index": "<string>",
  "keyword_index": "<string>",
  "is_optimizing": true,
  "optimize_task_id": "<string>",
  "optimize_score": 123,
  "optimize_iterations": 123,
  "last_optimized_at": "<string>",
  "last_curated_at": "<string>",
  "has_sources": true,
  "last_source_import_at": "<string>",
  "is_curating": true,
  "curate_task_id": "<string>",
  "is_importing": true,
  "import_task_id": "<string>",
  "is_exploring": true
}
```

```json title="404"
{
  "message": "<string>",
  "code": "<string>"
}
```
:::

#### Authorizations

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `Authorization` | `string` | - |  |

Session token from `POST /auth/login`, sent as `Authorization: Bearer <token>`.

#### Headers

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `X-Pinecone-Api-Version?` | `string` | `2026-07` | Date-based contract version, echoed back on the same header. Omit for the default (2026-07); send unstable for the in-development surface. An unrecognized value is rejected with 400 unsupported_api_version. |

#### Path Parameters

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `slug` | `string` | - | Context slug or UUID. |

#### Response

`200` — The context

What context endpoints return — the stored context plus the lifecycle flags derived from its in-flight tasks.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | `string` | - | Stable UUID. Accepted anywhere slug is. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `slug` | `string` | - | URL-safe name, unique within the project. Mutable via PUT. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | `string` | - | Human-readable display name. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `kind` | `string` | `search` | How the context is built. search — built from source documents, and must be curated before it can be queried. work — built from traces of work done, queryable immediately, consolidated by groom rather than curate. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `workspace?` | `string` | - | Owning workspace. Absent off a workspace-enabled cluster. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `created_by` | `string` | - | Principal that created the context. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `description` | `string \| null` | - | Free-text summary of what the context holds. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `guide?` | `string` | - | High-level standing instructions the query runtime reads on every turn. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `manifest?` | `object` | - | Pinned manifest document. Absent when the context runs on validator defaults. |

:::::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `curate?` | `object` | - | What curate builds out of the sources — the chunk leg, the artifact leg, or both. |

::::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `chunks?` | `object` | - | The chunk leg — sources split into passages, embedded for semantic search and optionally indexed for keyword search. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `enabled?` | `boolean` | `true` | Whether curate builds the chunk leg at all. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `embedding_model?` | `string` | `multilingual-e5-large` | Model that embeds the chunks. Required string length: 0 - 128 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `chunking?` | `object` | - | How a source is cut into chunks. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `keyword?` | `object` | - | The lexical index built alongside the vectors, for exact-term matching. |
:::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `artifacts?` | `object` | - | The artifact leg: knowledge an LLM distills out of the sources, as prose files or database rows. Off by default. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `enabled?` | `boolean` | `false` | Whether curate extracts artifacts at all. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `artifact_model?` | `string` | `lite` | Model tier that does the extraction. standard reads more carefully at a higher token cost. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `artifact_types?` | `object[]` | - | What kinds of artifact to extract. Nothing is extracted until at least one is declared. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `edge_types?` | `object[]` | - | Typed, directed relationships between artifact types, which turn the artifacts into a graph the agent can traverse. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `min_doc_count?` | `integer` | `1` | How many source documents must mention a corpus-scoped subject before it earns an artifact. Raise it to suppress one-off mentions. An artifact type may override it. Required range: 1 <= x <= 64 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `max_tokens?` | `integer` | `1500` | Output cap for one extracted artifact, in tokens. Required range: 128 <= x <= 8192 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `max_doc_chars?` | `integer` | `60000` | Input cap for one extraction call, in characters. With windowing off this also caps how much of a source is read at all; everything beyond it is dropped. Required range: 1000 <= x <= 2000000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `extraction_window_chars?` | `integer` | `0` | Window size for walking a long source across several extraction calls, so its back half is covered rather than dropped. 0 opts out and reads only the head, up to max_doc_chars. Required range: 0 <= x <= 1000000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `mention_max_chars?` | `integer` | `400` | Cap on one recorded mention — what a single document says about the subject — in characters. Required range: 100 <= x <= 4000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `max_mentions_per_artifact?` | `integer` | `40` | How many mentions are fed into the pass that reduces them into one corpus-wide artifact. Required range: 1 <= x <= 500 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `mention_context_chars?` | `integer` | `8000` | Cap on those mentions once concatenated, in characters. Applied after max_mentions_per_artifact. Required range: 1000 <= x <= 100000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `max_artifacts_per_type?` | `integer` | `10000` | How many artifacts one type may produce. Omit for no cap. Required range: 1 <= x <= 10000 |
:::
::::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `optimize?` | `object` | - | The scheduled self-tuning loop: it clusters the queries that answered badly and tries candidate manifests against an ephemeral index until one reproduces the recorded answers. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `schedule?` | `string` | `0 * * * *` | Cron expression the tuning loop runs on. Required string length: 0 - 128 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `latency_threshold_ms?` | `integer` | `60000` | A query slower than this counts as a problem worth tuning for, as does any query that fell back from artifacts to chunks. 0 disables the latency test, leaving only fallback. Required range: 0 <= x <= 600000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `min_group_size?` | `integer` | `2` | How many near-duplicate problem queries must cluster together before the loop tunes for them. Keeps a one-off slow query from triggering a manifest change. Required range: 1 <= x <= 100 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `eval_pass_rate_threshold?` | `number` | `1` | Fraction of eval queries a candidate manifest must answer correctly to be considered ready. 1 demands all of them. Required range: 0 <= x <= 1 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `max_iterations?` | `integer` | `20` | How many candidate manifests the loop tries before stopping with its best. Required range: 1 <= x <= 100 |
:::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `search?` | `object` | - | Standing instructions for the query runtime, pinned on the context rather than sent per turn. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `instructions?` | `string` | - | The context's default system prompt, applied to every turn in scope. A session's own system_prompt appends to it rather than replacing it. |
:::
:::::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `semantic_index?` | `string \| null` | - | Host of the index backing this context's vector retrieval. Null until a curate resolves one. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `keyword_index?` | `string \| null` | - | Host of the index backing keyword retrieval. The same host as semantic_index today — the two names are separate seams over one index. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `is_optimizing` | `boolean` | - | An optimize task is in flight. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `optimize_task_id?` | `string \| null` | - | The optimize task — the running one, or the last to finish. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `optimize_score?` | `number \| null` | - | Eval pass rate the last optimize's best iteration scored. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `optimize_iterations?` | `integer \| null` | - | How many candidate manifests the last run tried. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `last_optimized_at?` | `string \| null` | - | When an optimize last persisted a tuned manifest. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `last_curated_at?` | `string \| null` | - | When a curate last flipped a new index version live. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `has_sources` | `boolean` | - | The source tree holds at least one file. False blocks curate. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `last_source_import_at?` | `string \| null` | - | When sources were last staged by an upload or import. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `is_curating` | `boolean` | - | A curate task is in flight. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `curate_task_id?` | `string \| null` | - | The curate task — the running one, or the last to finish. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `is_importing` | `boolean` | - | An import task is in flight. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `import_task_id?` | `string \| null` | - | The import task — the running one, or the last to finish. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `is_exploring` | `boolean` | - | An explore task is in flight. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `explore_task_id?` | `string \| null` | - | The explore task — the running one, or the last to finish. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `is_restoring` | `boolean` | - | A restore task is in flight. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `restore_task_id?` | `string \| null` | - | The restore task — the running one, or the last to finish. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `manifest_suggestion?` | `object` | - | Outcome of the last explore run, pinned to the context row. A proposal only — apply it by writing the manifest and forcing a curate. |

::::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `matches` | `object[]` | - | Proposed templates, best fit first. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `template_id` | `string` | - | Catalog entry the run proposes for this corpus. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `rationale` | `string` | - | Why the run thinks this template fits the corpus. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `confidence` | `number` | - | How sure the run is, 0–1. Low-confidence proposals are dropped before this point. |
:::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `none` | `boolean` | - | True when no template fit |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `explored_at` | `string` | - | When the run produced this proposal. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `task_id?` | `string` | - | The explore task that produced it. |
::::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `sample_queries?` | `string[]` | - | Example questions the curated corpus can answer, written by the last curate. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `is_grooming` | `boolean` | - | A groom task is in flight. Work contexts only. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `groom_task_id?` | `string` | - | The groom task — the running one, or the last to finish. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `groom_artifact_count?` | `integer` | - | Artifacts the last groom left in the work context. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `last_groomed_at?` | `string` | - | When a groom last consolidated the work context. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `created_at` | `string` | - | When the context was created. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `updated_at` | `string` | - | When the context last changed. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `stats?` | `object` | - | Aggregate task counters. Populated only on the list endpoint. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tasks_total` | `integer` | - | Tasks this context has ever run. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tasks_active` | `integer` | - | Tasks in a non-terminal state. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tasks_completed` | `integer` | - | Tasks that finished successfully. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tasks_failed` | `integer` | - | Tasks that ended in failure. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tasks_cancelled` | `integer` | - | Runs stopped before they finished. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tokens_total` | `integer` | - | Prompt plus completion tokens across every task. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `runtime_seconds` | `integer` | - | Summed container runtime across every task. |
:::

## Related pages

- [List contexts (newest first, with stats)](./data-plane-contexts-list-contexts-newest-first-with-stats.md)
- [Create a context](./data-plane-contexts-create-a-context.md)
- [Update a context](./data-plane-contexts-update-a-context.md)
- [Delete a context (and its Pinecone indexes)](./data-plane-contexts-delete-a-context-and-its-pinecone-indexes.md)
- [Per-context task statistics](./data-plane-contexts-per-context-task-statistics.md)
- [Trigger an on-demand self-tuning optimize](./data-plane-contexts-trigger-an-on-demand-self-tuning-optimize.md)
- [Run the Design-flow explore agent (propose a manifest)](./data-plane-contexts-run-the-design-flow-explore-agent-propose-a-manifest.md)
- [Estimate the token + time cost of curating the in-progress manifest](./data-plane-contexts-estimate-the-token-time-cost-of-curating-the-in-progress-manifest.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.