# Get prompt

URL: https://docs.hanzo.ai/docs/openapi/prompt/get-prompt-by-name

> Returns one of the caller org's prompts: its CURRENT template text plus the metadata of every version it has had.

`GET /v1/prompt/{name}`

> [Prompt →](https://docs.hanzo.ai/docs/openapi/prompt) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                         |
| ------------- | --------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/prompt/{name}` |
| **Method**    | `GET`                                   |
| **Operation** | `get_prompt_by_name`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`  |

Returns one of the caller org's prompts: its CURRENT template text plus the
metadata of every version it has had. The history carries version numbers, types
and timestamps only — not each version's body — so a long history cannot inflate
this response. A name the caller's org does not own is 404, whoever owns it.

## Request

1 field.

| Field  | In   | Type   | Required | Description                                  |
| ------ | ---- | ------ | -------- | -------------------------------------------- |
| `name` | path | string | yes      | Name is the prompt to act on, from the path. |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | prompt.promptDetail | ok      |
| `default` | problem-details     | refused |

`200` body — 12 fields.

| Field                        | In   | Type                  | Always | Description                                                                                                                         |
| ---------------------------- | ---- | --------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| `createdAt`                  | body | string                | —      | CreatedAt is when version 1 was written, RFC 3339 UTC.                                                                              |
| `labels`                     | body | string\[]             | —      | Labels is the current version's free-form taxonomy.                                                                                 |
| `lastUpdatedAt`              | body | string                | —      | UpdatedAt is when the current version was appended, RFC 3339 UTC.                                                                   |
| `name`                       | body | string                | —      | Name is the prompt's org-unique handle and the URL segment it is addressed by.                                                      |
| `prompt`                     | body | string                | —      | Prompt is the CURRENT version's template body — the only content this service returns.                                              |
| `tags`                       | body | string\[]             | —      | Tags is the second free-form taxonomy, same rules as Labels.                                                                        |
| `type`                       | body | string                | —      | Type labels the current version's kind; "text" unless the creator said otherwise.                                                   |
| `version`                    | body | integer (int64)       | —      | Version is the current version number, starting at 1 and incremented by one on every create against an existing name.               |
| `versionHistory`             | body | prompt.versionView\[] | —      | Versions is the history METADATA, newest first, capped at the last 100 — no bodies, so a long history cannot inflate this response. |
| `versionHistory[].createdAt` | body | string                | —      | CreatedAt is when this revision was appended, RFC 3339 UTC.                                                                         |
| `versionHistory[].type`      | body | string                | —      | Type is the kind this revision was written with, which may differ from the current one.                                             |
| `versionHistory[].version`   | body | integer (int64)       | —      | Version is this revision's number, 1 for the first.                                                                                 |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo prompt get <name>
```

**SDK**

**.ts**

```ts
import { Configuration, PromptApi } from 'hanzoai';

const api = new PromptApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPromptByName({ name: 'name' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PromptApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PromptApi(client).get_prompt_by_name(name='name')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PromptAPI.GetPromptByName(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, prompt_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = prompt_api::get_prompt_by_name(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PromptApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PromptApi(client).getPromptByName();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/prompt/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `prompt`, op `get_prompt_by_name` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "prompt",
         "arguments": {
           "op": "get_prompt_by_name",
           "input": {
             "name": "<name>"
           }
         }
       }
     }'
```

---

[Prompt API](https://docs.hanzo.ai/docs/openapi/prompt) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)