--- title: Get a namespace --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [AI Search](https://developers.cloudflare.com/api/go/resources/ai_search) [Namespaces](https://developers.cloudflare.com/api/go/resources/ai_search/subresources/namespaces) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a namespace client.AISearch.Namespaces.Read(ctx, name, query) (\*[NamespaceReadResponse](), error) GET/accounts/{account\_id}/ai-search/namespaces/{name} Retrieve a namespace and its description. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### ParametersExpand Collapse name string [Link to this property](<#(resource)%20ai_search.namespaces%20%3E%20(method)%20read%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)
query NamespaceReadParams AccountID param.Field\[string] Link to this property
[Link to this property](<#(resource)%20ai_search.namespaces%20%3E%20(method)%20read%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type NamespaceReadResponse struct{…} CreatedAt Time formatdate-time Link to this property Name string Link to this property Description stringOptional Optional description for the namespace. Max 256 characters. maxLength256 Link to this property PublicEndpointID stringOptional Link to this property
PublicEndpointParams NamespaceReadResponsePublicEndpointParamsOptional AuthorizedHosts \[]stringOptional Link to this property
ChatCompletionsEndpoint NamespaceReadResponsePublicEndpointParamsChatCompletionsEndpointOptional Disabled boolOptional Disable chat completions endpoint for this public endpoint Link to this property
Link to this property CustomDomains \[]stringOptional Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). Link to this property DefaultDomainEnabled boolOptional When false, the instance is reachable only via a registered custom domain and the default <public\_endpoint\_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public\_endpoint\_params is replaced wholesale on update, so resend default\_domain\_enabled on every update to keep the default host off — omitting it resets to true. Link to this property Enabled boolOptional Link to this property InstancesAllowed \[]stringOptional Instance IDs exposed through the namespace public endpoint. Empty means nothing is searchable. Every ID must be an existing instance in this namespace, and the list cannot exceed the account’s multi-instance search limit. Link to this property
Mcp NamespaceReadResponsePublicEndpointParamsMcpOptional Description stringOptional Link to this property Disabled boolOptional Disable MCP endpoint for this public endpoint Link to this property
Link to this property
RateLimit NamespaceReadResponsePublicEndpointParamsRateLimitOptional PeriodMs int64Optional maximum3600000 minimum60000 Link to this property Requests int64Optional minimum1 Link to this property
Technique NamespaceReadResponsePublicEndpointParamsRateLimitTechniqueOptional One of the following: const NamespaceReadResponsePublicEndpointParamsRateLimitTechniqueFixed NamespaceReadResponsePublicEndpointParamsRateLimitTechnique = "fixed" Link to this property const NamespaceReadResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceReadResponsePublicEndpointParamsRateLimitTechnique = "sliding" Link to this property
Link to this property
Link to this property
SearchEndpoint NamespaceReadResponsePublicEndpointParamsSearchEndpointOptional Disabled boolOptional Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_search.namespaces%20%3E%20(model)%20NamespaceReadResponse%20%3E%20(schema)>) ### Get a namespace Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/ai_search" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.AISearch.Namespaces.Read( context.TODO(), "production", ai_search.NamespaceReadParams{ AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.PublicEndpointID) } ``` 200 example ``` { "result": { "created_at": "2019-12-27T18:11:19.117Z", "name": "production", "description": "Production environment", "public_endpoint_id": "public_endpoint_id", "public_endpoint_params": { "authorized_hosts": [ "string" ], "chat_completions_endpoint": { "disabled": true }, "custom_domains": [ "search.example.com" ], "default_domain_enabled": true, "enabled": true, "instances_allowed": [ "docs", "blog" ], "mcp": { "description": "description", "disabled": true }, "rate_limit": { "period_ms": 60000, "requests": 1, "technique": "fixed" }, "search_endpoint": { "disabled": true } } }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "created_at": "2019-12-27T18:11:19.117Z", "name": "production", "description": "Production environment", "public_endpoint_id": "public_endpoint_id", "public_endpoint_params": { "authorized_hosts": [ "string" ], "chat_completions_endpoint": { "disabled": true }, "custom_domains": [ "search.example.com" ], "default_domain_enabled": true, "enabled": true, "instances_allowed": [ "docs", "blog" ], "mcp": { "description": "description", "disabled": true }, "rate_limit": { "period_ms": 60000, "requests": 1, "technique": "fixed" }, "search_endpoint": { "disabled": true } } }, "success": true } ```