{"openapi":"3.1.0","info":{"title":"Sanity Projects (BYOK) API","version":"0.1.0","description":"Sanity Projects (BYOK) lets an AI assistant read your own Sanity Projects data through the Sanity Projects API with a key you supply (API token (Administrator or Developer role)). Read-only: 8 tools (list_projects, get_project, list_datasets, list_cors_origins, list_project_features, list_project_permissions, list_dataset_tags, get_embeddings_settings). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sanity-projects.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sanity-projects/docs"},"termsOfService":"https://connectorbay.com/byok-sanity-projects/terms"},"servers":[{"url":"https://byok-sanity-projects.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sanity-projects/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_projects":{"post":{"operationId":"list_projects","summary":"List the Sanity projects the token's account belongs to with name, studio host, organization, status flags and creation ","description":"List the Sanity projects the token's account belongs to with name, studio host, organization, status flags and creation date. Use for \"Which Sanity projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_project":{"post":{"operationId":"get_project","summary":"Get one Sanity project: display name, studio host, organization, blocked or disabled status, activity feed setting and c","description":"Get one Sanity project: display name, studio host, organization, blocked or disabled status, activity feed setting and creation date. Use for \"Is my Sanity project abc12def disabled or blocked\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"get_projectArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_datasets":{"post":{"operationId":"list_datasets","summary":"List the datasets of a Sanity project with their access mode (public, private or custom). Use for \"Which datasets does m","description":"List the datasets of a Sanity project with their access mode (public, private or custom). Use for \"Which datasets does my Sanity project have and are they private\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_datasetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_cors_origins":{"post":{"operationId":"list_cors_origins","summary":"List the browser origins allowed by CORS for a Sanity project, with whether credentials are allowed. Use for \"Which orig","description":"List the browser origins allowed by CORS for a Sanity project, with whether credentials are allowed. Use for \"Which origins can call my Sanity project from a browser\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_cors_originsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_project_features":{"post":{"operationId":"list_project_features","summary":"List the feature flags that are active for a Sanity project (plain strings). Use for \"Which features are active on my Sa","description":"List the feature flags that are active for a Sanity project (plain strings). Use for \"Which features are active on my Sanity project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_project_featuresArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_project_permissions":{"post":{"operationId":"list_project_permissions","summary":"List the permission names that apply to a Sanity project for the token (plain strings). Use for \"What permissions do I h","description":"List the permission names that apply to a Sanity project for the token (plain strings). Use for \"What permissions do I have in my Sanity project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_project_permissionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dataset_tags":{"post":{"operationId":"list_dataset_tags","summary":"List the tags of a Sanity dataset with title, description, tone and the datasets each tag is assigned to. Use for \"Which","description":"List the tags of a Sanity dataset with title, description, tone and the datasets each tag is assigned to. Use for \"Which tags are on my Sanity production dataset\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"},"dataset":{"description":"Dataset name, for example 'production'.","maxLength":64,"title":"Dataset","type":"string"}},"required":["project_id","dataset"],"title":"list_dataset_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_embeddings_settings":{"post":{"operationId":"get_embeddings_settings","summary":"Get the embeddings index settings of a Sanity dataset: enabled flag, GROQ projection and status (ready, updating or erro","description":"Get the embeddings index settings of a Sanity dataset: enabled flag, GROQ projection and status (ready, updating or error). Use for \"Is the embeddings index enabled for my Sanity production dataset\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sanity project ID, a short code such as 'abc12def' (see list_projects).","maxLength":32,"title":"Project Id","type":"string"},"dataset":{"description":"Dataset name, for example 'production'.","maxLength":64,"title":"Dataset","type":"string"}},"required":["project_id","dataset"],"title":"get_embeddings_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}