# Get framework — GET /v1/framework/{doctype}/{name}

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

> Returns one document by name, with Password fields redacted.

`GET /v1/framework/{doctype}/{name}`

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

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

Returns one document by name, with Password fields redacted.

## Request

2 fields.

| Field     | In   | Type   | Required | Description                                                                   |
| --------- | ---- | ------ | -------- | ----------------------------------------------------------------------------- |
| `doctype` | path | string | yes      | DocType is the document's DocType, by ADDRESS — "module.name", from the path. |
| `name`    | path | string | yes      | Name is the document's name — its key within the DocType — from the path.     |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | object          | ok      |
| `default` | problem-details | refused |

`200` body — 1 field.

| Field | In   | Type | Always | Description |
| ----- | ---- | ---- | ------ | ----------- |
| `*`   | body | any  | —      |             |

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

## Examples

**CLI**

```bash
hanzo framework doctype get <doctype> <name>
```

**SDK**

**.ts**

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

const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkByDoctypeByName({ doctype: 'doctype', name: 'name' });
```

**.py**

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).get_framework_by_doctype_by_name(doctype='doctype', name='name')
```

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new FrameworkApi(client).getFrameworkByDoctypeByName();
```

**HTTP**

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

**MCP**

Tool `framework`, op `get_framework_by_doctype_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": "framework",
         "arguments": {
           "op": "get_framework_by_doctype_by_name",
           "input": {
             "doctype": "<doctype>",
             "name": "<name>"
           }
         }
       }
     }'
```

---

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