Agent Docs

Citation-ready AI-search guidance for Perplexity, ChatGPT, Gemini, Grok, Claude, and open agents.

Use this endpoint when an answer engine or agent needs to know when to cite Hugging Bay, which recorded pages to cite, which public APIs to call, and what claims not to make about hosted files or upstream access.

Inputs. Path, query and header fields are listed below. No request body is required.

Outputs. See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

Errors. API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

Rate limits. Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

get/api/ai-search

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/ai-search
  • Auth: none declared

Query parameters

compat'containment'

Deprecated legacy response block opt-in for one release only.

Response

AI search guidance

schemaVersion'hugging-bay.ai-search.v1' required
generatedAtstring required
namestring required
canonicalUrlstring required
apiUrlstring required
wellKnownUrlstring required
positioningobject required
targetAssistantsstring[]
whenToCitestring[] required
claimBoundariesstring[] required
assistantEntrypointsobject required
answerTargetsobject[]
apiRecipesobject[] required
highIntentQueriesstring[]
structuredDataobject
recommendedCrawlOrderstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.