> For the complete documentation index, see [llms.txt](https://docs.zkpass.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zkpass.org/developer-guides/js-sdk/schema/quick-start-for-creating-custom-schema.md).

# Quick Start for Creating Custom Schema

### Login zkPass dev center and create custom schema

***

Login in [zkPass dev center](https://dev.zkpass.org), create a project and add a schema.

<figure><img src="/files/4BPf9zAYoga8xqHYidJC" alt="" width="375"><figcaption></figcaption></figure>

Click on "Add Custom Schema". If you haven't installed the [zkPass Schema Validator](https://chromewebstore.google.com/detail/kpcbjghknfclbkejkdllpjhhheppaoca), please click "install" to install the extension first.

<figure><img src="/files/oR4urtY5OIQtt7Yh5pxS" alt="" width="375"><figcaption></figcaption></figure>

Enter the schema name, select the category, paste your custom schema into the JSON schema field, and then click "Check Schema." The website specified in your schema JSON will be opened.

<figure><img src="/files/1RMpLc6OAe7E9SEYEBs1" alt="" width="375"><figcaption></figcaption></figure>

If the schema validation is successful, you will observe the 'Check Pass' button at the bottom.

<figure><img src="/files/da5n6C787yyoBjXrWoNN" alt="" width="375"><figcaption></figcaption></figure>

Upon clicking the 'Check Pass' button, you will be redirected back to the [zkPass dev center](https://dev.zkpass.org) and presented with a success modal. Then, you can submit your schema.

<figure><img src="/files/bEkhqQgyOEoUuotSQrty" alt="" width="375"><figcaption></figcaption></figure>

Congratulations, you have successfully generated the schema. You can now seamlessly integrate it into your project.

<figure><img src="/files/iaFteJjssnmrhXyhDVF9" alt="" width="375"><figcaption></figcaption></figure>

If the schema validation is failed, you will observe the 'Check Error Message' button at the bottom.

<figure><img src="/files/QOUMw5Bq1oYulbP6U6F0" alt="" width="375"><figcaption></figcaption></figure>

Upon clicking the 'Check Error Message' button, you will be redirected back to the [zkPass dev center](https://dev.zkpass.org) and presented with a error modal. Then, you can correct your schema based on error messages.

<figure><img src="/files/yV9wTWMnDMOVDs7V9IPQ" alt="" width="375"><figcaption></figcaption></figure>

### Tips for writing a schema json file on Chrome

***

Open the website you are targeting, navigate to the page containing the desired information, right-click on the page, and choose "inspect."

<figure><img src="/files/HIBa4XP97DVoooGXHJM4" alt="" width="375"><figcaption></figcaption></figure>

Select the "Network" tab, then refresh the page to capture all the HTTP requests. You can use the "Fetch/XHR" tag to filter the RESTful APIs.

<figure><img src="/files/rq51wfWWaJHeB9ZA7t4u" alt="" width="375"><figcaption></figcaption></figure>

Locate the APIs that provide the desired information. Click on each of them, then click "Headers" tabs to review the request details to identify the **host** and **intercept** for the schema.

<figure><img src="/files/47y8kH4x8yZIPB7nnNUb" alt="" width="375"><figcaption></figcaption></figure>

Click "Preview" tag to review the response details to identify the **assert** and **nullifier** for the schema.

<figure><img src="/files/cu3JYxcUJUlNmXNXkNly" alt="" width="375"><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zkpass.org/developer-guides/js-sdk/schema/quick-start-for-creating-custom-schema.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
