REST API

The v2alpha REST API powers Stitch Workspace management, codebase priorities, insights, and solutions.

Calling endpoints via stitch api <path> requires workspace features to be enabled once with stitch enable loop.

Calling the API from the CLI

stitch api workspaces
stitch api workspaces/<workspace-id>/goals
stitch api -X POST workspaces/<workspace-id>/insights:generate --json '{}'

Endpoints

Method	Endpoint
POST	clientNotices:fetch
POST	contexts:parseMcpJson
POST	feedback:submit
POST	workspaces/{workspace}/files
GET	organizations/{organization}
GET	organizations
POST	tos:accept
GET	tos:check
GET	users/{user}/preferences
PATCH	users/{user}/preferences
POST	users/{user}/tos:accept
GET	users/{user}/tos:check
POST	v2alpha:completeOAuth
POST	workspaces/{workspace}:addRepository
POST	workspaces/{workspace}:addUser
POST	workspaces
POST	workspaces/{workspace}:createToolkitConnectLink
DELETE	workspaces/{workspace}
GET	workspaces/{workspace}
GET	workspaces/{workspace}/marketRadarCheckpoint
GET	workspaces/{workspace}/userNotificationSettings
GET	workspaces/{workspace}/workspaceNotificationSettings
GET	workspaces
PATCH	workspaces/{workspace}
POST	workspaces/{workspace}:removeRepository
POST	workspaces/{workspace}:removeUser
PATCH	workspaces/{workspace}/userNotificationSettings
PATCH	workspaces/{workspace}/workspaceNotificationSettings
DELETE	workspaces/{workspace}/assessments/{assessment}
POST	workspaces/{workspace}/assessments:generate
GET	workspaces/{workspace}/assessments/{assessment}
GET	workspaces/{workspace}/assessments
PATCH	workspaces/{workspace}/assessments/{assessment}
POST	workspaces/{workspace}/contexts
DELETE	workspaces/{workspace}/contexts/{context}
GET	workspaces/{workspace}/contexts/{context}
POST	workspaces/{workspace}/contexts:initiateOAuth
GET	workspaces/{workspace}/contexts
PATCH	workspaces/{workspace}/contexts/{context}
GET	workspaces/{workspace}/contexts:search
GET	workspaces/{workspace}/eventDeliveries/{eventDeliverie}
GET	workspaces/{workspace}/eventDeliveries
GET	workspaces/{workspace}/events
POST	workspaces/{workspace}/events/{event}:replay
GET	workspaces/{workspace}/feedback:batchGet
POST	workspaces/{workspace}/fileSystemEntries
DELETE	workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}
GET	workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}
GET	workspaces/{workspace}/fileSystemEntries
PATCH	workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}
DELETE	workspaces/{workspace}/files/{file}
GET	workspaces/{workspace}/files/{file}
GET	workspaces/{workspace}/files
GET	workspaces/{workspace}/goalTemplates
POST	workspaces/{workspace}/goals
DELETE	workspaces/{workspace}/goals/{goal}
GET	workspaces/{workspace}/goals/{goal}
GET	workspaces/{workspace}/goals/{goal}/insightGeneration
GET	workspaces/{workspace}/goals
PATCH	workspaces/{workspace}/goals/{goal}
POST	workspaces/{workspace}/goals/suggest
GET	workspaces/{workspace}/goals/{goal}/insightGeneration:queryStatusUpdates
GET	workspaces/{workspace}/insights:batchGet
POST	workspaces/{workspace}/insights/{insight}:dismiss
POST	workspaces/{workspace}/insights/generate
GET	workspaces/{workspace}/insights/{insight}
GET	workspaces/{workspace}/insights/{insight}/investigationReport
GET	workspaces/{workspace}/insights/summary
GET	workspaces/{workspace}/insights
POST	workspaces/{workspace}/insights/{insight}/setReadStatus
POST	workspaces/{workspace}/insights/{insight}:undismiss
POST	workspaces/{workspace}/insights/{insight}/feedback
DELETE	workspaces/{workspace}/insights/{insight}/feedback/{feedback}
GET	workspaces/{workspace}/insights/{insight}/feedback/{feedback}
GET	workspaces/{workspace}/insights/{insight}/feedback
PATCH	workspaces/{workspace}/insights/{insight}/feedback/{feedback}
GET	workspaces/{workspace}/insights/{insight}/insightUpdates/{insightUpdate}/investigationReport
GET	workspaces/{workspace}/insights/{insight}/insightUpdates
POST	workspaces/{workspace}/marketRadarCheckpoint/generate
POST	workspaces/{workspace}/productMd:generate
GET	workspaces/{workspace}/productMd:getStatus
POST	workspaces/{workspace}/skills
DELETE	workspaces/{workspace}/skills/{skill}
GET	workspaces/{workspace}/skills
PATCH	workspaces/{workspace}/skills/{skill}
DELETE	workspaces/{workspace}/toolProviders/{toolProvider}
DELETE	workspaces/{workspace}/toolProviders/{toolProvider}:deleteAuth
GET	workspaces/{workspace}/toolProviders
POST	workspaces/{workspace}/toolProviders:upsert
POST	workspaces/{workspace}/toolProviders/{toolProvider}:upsertAuth
GET	workspaces/{workspace}/users
POST	workspaces/{workspace}/webhookConfigs
DELETE	workspaces/{workspace}/webhookConfigs/{webhookConfig}
GET	workspaces/{workspace}/webhookConfigs/{webhookConfig}
GET	workspaces/{workspace}/webhookConfigs
PATCH	workspaces/{workspace}/webhookConfigs/{webhookConfig}
PATCH	workspaces/{workspace}/webhookConfigs/{webhookConfig}/verify
GET	workspaces/{workspace}/webhookEvents/{webhookEvent}
GET	workspaces/{workspace}/webhookEvents
POST	workspaces/{workspace}/webhookEvents/{webhookEvent}:send

---

clientNotices.fetch

Fetches dynamic notices, alert banners, outage notices, and disclaimers for the client.

stitch api -X POST clientNotices:fetch

---

contexts.parseMcpJson

Parses MCP JSON configuration into normalized tool provider configs.

stitch api -X POST contexts:parseMcpJson

---

feedback.submit

Submits product feedback (e.g. from Stitch CLI).

stitch api -X POST feedback:submit

---

media.upload

Creates a File.

stitch api -X POST workspaces/{workspace}/files

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to create the file metadata in. Format: workspaces/{workspace}.

---

organizations.get

Gets a single organization by resource name.

stitch api organizations/{organization}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the organization to retrieve. Format: organizations/{organization}

---

organizations.list

Lists organizations.

stitch api organizations

Parameters

Name	In	Type	Description
filter	query	string	Optional. A CEL filter expression to filter organizations.
pageSize	query	integer	Optional. The maximum number of organizations to return.
pageToken	query	string	Optional. A page token received from a previous ListOrganizations call.

---

tos.accept

Records that the authenticated user has accepted the specified ToS version.

stitch api -X POST tos:accept

---

tos.check

Checks whether the authenticated user has accepted the specified ToS version.

stitch api tos:check

Parameters

Name	In	Type	Description
user	query	string	Optional. Optional resource name of the user. Defaults to the authenticated user (“users/me”).
version	query	string	Optional. Optional version of the ToS to check (e.g. "2026-03-18"). If omitted, the server checks against the active ToS version configured on the backend.

---

users.getPreferences

Gets preferences for the user.

stitch api users/{user}/preferences

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the user preferences to retrieve. Format: users/{user}/preferences or users/me/preferences

---

users.updatePreferences

Updates preferences for the user.

stitch api -X PATCH users/{user}/preferences

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. Resource name of the user preferences. Format: users/{user}/preferences or users/me/preferences
updateMask	query	string	Optional. The list of fields to update. If empty or contains ”*”, all mutable fields are updated.

---

users.tos.accept

Records that the authenticated user has accepted the specified ToS version.

stitch api -X POST users/{user}/tos:accept

Parameters

Name	In	Type	Description
user (required)	path	string	Optional. Optional resource name of the user. Defaults to the authenticated user (“users/me”).

---

users.tos.check

Checks whether the authenticated user has accepted the specified ToS version.

stitch api users/{user}/tos:check

Parameters

Name	In	Type	Description
user (required)	path	string	Optional. Optional resource name of the user. Defaults to the authenticated user (“users/me”).
version	query	string	Optional. Optional version of the ToS to check (e.g. "2026-03-18"). If omitted, the server checks against the active ToS version configured on the backend.

---

completeOAuth

Completes the OAuth 2.0 flow by exchanging the authorization code for tokens and securely storing them. This is a stateless custom method (AIP-136) as the workspace and provider identities are securely encapsulated within and resolved from the state_token rather than a resource path or parent collection.

stitch api -X POST v2alpha:completeOAuth

---

workspaces.addRepository

Adds a repository to a workspace.

stitch api -X POST workspaces/{workspace}:addRepository

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the workspace to add the repository to. Format: workspaces/{workspace}

---

workspaces.addUser

Adds a user to a workspace.

stitch api -X POST workspaces/{workspace}:addUser

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the workspace to add the user to. Format: workspaces/{workspace}

---

workspaces.create

Creates a new workspace.

stitch api -X POST workspaces

---

workspaces.createToolkitConnectLink

Creates a connect link for authenticating a toolkit in the workspace.

stitch api -X POST workspaces/{workspace}:createToolkitConnectLink

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to create the toolkit connect link for. Format: workspaces/{workspace}.

---

workspaces.delete

Deletes a workspace by resource name.

stitch api -X DELETE workspaces/{workspace}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the workspace to delete. Format: workspaces/{workspace}

---

workspaces.get

Gets a single workspace by resource name.

stitch api workspaces/{workspace}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the workspace to retrieve. Format: workspaces/{workspace}

---

workspaces.getMarketRadarCheckpoint

Gets competitive market analysis details checkpoint.

stitch api workspaces/{workspace}/marketRadarCheckpoint

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the market radar checkpoint. Format: workspaces/{workspace}/marketRadarCheckpoint

---

workspaces.getUserNotificationSettings

Gets the calling user’s notification settings for a workspace.

stitch api workspaces/{workspace}/userNotificationSettings

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the user notification settings. Format: workspaces/{workspace}/userNotificationSettings

---

workspaces.getWorkspaceNotificationSettings

Gets workspace-level notification settings.

stitch api workspaces/{workspace}/workspaceNotificationSettings

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the workspace notification settings. Format: workspaces/{workspace}/workspaceNotificationSettings

---

workspaces.list

Lists workspaces.

stitch api workspaces

Parameters

Name	In	Type	Description
filter	query	string	Optional. A CEL filter expression to filter workspaces.
pageSize	query	integer	Optional. The maximum number of workspaces to return.
pageToken	query	string	Optional. A page token received from a previous ListWorkspaces call.

---

workspaces.patch

Updates an existing workspace.

stitch api -X PATCH workspaces/{workspace}

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. Resource name. Format: workspaces/{workspace}
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.removeRepository

Removes a repository from a workspace.

stitch api -X POST workspaces/{workspace}:removeRepository

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the workspace to remove the repository from. Format: workspaces/{workspace}

---

workspaces.removeUser

Removes a user from a workspace.

stitch api -X POST workspaces/{workspace}:removeUser

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the workspace to remove the user from. Format: workspaces/{workspace}

---

workspaces.updateUserNotificationSettings

Updates the calling user’s notification settings for a workspace.

stitch api -X PATCH workspaces/{workspace}/userNotificationSettings

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. Resource name. Format: workspaces/{workspace}/userNotificationSettings
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.updateWorkspaceNotificationSettings

Updates workspace-level notification settings.

stitch api -X PATCH workspaces/{workspace}/workspaceNotificationSettings

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. Resource name. Format: workspaces/{workspace}/workspaceNotificationSettings
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.assessments.delete

Deletes an assessment by name.

stitch api -X DELETE workspaces/{workspace}/assessments/{assessment}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the assessment to delete. Format: workspaces/{workspace}/assessments/{assessment}

---

workspaces.assessments.generate

Generates assessments for a list of insights.

stitch api -X POST workspaces/{workspace}/assessments:generate

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace. Format: workspaces/{workspace}

---

workspaces.assessments.get

Gets a single assessment by name.

stitch api workspaces/{workspace}/assessments/{assessment}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the assessment to get. Format: workspaces/{workspace}/assessments/{assessment}

---

workspaces.assessments.list

Lists assessments in a workspace.

stitch api workspaces/{workspace}/assessments

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to filter assessments. Supported fields: insights. E.g. insights:"workspaces/123/insights/456"
pageSize	query	integer	Optional. The maximum number of assessments to return. The service may return fewer than this value. If unspecified, at most 20 assessments will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken	query	string	Optional. A page token, received from a previous ListAssessments call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace to list assessments for. Format: workspaces/{workspace}

---

workspaces.assessments.patch

Updates an assessment.

stitch api -X PATCH workspaces/{workspace}/assessments/{assessment}

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. The full resource name of the assessment. Format: workspaces/{workspace}/assessments/{assessment}
updateMask	query	string	Optional. Mask specifying which fields to update.

---

workspaces.contexts.create

Ingests a new context into the workspace.

stitch api -X POST workspaces/{workspace}/contexts

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to create the context in. Format: workspaces/{workspace}.

---

workspaces.contexts.delete

Deletes a context in the workspace.

stitch api -X DELETE workspaces/{workspace}/contexts/{context}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the context to delete. Format: workspaces/{workspace}/contexts/{context}.

---

workspaces.contexts.get

Gets a context by id.

stitch api workspaces/{workspace}/contexts/{context}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the context to retrieve. Format: workspaces/{workspace}/contexts/{context}.

---

workspaces.contexts.initiateOAuth

Initiates the OAuth 2.0 flow for a tool provider. Returns the authorization URL the caller should redirect the user to.

stitch api -X POST workspaces/{workspace}/contexts:initiateOAuth

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to initiate OAuth for. Format: workspaces/{workspace}.

---

workspaces.contexts.list

Lists the contexts in the workspace.

stitch api workspaces/{workspace}/contexts

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to narrow the returned contexts. Supported filterable fields: - data_source: equality match on the context’s data source. Example: data_source = "user_feedback" - annotations.: equality match on an annotation value. Example: annotations.env = "prod" - description: substring match using the HAS (:) operator. Example: description : "error" - data: substring match using the HAS (:) operator. Example: data : "exception" - create_time: inequality match (<=, <, >=, >) using RFC 3339 timestamps. Example: create_time >= "2024-01-01T00:00:00Z" Only compound expressions using AND are supported: data_source = "notes" AND description : "bug" Returns INVALID_ARGUMENT for malformed or unsupported filters.
orderBy	query	string	Optional. Sort order of the returned contexts.
pageSize	query	integer	Optional. The maximum number of contexts to return. The service may return fewer than this value. If unspecified, at most 50 contexts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken	query	string	Optional. A page token, received from a previous ListContexts call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The workspace to list contexts for. Format: workspaces/{workspace}.

---

workspaces.contexts.patch

Updates an existing context in the workspace.

stitch api -X PATCH workspaces/{workspace}/contexts/{context}

Parameters

Name	In	Type	Description
name (required)	path	string	Output only. Identifier. The full resource name of the context. Format: workspaces/{workspace}/contexts/{context}
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.contexts.search

Searches contexts by semantic similarity using vector embeddings.

stitch api workspaces/{workspace}/contexts:search

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to narrow the returned contexts. Follows https://google.aip.dev/160 Supported filterable fields: - data_source: equality match on the context’s data source. Example: data_source = "user_feedback" - annotations.: equality match on an annotation value. Example: annotations.env = "prod" - description: substring match using the HAS (:) operator. Example: description : "error" - data: substring match using the HAS (:) operator. Example: data : "exception" - create_time: inequality match (<=, <, >=, >) using RFC 3339 timestamps. Example: create_time >= "2024-01-01T00:00:00Z"
maxResults	query	integer	Optional. Deprecated: Use page_size instead.
pageSize	query	integer	Optional. The maximum number of search results to return. If unspecified, at most 10 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken	query	string	Optional. A page token, received from a previous SearchContexts call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace to search contexts in. Format: workspaces/{workspace}.
query	query	string	Required. Natural language search query.
readMask	query	string	Optional. Optional. Mask specifying which fields of Context to return.

---

workspaces.eventDeliveries.get

Gets a single event delivery by resource name.

stitch api workspaces/{workspace}/eventDeliveries/{eventDeliverie}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the event delivery. Format: workspaces/{workspace}/eventDeliveries/{event_delivery}

---

workspaces.eventDeliveries.list

Lists event deliveries for a workspace.

stitch api workspaces/{workspace}/eventDeliveries

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression for status and/or event_type.
pageSize	query	integer	Optional. The maximum number of delivery events to return.
pageToken	query	string	Optional. The optional token to use for pagination.
parent (required)	path	string	Required. The workspace to list event deliveries for. Format: workspaces/{workspace}

---

workspaces.events.list

Lists notification events for a workspace.

stitch api workspaces/{workspace}/events

Parameters

Name	In	Type	Description
pageSize	query	integer	Optional. The maximum number of events to return.
pageToken	query	string	Optional. The token to use for pagination.
parent (required)	path	string	Required. The workspace to list events for. Format: workspaces/{workspace}

---

workspaces.events.replay

Replays a notification event to one or more subscribers.

stitch api -X POST workspaces/{workspace}/events/{event}:replay

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the event to replay. Format: workspaces/{workspace}/events/{event}

---

workspaces.feedback.batchGet

Batch retrieves feedback items across multiple insights.

stitch api workspaces/{workspace}/feedback:batchGet

Parameters

Name	In	Type	Description
names	query	string	Required. The resource names of the insights to retrieve feedback for. Format: workspaces/{workspace}/insights/{insight}
parent (required)	path	string	Required. The parent workspace containing the insights. Format: workspaces/{workspace}

---

workspaces.fileSystemEntries.create

Creates a file system entry at the given path.

stitch api -X POST workspaces/{workspace}/fileSystemEntries

Parameters

Name	In	Type	Description
fileSystemEntryId	query	string	Optional. The ID to use for the file system entry, which will become the final component of the file system entry’s resource name.
parent (required)	path	string	Required. The parent workspace to create the entry in. Format: workspaces/{workspace}.

---

workspaces.fileSystemEntries.delete

Deletes a file system entry at the given path.

stitch api -X DELETE workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The name of the file system entry to delete. Format: workspaces/{workspace}/fileSystemEntries/{file_system_entry}

---

workspaces.fileSystemEntries.get

Gets a file system entry by path.

stitch api workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The name of the file system entry to retrieve. Format: workspaces/{workspace}/fileSystemEntries/{file_system_entry}

---

workspaces.fileSystemEntries.list

Lists file system entries in a workspace.

stitch api workspaces/{workspace}/fileSystemEntries

Parameters

Name	In	Type	Description
filter	query	string	Optional. Standard filter string.
pageSize	query	integer	Optional. The maximum number of entries to return.
pageToken	query	string	Optional. The page token to use for pagination.
parent (required)	path	string	Required. The parent workspace to list entries for. Format: workspaces/{workspace}.

---

workspaces.fileSystemEntries.patch

Updates a file system entry at the given path.

stitch api -X PATCH workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. The resource name of the file system entry. Format: workspaces/{workspace}/fileSystemEntries/{file_system_entry} The {file_system_entry} segment is the user-specified relative path.
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.files.delete

Deletes a file from the workspace.

stitch api -X DELETE workspaces/{workspace}/files/{file}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the file to delete. Format: workspaces/{workspace}/files/{file}.

---

workspaces.files.get

Gets a file by id.

stitch api workspaces/{workspace}/files/{file}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the file to retrieve. Format: workspaces/{workspace}/files/{file}.

---

workspaces.files.list

Lists the files in the workspace.

stitch api workspaces/{workspace}/files

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to narrow the returned files. Follows https://google.aip.dev/160 Supported filterable fields: - annotations.: equality match on an annotation value stored in the FileAnnotations table. Only the = (EQUALS) comparator is supported. Example: annotations.env = "prod" Only compound expressions using AND are supported: annotations.env = "prod" AND annotations.team = "ai" Filtering on any other field (e.g. display_name) is not supported and returns INVALID_ARGUMENT. Returns INVALID_ARGUMENT for malformed or unsupported filters.
orderBy	query	string	Optional. Sort order of the returned files.
pageSize	query	integer	Optional. The maximum number of files to return.
pageToken	query	string	Optional. A page token, received from a previous ListFiles call.
parent (required)	path	string	Required. The workspace to list files for. Format: workspaces/{workspace}.

---

workspaces.goalTemplates.list

Lists available starter goal templates for a workspace.

stitch api workspaces/{workspace}/goalTemplates

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to filter goal templates. Follows https://google.aip.dev/160
pageSize	query	integer	Optional. The maximum number of goal templates to return. The service may return fewer than this value. If unspecified, at most 20 templates will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken	query	string	Optional. A page token, received from a previous ListGoalTemplates call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace where goals will be created. Format: workspaces/{workspace}
readMask	query	string	Optional. Optional. Mask specifying which fields to read.

---

workspaces.goals.create

Creates a new goal in the specified workspace.

stitch api -X POST workspaces/{workspace}/goals

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to create the goal in. Format: workspaces/{workspace}

---

workspaces.goals.delete

Deletes a goal.

stitch api -X DELETE workspaces/{workspace}/goals/{goal}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the goal to delete. Format: workspaces/{workspace}/goals/{goal}

---

workspaces.goals.get

Gets a single goal by resource name.

stitch api workspaces/{workspace}/goals/{goal}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the goal to retrieve. Format: workspaces/{workspace}/goals/{goal}
readMask	query	string	Optional. Optional. Mask specifying which fields to read.

---

workspaces.goals.getInsightGeneration

Retrieves the status and state of the latest insight generation run.

stitch api workspaces/{workspace}/goals/{goal}/insightGeneration

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the insight generation status. Format: workspaces/{workspace}/goals/{goal}/insightGeneration.

---

workspaces.goals.list

Lists goals in a workspace.

stitch api workspaces/{workspace}/goals

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to filter goals.
pageSize	query	integer	Optional. The maximum number of goals to return. The service may return fewer than this value. If unspecified, at most 20 goals will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken	query	string	Optional. A page token, received from a previous ListGoals call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace to list goals for. Format: workspaces/{workspace}
readMask	query	string	Optional. Optional. Mask specifying which fields to read.

---

workspaces.goals.patch

Updates an existing goal.

stitch api -X PATCH workspaces/{workspace}/goals/{goal}

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. The full resource name of the goal. Format: workspaces/{workspace}/goals/{goal}
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.goals.suggest

Suggests goals for a workspace.

stitch api -X POST workspaces/{workspace}/goals/suggest

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace where goals will be suggested. Format: workspaces/{workspace}

---

workspaces.goals.insightGeneration.queryStatusUpdates

Queries intermediate status updates emitted during an insight generation run.

stitch api workspaces/{workspace}/goals/{goal}/insightGeneration:queryStatusUpdates

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the insight generation status. Format: workspaces/{workspace}/goals/{goal}/insightGeneration.
pageSize	query	integer	Optional. The maximum number of status updates to return.
pageToken	query	string	Optional. A page token received from a previous call to fetch only newly emitted updates.

---

workspaces.insights.batchGet

Gets multiple insights by name.

stitch api workspaces/{workspace}/insights:batchGet

Parameters

Name	In	Type	Description
names	query	string	Required. The names of the insights to retrieve. A maximum of 100 insights can be retrieved in a batch. Format: workspaces/{workspace}/insights/{insight}
parent (required)	path	string	Required. The parent workspace containing the insights. Format: workspaces/{workspace}

---

workspaces.insights.dismiss

Dismisses an insight.

stitch api -X POST workspaces/{workspace}/insights/{insight}:dismiss

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the insight to dismiss. Format: workspaces/{workspace}/insights/{insight}.

---

workspaces.insights.generate

Generates insights for a set of goals in a workspace.

stitch api -X POST workspaces/{workspace}/insights/generate

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace triggering insight generation. Format: workspaces/{workspace}

---

workspaces.insights.get

Gets a single insight by name.

stitch api workspaces/{workspace}/insights/{insight}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the insight to get. Format: workspaces/{workspace}/insights/{insight}.

---

workspaces.insights.getInvestigationReport

Gets an investigation report for an insight or a specific insight update. If requested for an insight (workspaces/{workspace}/insights/{insight}/investigationReport), returns the latest investigation report (corresponding to the most recent insight update). If requested for a specific insight update (workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport), returns the investigation report at that update.

stitch api workspaces/{workspace}/insights/{insight}/investigationReport

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the investigation report. Format: - workspaces/{workspace}/insights/{insight}/investigationReport to retrieve the latest investigation report for the insight (corresponding ## to the most recent insight update). workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport to retrieve the investigation report for a specific insight update.

---

workspaces.insights.getSummary

Gets a summary of insight counts by status for a workspace.

stitch api workspaces/{workspace}/insights/summary

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to filter insights summary.
name (required)	path	string	Required. The parent workspace to query insights summary for. Format: workspaces/{workspace}.

---

workspaces.insights.list

Lists insights in a workspace.

stitch api workspaces/{workspace}/insights

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to filter insights. Supported fields: “state”, “goal_ids”.
pageSize	query	integer	Optional. The maximum number of insights to return. The service may return fewer than this value. If unspecified, at most 20 insights will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken	query	string	Optional. A page token, received from a previous ListInsights call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace to list insights for. Format: workspaces/{workspace}.
readMask	query	string	Optional. Optional. Mask specifying which fields to read. The wildcard * is not supported.

---

workspaces.insights.setReadStatus

Sets the per-user read/unread status for an insight.

stitch api -X POST workspaces/{workspace}/insights/{insight}/setReadStatus

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the insight. Format: workspaces/{workspace}/insights/{insight}

---

workspaces.insights.undismiss

Undismisses an insight.

stitch api -X POST workspaces/{workspace}/insights/{insight}:undismiss

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the insight to undismiss. Format: workspaces/{workspace}/insights/{insight}.

---

workspaces.insights.feedback.create

Submits feedback on an insight.

stitch api -X POST workspaces/{workspace}/insights/{insight}/feedback

Parameters

Name	In	Type	Description
insightFeedbackId	query	string	Optional. The ID to use for the feedback, which will become the final component of the feedback’s resource name. Client-assigned IDs are not supported. This field must be empty.
parent (required)	path	string	Required. The parent insight resource name. Format: workspaces/{workspace}/insights/{insight}

---

workspaces.insights.feedback.delete

Deletes an insight feedback entry.

stitch api -X DELETE workspaces/{workspace}/insights/{insight}/feedback/{feedback}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the feedback item to delete. Format: workspaces/{workspace}/insights/{insight}/feedback/{feedback} Supports the virtual resource alias like (per AIP-122) to operate directly on the authenticated caller’s like without pre-fetching its ID.

---

workspaces.insights.feedback.get

Gets a specific feedback entry for an insight.

stitch api workspaces/{workspace}/insights/{insight}/feedback/{feedback}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. Resource name of the feedback item. Format: workspaces/{workspace}/insights/{insight}/feedback/{feedback} Supports the virtual resource alias like (per AIP-122) to operate directly on the authenticated caller’s like without pre-fetching its ID.

---

workspaces.insights.feedback.list

Lists feedback entries on an insight.

stitch api workspaces/{workspace}/insights/{insight}/feedback

Parameters

Name	In	Type	Description
pageSize	query	integer	Optional. The maximum number of feedback items to return.
pageToken	query	string	Optional. A page token, received from a previous ListInsightFeedbacks call.
parent (required)	path	string	Required. The parent insight to list feedback for. Format: workspaces/{workspace}/insights/{insight}

---

workspaces.insights.feedback.patch

Updates an existing insight feedback submission.

stitch api -X PATCH workspaces/{workspace}/insights/{insight}/feedback/{feedback}

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. The full resource name of the feedback item. Format: workspaces/{workspace}/insights/{insight}/feedback/{feedback}
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.insights.insightUpdates.getInvestigationReport

Gets an investigation report for an insight or a specific insight update. If requested for an insight (workspaces/{workspace}/insights/{insight}/investigationReport), returns the latest investigation report (corresponding to the most recent insight update). If requested for a specific insight update (workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport), returns the investigation report at that update.

stitch api workspaces/{workspace}/insights/{insight}/insightUpdates/{insightUpdate}/investigationReport

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the investigation report. Format: - workspaces/{workspace}/insights/{insight}/investigationReport to retrieve the latest investigation report for the insight (corresponding ## to the most recent insight update). workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport to retrieve the investigation report for a specific insight update.

---

workspaces.insights.insightUpdates.list

Lists updates for an insight.

stitch api workspaces/{workspace}/insights/{insight}/insightUpdates

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression to filter insight updates. Supported fields: substantive, source, create_time, description.
orderBy	query	string	Optional. The field to sort the insight updates by. Supported syntax follows AIP-132 (e.g., create_time, create_time desc). Supported fields: create_time. If empty, defaults to create_time desc.
pageSize	query	integer	Optional. The maximum number of insight updates to return. The service may return fewer than this value. If unspecified, at most 20 insight updates will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken	query	string	Optional. A page token, received from a previous ListInsightUpdates call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent insight to list updates for. Format: workspaces/{workspace}/insights/{insight}.
readMask	query	string	Optional. Optional. Mask specifying which fields to read. The wildcard * is not supported.

---

workspaces.marketRadarCheckpoint.generate

Triggers background generation of a market radar checkpoint.

stitch api -X POST workspaces/{workspace}/marketRadarCheckpoint/generate

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to trigger market radar generation for. Format: workspaces/{workspace}

---

workspaces.productMd.generate

Launches the ProductMd agent for a workspace.

stitch api -X POST workspaces/{workspace}/productMd:generate

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The resource name of the workspace to generate ProductMd for. Format: workspaces/{workspace}

---

workspaces.productMd.getStatus

Polls for intermediate status updates from a running ProductMd agent.

stitch api workspaces/{workspace}/productMd:getStatus

Parameters

Name	In	Type	Description
agencySessionId	query	string	Optional. Deprecated: use execution_id instead. The agency session ID returned by GenerateProductMd.
continuationToken	query	string	Optional. Continuation token from a previous GetProductMdStatus response.
executionId	query	string	Optional. The execution ID returned by GenerateProductMd.
parent (required)	path	string	Required. The resource name of the workspace. Format: workspaces/{workspace}

---

workspaces.skills.create

Creates a skill in the workspace.

stitch api -X POST workspaces/{workspace}/skills

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to create the skill in. Format: workspaces/{workspace}.
skillId	query	string	Optional. The ID to use for the skill, which will become the final component of the skill’s resource name (workspaces/{workspace}/skills/{skill_id}). The server does not generate IDs, so the ID must be supplied either here or via skill.name. If both are set they must agree, otherwise INVALID_ARGUMENT is returned.

---

workspaces.skills.delete

Deletes a skill in the workspace.

stitch api -X DELETE workspaces/{workspace}/skills/{skill}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The name of the skill to delete. Format: workspaces/{workspace}/skills/{skill}

---

workspaces.skills.list

Lists skills in the workspace.

stitch api workspaces/{workspace}/skills

Parameters

Name	In	Type	Description
filter	query	string	Optional. Standard filter string.
pageSize	query	integer	Optional. The maximum number of skills to return.
pageToken	query	string	Optional. The page token to use for pagination.
parent (required)	path	string	Required. The parent workspace to list skills for. Format: workspaces/{workspace}.

---

workspaces.skills.patch

Updates a skill in the workspace.

stitch api -X PATCH workspaces/{workspace}/skills/{skill}

Parameters

Name	In	Type	Description
allowMissing	query	boolean	Optional. If set to true, and the skill is not found, a new skill will be created.
name (required)	path	string	Identifier. The resource name of the skill. Format: workspaces/{workspace}/skills/{skill}
updateMask	query	string	Optional. The list of fields to update.

---

workspaces.toolProviders.delete

Deletes a tool provider configuration for the user.

stitch api -X DELETE workspaces/{workspace}/toolProviders/{toolProvider}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the tool provider to delete. Format: workspaces/{workspace}/toolProviders/{tool_provider}

---

workspaces.toolProviders.deleteAuth

Deletes all auth credentials for a tool provider.

stitch api -X DELETE workspaces/{workspace}/toolProviders/{toolProvider}:deleteAuth

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the tool provider whose auth credentials are to be deleted. Format: workspaces/{workspace}/toolProviders/{tool_provider}

---

workspaces.toolProviders.list

Lists available tool providers for a workspace.

stitch api workspaces/{workspace}/toolProviders

Parameters

Name	In	Type	Description
filter	query	string	Optional. An AIP-160 filter expression.
orderBy	query	string	Optional. The sorting order of the tool providers.
pageSize	query	integer	Optional. The maximum number of tool providers to return.
pageToken	query	string	Optional. The page token to use for pagination.
parent (required)	path	string	Required. The workspace to list tool providers for. Format: workspaces/{workspace}.

---

workspaces.toolProviders.upsert

Upserts a tool provider configuration for the user.

stitch api -X POST workspaces/{workspace}/toolProviders:upsert

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to upsert the tool provider in. Format: workspaces/{workspace}.

---

workspaces.toolProviders.upsertAuth

Replaces the full auth header set for a tool provider.

stitch api -X POST workspaces/{workspace}/toolProviders/{toolProvider}:upsertAuth

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the tool provider to update auth for. Format: workspaces/{workspace}/toolProviders/{tool_provider}

---

workspaces.users.list

Lists users in a workspace.

stitch api workspaces/{workspace}/users

Parameters

Name	In	Type	Description
filter	query	string	Optional. A CEL filter expression to filter users.
pageSize	query	integer	Optional. The maximum number of users to return.
pageToken	query	string	Optional. A page token received from a previous ListUsers call.
parent (required)	path	string	Required. Resource name of the workspace to list users for. Format: workspaces/{workspace}

---

workspaces.webhookConfigs.create

Creates a new webhook configuration in the specified workspace.

stitch api -X POST workspaces/{workspace}/webhookConfigs

Parameters

Name	In	Type	Description
parent (required)	path	string	Required. The parent workspace to create the webhook configuration in. Format: workspaces/{workspace}

---

workspaces.webhookConfigs.delete

Deletes a webhook configuration by its resource name.

stitch api -X DELETE workspaces/{workspace}/webhookConfigs/{webhookConfig}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the webhook configuration to delete. Format: workspaces/{workspace}/webhookConfigs/{webhook_config}

---

workspaces.webhookConfigs.get

Gets a single webhook configuration by its resource name.

stitch api workspaces/{workspace}/webhookConfigs/{webhookConfig}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the webhook configuration to retrieve. Format: workspaces/{workspace}/webhookConfigs/{webhook_config}

---

workspaces.webhookConfigs.list

Lists all webhook configurations for a workspace.

stitch api workspaces/{workspace}/webhookConfigs

Parameters

Name	In	Type	Description
pageSize	query	integer	Optional. The maximum number of webhook configurations to return per page. The maximum allowed value is 100.
pageToken	query	string	Optional. A page token received from a previous ListWebhookConfigs call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace to list webhook configurations for. Format: workspaces/{workspace}

---

workspaces.webhookConfigs.patch

Updates an existing webhook configuration. Only fields specified in the update mask are modified.

stitch api -X PATCH workspaces/{workspace}/webhookConfigs/{webhookConfig}

Parameters

Name	In	Type	Description
name (required)	path	string	Identifier. Resource name of the webhook configuration. Format: workspaces/{workspace}/webhookConfigs/{webhook_config}
updateMask	query	string	Optional. The list of fields to update. If not set, all mutable fields are updated.

---

workspaces.webhookConfigs.verify

Verifies a webhook endpoint by sending a challenge request and confirming the endpoint echoes it back correctly.

stitch api -X PATCH workspaces/{workspace}/webhookConfigs/{webhookConfig}/verify

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the webhook configuration to verify. Format: workspaces/{workspace}/webhookConfigs/{webhook_config}

---

workspaces.webhookEvents.get

Gets a single webhook event by its resource name.

stitch api workspaces/{workspace}/webhookEvents/{webhookEvent}

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the webhook event to retrieve. Format: workspaces/{workspace}/webhookEvents/{webhook_event}

---

workspaces.webhookEvents.list

Lists all webhook events for a workspace.

stitch api workspaces/{workspace}/webhookEvents

Parameters

Name	In	Type	Description
filter	query	string	Optional. A filter expression that filters webhook events returned in the response. Filtering is supported for ‘delivery_state’ and ‘event_type’.
pageSize	query	integer	Optional. The maximum number of webhook events to return per page. The maximum allowed value is 100.
pageToken	query	string	Optional. A page token received from a previous ListWebhookEvents call. Provide this to retrieve the subsequent page.
parent (required)	path	string	Required. The parent workspace to list webhook events for. Format: workspaces/{workspace}

---

workspaces.webhookEvents.send

Delivers a webhook event payload to its configured endpoints. This can be used to manually redeliver an event.

stitch api -X POST workspaces/{workspace}/webhookEvents/{webhookEvent}:send

Parameters

Name	In	Type	Description
name (required)	path	string	Required. The resource name of the webhook event to send. Format: workspaces/{workspace}/webhookEvents/{webhook_event}