# Get forms

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

> Read one form by its (owner, name) key.

`GET /v1/ai/forms/{owner}/{name}`

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

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

Read one form by its (owner, name) key.

## Request

2 fields.

| Field   | In   | Type   | Required | Description |
| ------- | ---- | ------ | -------- | ----------- |
| `owner` | path | string | yes      |             |
| `name`  | path | string | yes      |             |

## Response

| Status | Body | Meaning                                             |
| ------ | ---- | --------------------------------------------------- |
| `200`  |      | Envelope.                                           |
| `401`  | —    | No credential, or one this service does not accept. |
| `403`  | —    | A valid credential that may not do this.            |

`200` body — 19 fields.

| Field                      | In   | Type        | Always | Description                                             |
| -------------------------- | ---- | ----------- | ------ | ------------------------------------------------------- |
| `data`                     | body | any         | —      | The operation's own result.                             |
| `data2`                    | body | any         | —      | A second result the operation defines, when it has one. |
| `msg`                      | body | string      | yes    | Empty on success, the reason on failure.                |
| `status`                   | body | string      | yes    | One of `ok`, `error`.                                   |
| `data.category`            | body | string      | —      |                                                         |
| `data.createdTime`         | body | string      | —      |                                                         |
| `data.displayName`         | body | string      | —      |                                                         |
| `data.formItems`           | body | FormItem\[] | —      |                                                         |
| `data.formItems[].label`   | body | string      | —      |                                                         |
| `data.formItems[].name`    | body | string      | —      |                                                         |
| `data.formItems[].type`    | body | string      | —      |                                                         |
| `data.formItems[].visible` | body | boolean     | —      |                                                         |
| `data.formItems[].width`   | body | string      | —      |                                                         |
| `data.name`                | body | string      | —      |                                                         |
| `data.owner`               | body | string      | —      |                                                         |
| `data.position`            | body | string      | —      |                                                         |
| `data.tag`                 | body | string      | —      |                                                         |
| `data.type`                | body | string      | —      |                                                         |
| `data.url`                 | body | string      | —      |                                                         |

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

## Examples

**CLI**

```bash
hanzo ai forms owner get <owner> <name>
```

**SDK**

**.ts**

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

const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAiFormsByOwnerByName({ owner: 'owner', name: 'name' });
```

**.py**

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AiApi(client).get_ai_forms_by_owner_by_name(owner='owner', name='name')
```

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new AiApi(client).getAiFormsByOwnerByName();
```

**HTTP**

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

**MCP**

MCP declares no tool for **ai** — `tools/list` on `https://api.hanzo.ai/v1/mcp` names the products it does reach. Use HTTP or an SDK.

---

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