Create pages
Creates the repo's Pages site and answers 201 Created with it.
POST /v1/provider/github/repos/{repo}/pages
| Address | https://api.hanzo.ai/v1/provider/github/repos/{repo}/pages |
| Method | POST |
| Operation | post_provider_github_repos_by_repo_pages |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Creates the repo's Pages site and answers 201 Created with it. With buildType "workflow" the site builds via GitHub Actions; otherwise it builds from a branch source, defaulting to the repo's own default branch when none is given. Only "/" and "/docs" are legal source paths (GitHub's rule).
Request
5 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
repo | path | string | yes | Repo is the repository, from the :repo path segment. |
branch | body | string | — | Branch is the legacy source branch; empty defaults to the repo's own default branch. |
buildType | body | string | — | BuildType selects the builder: "workflow" builds via GitHub Actions, anything else builds from the branch source above. |
path | body | string | — | Path is the source directory within the branch: "/" (the default) or "/docs". |
repo | body | string | — | Repo is the repository, from the :repo path segment. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | provider.githubPagesView | ok |
default | problem-details | refused |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
buildType | body | string | — | BuildType is the builder in use: "legacy" (branch source) or "workflow". |
cname | body | string | — | CNAME is the custom domain, absent when none is set. |
custom404 | body | boolean | — | Custom404 is whether the repo ships its own 404 page. |
httpsEnforced | body | boolean | — | HTTPSEnforced is GitHub's enforce-HTTPS bit. |
repo | body | string | — | Repo is the repository the site belongs to. |
source | body | provider.githubPagesSource | — | |
source.branch | body | string | — | Branch is the branch the site builds from. |
source.path | body | string | — | Path is the directory within that branch: "/" or "/docs". |
status | body | string | — | Status is GitHub's build state: "built", "building" or "errored". |
url | body | string | — | URL is the live site (GitHub's html_url). |
Failure carries the platform error shape — see Errors.
Examples
hanzo provider github repos pages create <repo>import { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postProviderGithubReposByRepoPages({ repo: 'repo', branch: "<branch>", buildType: "<buildType>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).post_provider_github_repos_by_repo_pages(repo='repo', branch="<branch>", build_type="<buildType>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.PostProviderGithubReposByRepoPages(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, provider_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = provider_api::post_provider_github_repos_by_repo_pages(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ProviderApi(client).postProviderGithubReposByRepoPages();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/provider/github/repos/<repo>/pages \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"branch": "<branch>",
"buildType": "<buildType>"
}'MCP declares no tool for provider — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?