Skip to content

Search the artifacts in a workspace that you can open, by words and by meaning: each hit is the artifact with the passage that matched (snippet, and the heading it is under), its space_name and edited_at.

GET/workspaces/{workspace}/artifacts/search

Narrow with kind, space, project and limit (at most 50). Only what you can read now is found.

Matches words and meaning, and is checked again against who can read each artifact now: one shared with you a minute ago is found, one taken away is not.

  • Authentication: Required. Send an access token as Authorization: Bearer.
  • MCP tool: artifact with action search, and the same inputs
  • Scope: An access token needs artifacts:read.
Name Type Required Description
workspace string Yes The workspace’s slug, e.g. “acme”.
Name Type Required Description
q string Yes Words or a question.
kind string No doc, slides, design or dashboard. One of doc, slides, design, dashboard.
space string No A space: its slug (general) or id (spc_…).
project string No Only artifacts about this repository: owner/name.
limit integer No How many hits, at most 50.
curl "https://api.g1t.sh/workspaces/acme/artifacts/search?q=what+ships+in+Q4" \
-H "Authorization: Bearer $G1T_TOKEN"

A successful request answers 200 with:

[
{
"id": "fol_01kq7c4e6g8j0m2p4r6t8v0x2z",
"kind": "doc",
"title": "Q4 roadmap",
"icon": "🗺️",
"slug": "q4-roadmap-fol_01kq7c4e6g8j0m2p4r6t8v0x2z",
"html_url": "https://g1t.sh/acme/-/artifacts/q4-roadmap-fol_01kq7c4e6g8j0m2p4r6t8v0x2z",
"space_name": "General",
"snippet": "We ship the merge queue and Artifacts in Q4; dashboards follow.",
"heading": "This quarter",
"matched": "both",
"edited_at": "2026-10-08T16:40:12.000Z"
}
]

A failed request answers with one of these statuses and a body like {"error": {"code": "not_found", "message": "Repository not found."}}. See errors.

Status Code When
401 unauthenticated A token is required, or the one sent is not valid.
403 forbidden The token is valid but not allowed to do this, such as a member-only change or an agent token outside its repository.
404 not_found It does not exist, or you cannot see it.
422 invalid The input is not valid. message says which field and why.