package pipeline.v1beta
Get desktop application:
View/edit binary Protocol Buffers messages
PipelinePrivateService defines private methods to interact with Pipeline resources.
List pipeline releases (admin only) This *private* method allows admin users to list *all* pipeline releases.
message
pipeline.proto:928ListPipelinesReleaseAdminRequest represents a request by an admin to list all pipeline releases. Admin users have access to pipelines from any user.
optional int32 page_size = 1
The maximum number of releases to return. If this parameter is unspecified, at most 10 releases will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional Pipeline.View view = 3
View allows clients to specify the desired pipeline view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
optional bool show_deleted = 5
Include soft-deleted pipelines in the result.
message
pipeline.proto:949ListPipelineReleasesAdminResponse contains a list of pipeline releases requested by an admin user. For the moment, the pipeline recipes will be UID-based (permalink) instead of name-based. This is a temporary solution.
repeated releases = 1
A list of pipeline releases.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipeline releases.
List pipelines (admin only) This *private* method allows internal clients to list *all* pipeline resources.
message
pipeline.proto:894ListPipelinesAdminRequest represents a request by an admin to list all the pipelines. Admin users have access to pipelines from any user.
optional int32 page_size = 1
The maximum number of pipelines to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional Pipeline.View view = 3
View allows clients to specify the desired pipeline view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`. - Example: `recipe.components.definition_name:"operator-definitions/2ac8be70-0f7a-4b61-a33d-098b8acfa6f3"`.
optional bool show_deleted = 5
Include soft-deleted pipelines in the result.
message
pipeline.proto:917ListPipelinesAdminResponse contains a list of pipelines requested by an admin user. For the moment, the pipeline recipes will be UID-based (permalink) instead of name-based. This is a temporary solution.
repeated pipelines = 1
A list of pipeline resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipelines.
Get a connection by UID (admin only) This *private* method allows internal clients to access any connection resource by UID.
message
integration.proto:365LookUpConnectionAdminRequest represents a request to fetch the details of a connection by permalink.
string permalink = 1
The permalink of the connection, which allows its access by UID. - Format: `connections/{connection.uid}`.
optional View view = 2
View allows clients to specify the desired view in the response. It defaults to `VIEW_BASIC`.
message
integration.proto:375LookUpConnectionAdminResponse contains the requested connection.
optional connection = 1
The requested connection.
Get a pipeline by UID (admin only) This *private* method allows internal clients to access any pipeline resource by UID.
message
pipeline.proto:960LookUpPipelineAdminRequest represents a request by an admin to query a pipeline by its UID.
string permalink = 1
The permalink of the pipeline, which allows its access by UID. - Format: `pipelines/{pipeline.uid}`.
optional Pipeline.View view = 2
View allows clients to specify the desired pipeline view in the response.
message
pipeline.proto:975LookUpPipelineAdminResponse contains the requested pipeline.
optional pipeline = 1
The requested pipeline.
Pipeline PipelinePublicService exposes the public endpoints that allow clients to manage pipelines.
Clone a pipeline Clones a pipeline owned by a namespace. The new pipeline may have a different parent, and this can be either a namespace or an organization.
message
pipeline.proto:506ClonePipelineRequest represents a request to clone a pipeline owned by a user.
string name = 1
The resource name of the source pipeline to clone. Format: namespaces/{namespace}/pipelines/{pipeline}
string target = 2
The resource name of the target pipeline. Format: namespaces/{namespace}/pipelines/{pipeline}
string description = 3
Pipeline description.
optional sharing = 4
Pipeline sharing information.
message
pipeline.proto:528ClonePipelineResponse contains a cloned pipeline.
(message has no fields)
Clone a pipeline release Clones a pipeline release owned by a namespace. The new pipeline may have a different parent, and this can be either a namespace or an organization.
message
pipeline.proto:532ClonePipelineReleaseRequest represents a request to clone a pipeline release owned by a user.
string name = 1
The resource name of the pipeline release to clone. Format: namespaces/{namespace}/pipelines/{pipeline}/releases/{release}
string description = 2
Pipeline description.
optional sharing = 3
Pipeline sharing information.
string target = 4
The target pipeline resource name. Format: namespaces/{namespace}/pipelines/{pipeline}
message
pipeline.proto:553ClonePipelineReleaseResponse contains a cloned pipeline.
(message has no fields)
Create a connection Creates a connection under the ownership of a namespace.
message
integration.proto:176CreateNamespaceConnectionRequest represents a request to create a connection. Follows AIP-133: https://google.aip.dev/133
string parent = 1
The parent resource name. Format: `namespaces/{namespace}`
optional connection = 2
Properties of the connection to be created.
message
integration.proto:185CreateNamespaceConnectionResponse contains the created connection.
optional connection = 1
The created connection.
Create a secret Creates a new secret under the parenthood of an namespace.
message
secret.proto:60CreateNamespaceSecretRequest represents a request to create a secret. Follows AIP-133: https://google.aip.dev/133
string parent = 1
The parent resource name. Format: `namespaces/{namespace}`
optional secret = 2
The properties of the secret to be created.
message
secret.proto:69CreateNamespaceSecretResponse contains the created secret.
optional secret = 1
The created secret resource.
Create a new pipeline Creates a new pipeline under a namespace.
message
pipeline.proto:402CreatePipelineRequest represents a request from a namespace to create a pipeline. Follows AIP-133: https://google.aip.dev/133
string parent = 1
The parent resource name. Format: `namespaces/{namespace}`
optional pipeline = 2
The properties of the pipeline to be created.
message
pipeline.proto:411CreatePipelineResponse contains the created pipeline.
optional pipeline = 1
The created pipeline resource.
Create a pipeline release Commits the version of a pipeline, identified by its resource name, which is formed by the parent namespace and ID of the pipeline. The authenticated namespace must be the parent of the pipeline in order to perform this action.
message
pipeline.proto:693CreatePipelineReleaseRequest represents a request to release a version in a user-owned pipeline. Follows AIP-133: https://google.aip.dev/133
string parent = 1
The parent resource name (pipeline). Format: `namespaces/{namespace}/pipelines/{pipeline}`
optional release = 2
The release information.
message
pipeline.proto:703CreatePipelineReleaseResponse contains the created release.
optional release = 1
The created pipeline release object.
Delete a connection Deletes a connection.
message
integration.proto:216DeleteNamespaceConnectionRequest represents a request to delete a connection. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the connection to delete. Format: `namespaces/{namespace}/connections/{connection}`
message
integration.proto:223DeleteNamespaceConnectionResponse is an empty response.
(message has no fields)
Delete a secret Deletes a secret, accesing it by its resource name, which is defined by the parent namespace and the ID of the secret.
message
secret.proto:133DeleteNamespaceSecretRequest represents a request to delete a secret resource. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the secret to delete. Format: `namespaces/{namespace}/secrets/{secret}`
message
secret.proto:140DeleteNamespaceSecretResponse is an empty response.
(message has no fields)
Delete a pipeline Deletes a pipeline, accesing it by its resource name, which is defined by the parent namespace and the ID of the pipeline. The authenticated namespace must be the parent of the pipeline in order to delete it.
message
pipeline.proto:456DeletePipelineRequest represents a request to delete a pipeline owned by a namespace. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the pipeline to delete. Format: `namespaces/{namespace}/pipelines/{pipeline}`
message
pipeline.proto:463DeletePipelineResponse is an empty response.
(message has no fields)
Delete a pipeline release Deletes a pipeline release, where the pipeline is identified by its resource name, formed by its parent namespace and ID. The authenticated namespace must be the parent of the pipeline in order to perform this action.
message
pipeline.proto:784DeletePipelineReleaseRequest represents a request to delete a release in a user-owned pipeline. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the release to delete. Format: `namespaces/{namespace}/pipelines/{pipeline}/releases/{release}`
message
pipeline.proto:791DeletePipelineReleaseResponse is an empty response.
(message has no fields)
Dispatch Pipeline Webhook Event Handles webhook events by routing them to the appropriate pipeline based on the webhook type and message. The webhook type determines which component processes the event, while the message payload contains data that triggers pipeline execution. The pipeline processes the event using configured handlers and returns a response to the webhook sender.
message
pipeline.proto:604DispatchPipelineWebhookEventRequest represents a request to dispatch webhook events for a pipeline. The request contains the webhook type and event message that will be processed by the event router and dispatched to the appropriate pipeline based on the webhook type and message. The event message contains the payload data that will be used to trigger pipeline execution.
string webhook_type = 1
Webhook Type
optional message = 2
Event
message
pipeline.proto:614DispatchPipelineWebhookEventResponse represents a response to dispatch webhook events for a pipeline. The response contains the response message that will be sent back to the webhook sender.
optional response = 1
Response
Get hub status Return the stats of the hub
message
pipeline.proto:252GetHubStatsRequest represents a request to get hub stats.
(message has no fields)
message
pipeline.proto:255GetHubStatsResponse represents a response to get hub stats.
int32 number_of_public_pipelines = 1
Total number of public pipelines.
int32 number_of_featured_pipelines = 2
Total number of featured pipelines.
Get an integration Returns the details of an integration.
message
integration.proto:350GetIntegrationRequest represents a request to view the details of an integration.
string integration_id = 1
Integration ID.
optional View view = 2
View allows clients to specify the desired view in the response.
message
integration.proto:358GetIntegrationResponse contains the requested integration.
optional integration = 1
The requested integration.
Get a namespace connection Returns the details of a connection.
message
integration.proto:159GetNamespaceConnectionRequest represents a request to view the details of a connection. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the connection. Format: `namespaces/{namespace}/connections/{connection}`
optional View view = 2
View allows clients to specify the desired view in the response.
message
integration.proto:168GetNamespaceConnectionResponse contains the requested connection.
optional connection = 1
The requested connection.
Get a secret Returns the details of an namespace-owned secret by its resource name, which is defined by the parent namespace and the ID of the secret.
message
secret.proto:100GetNamespaceSecretRequest represents a request to fetch the details of a secret. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the secret. Format: `namespaces/{namespace}/secrets/{secret}`
message
secret.proto:107GetNamespaceSecretResponse contains the requested secret.
optional secret = 1
The secret resource.
Get the details of a long-running operation This method allows requesters to request the status and outcome of long-running operations such as asynchronous pipeline triggers.
message
pipeline.proto:878GetOperationRequest represents a request to query a long-running operation.
string operation_id = 1
The name of the operation resource. Asynchronous methods will contain this information in their response.
message
pipeline.proto:885GetOperationResponse contains the long-running operation details.
optional operation = 1
The long-running operation.
Get a pipeline Returns the details of a pipeline.
message
pipeline.proto:419GetPipelineRequest represents a request to fetch the details of a pipeline owned by a namespace. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the pipeline. Format: `namespaces/{namespace}/pipelines/{pipeline}`
optional Pipeline.View view = 2
View allows clients to specify the desired pipeline view in the response.
message
pipeline.proto:428GetPipelineResponse contains the requested pipeline.
optional pipeline = 1
The pipeline resource.
Get a pipeline release Gets the details of a pipeline release, where the pipeline is identified by its resource name, formed by its parent namespace and ID.
message
pipeline.proto:745GetPipelineReleaseRequest represents a request to fetch the details of a release in a user-owned pipeline. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the release. Format: `namespaces/{namespace}/pipelines/{pipeline}/releases/{release}`
optional Pipeline.View view = 2
View allows clients to specify the desired pipeline view in the response.
message
pipeline.proto:755GetPipelineReleaseResponse contains the requested pipeline release.
optional release = 1
The pipeline release resource.
List component definitions Returns a paginated list of component definitions, regardless their type. This offers a single source of truth, with pagination and filter capabilities, for the components that might be used in a pipeline.
message
component_definition.proto:163ListComponentDefinitionsRequest represents a request to list component definitions.
optional int32 page_size = 1
The maximum number of component definitions to return. If this parameter is unspecified, at most 10 definitions will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional ComponentDefinition.View view = 3
View allows clients to specify the desired resource view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `component_type="COMPONENT_TYPE_AI"`. - Example: `tasks:"TASK_TEXT_GENERATION"`.
optional int32 page = 5
Page number.
message
component_definition.proto:186ListComponentDefinitionsResponse contains a list of component definitions.
repeated component_definitions = 1
A list of component definition resources.
int32 total_size = 3
Total number of component definitions.
int32 page_size = 4
The requested page size.
int32 page = 5
The requested page offset.
List Component Runs Returns the information of each component execution within a pipeline run.
message
pipeline.proto:1067ListComponentRunsRequest is the request message for ListComponentRuns.
string parent = 1
The parent pipeline run resource name. Format: namespaces/{namespace}/pipelines/{pipeline}/runs/{run}
optional int32 page = 2
The page number to retrieve.
optional int32 page_size = 3
The maximum number of items per page to return. The default and cap values are 10 and 100, respectively.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
optional string order_by = 5
Order by field, with options for ordering by `id`, `create_time` or `update_time`. Format: `order_by=id` or `order_by=create_time desc`, default is `asc`.
optional Pipeline.View view = 6
View allows clients to specify the desired run view in the response. The basic view excludes input / output data.
message
pipeline.proto:1095ListComponentRunsResponse is the response message for ListComponentRuns.
repeated component_runs = 1
The list of component runs.
int32 total_size = 2
The total number of component runs matching the request.
int32 page = 3
The current page number.
int32 page_size = 4
The number of items per page.
List integrations Returns a paginated list of available integrations.
message
integration.proto:323ListIntegrationsRequest represents a request to list the available integrations.
optional int32 page_size = 1
The maximum number of items to return. The default and cap values are 10 and 100, respectively.
optional string page_token = 2
Page token. By default, the first page will be returned.
optional string filter = 3
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. The following filters are supported: - `qIntegration` (fuzzy search on title or vendor) **Examples**: - List integrations where app name or vendor match `googl`: `q="googl"`.
message
integration.proto:339ListIntegrationsResponse contains a paginated list of integrations.
repeated integrations = 1
A list of integrations matching the request parameters.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of items.
List namespace connections Returns a paginated list of connections created by a namespace.
message
integration.proto:123ListNamespaceConnectionsRequest represents a request to list the connections created by a namespace. Follows AIP-132: https://google.aip.dev/132
string parent = 1
The parent resource name. Format: `namespaces/{namespace}`
optional int32 page_size = 2
The maximum number of items to return. The default and cap values are 10 and 100, respectively.
optional string page_token = 3
Page token. By default, the first page will be returned.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. The following filters are supported: - `integrationId` - `qConnection` (fuzzy search on connection ID, integration title or vendor) **Examples**: - List connections where app name, vendor or connection ID match `googl`: `q="googl"`. - List connections where the component type is `openai` (e.g. to setup a connector within a pipeline): `integrationId="openai"`.
message
integration.proto:147ListNamespaceConnectionsResponse contains a paginated list of connections.
repeated connections = 1
A list of connections matching the request parameters.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of items.
List secrets Returns a paginated list of secrets that belong to the specified namespace.
message
secret.proto:76ListNamespaceSecretsRequest represents a request to list the secrets of a namespace. Follows AIP-132: https://google.aip.dev/132
string parent = 1
The parent resource name. Format: `namespaces/{namespace}`
optional int32 page_size = 2
The maximum number of secrets to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 3
Page token.
message
secret.proto:89ListNamespaceSecretsResponse contains a list of secrets.
repeated secrets = 1
A list of secret resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of secret resources.
List pipelines that reference a connection Returns a paginated list with the IDs of the pipelines that reference a given connection. All the pipelines will belong to the same namespace as the connection.
message
integration.proto:294ListPipelineIDsByConnectionIDRequest represents a request to list the pipelines that reference a connection.
string namespace_id = 1
Namespace ID.
string connection_id = 2
Connection ID.
optional int32 page_size = 3
The maximum number of items to return. The default and cap values are 10 and 100, respectively.
optional string page_token = 4
Page token. By default, the first page will be returned.
optional string filter = 5
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. The following filters are supported: - `q` (fuzzy search on pipeline ID)
message
integration.proto:312ListPipelineIDsByConnectionIDResponse contains a paginated list of integrations.
repeated string pipeline_ids = 1
A list of pipeline IDs matching the request parameters.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of items.
List the releases in a pipeline Lists the commited versions of a pipeline, identified by its resource name, which is formed by the parent namespace and ID of the pipeline.
message
pipeline.proto:711ListPipelineReleasesRequest represents a request to list the releases in a user-owned pipeline. Follows AIP-132: https://google.aip.dev/132
string parent = 1
The parent resource name (pipeline). Format: `namespaces/{namespace}/pipelines/{pipeline}`
optional int32 page_size = 2
The maximum number of releases to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 3
Page token.
optional Pipeline.View view = 4
View allows clients to specify the desired pipeline view in the response.
optional string filter = 5
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
optional bool show_deleted = 6
Include soft-deleted pipelines in the result.
message
pipeline.proto:733ListPipelineReleasesResponse contains a list of pipeline releases.
repeated releases = 1
A list of pipeline release resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipeline releases.
List Pipeline Runs Returns a paginated list of runs for a given pipeline. When the requester is the owner of the pipeline, they will be able to all the pipeline runs, regardless who requested the trigger (the view will be partial to hide sensitive data like e.g. the trigger input and output). Other requesters will only be able to see the runs requested by themselves.
message
pipeline.proto:981ListPipelineRunsRequest is the request message for ListPipelineRuns.
string parent = 1
The parent pipeline resource name. Format: namespaces/{namespace}/pipelines/{pipeline}
int32 page = 2
The page number to retrieve.
int32 page_size = 3
The maximum number of items per page to return. The default and cap values are 10 and 100, respectively.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
optional string order_by = 5
Order by field, with options for ordering by `id`, `create_time` or `update_time`. Format: `order_by=id` or `order_by=create_time desc`, default is `asc`.
message
pipeline.proto:1037ListPipelineRunsResponse is the response message for ListPipelineRuns.
repeated pipeline_runs = 1
The list of pipeline runs.
int32 total_size = 2
The total number of pipeline runs matching the request.
int32 page = 3
The current page number.
int32 page_size = 4
The number of items per page.
List Pipeline Runs By Requester Returns a paginated list of runs for requested by a namespace. The response may contain runs from several pipelines.
message
pipeline.proto:1005ListPipelineRunsByRequesterRequest is the request message for ListPipelineRunsByRequester.
string requester = 1
Requester namespace resource name. Format: namespaces/{namespace}
int32 page = 2
The page number to retrieve.
int32 page_size = 3
The maximum number of items per page to return. The default and cap values are 10 and 100, respectively.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. The following filters are supported: - `status` - `source` **Example**: `status="RUN_STATUS_COMPLETED"`.
optional string order_by = 5
Order by field, with options for ordering by `id`, `create_time` or `update_time`. Format: `order_by=id` or `order_by=create_time desc`, default is `asc`.
optional start = 6
Beginning of the time range from which the records will be fetched. The default value is the beginning of the current day, in UTC.
optional stop = 7
End of the time range from which the records will be fetched. The default value is the current timestamp.
message
pipeline.proto:1052ListPipelineRunsByRequesterResponse is the response message for ListPipelineRunsByRequester.
repeated pipeline_runs = 1
The list of pipeline runs.
int32 total_size = 2
The total number of pipeline runs matching the request.
int32 page = 3
The current page number.
int32 page_size = 4
The number of items per page.
List namespace pipelines Returns a paginated list of pipelines of a namespace
message
pipeline.proto:347ListPipelinesRequest represents a request to list pipelines. Follows AIP-132: https://google.aip.dev/132
string parent = 1
The parent resource name. Format: `namespaces/{namespace}`
optional int32 page_size = 2
The maximum number of pipelines to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 3
Page token.
optional Pipeline.View view = 4
View allows clients to specify the desired pipeline view in the response.
optional string filter = 5
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`. - Example: `recipe.components.definition_name:"operator-definitions/2ac8be70-0f7a-4b61-a33d-098b8acfa6f3"`.
optional bool show_deleted = 6
Include soft-deleted pipelines in the result.
optional Pipeline.Visibility visibility = 7
Limit results to pipelines with the specified visibility.
optional string order_by = 8
Order by field, with options for ordering by `id`, `create_time` or `update_time`. Format: `order_by=id` or `order_by=create_time desc`, default is `asc`.
message
pipeline.proto:375ListPipelinesResponse contains a list of pipelines.
repeated pipelines = 1
A list of pipeline resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipelines.
List accessible pipelines Returns a paginated list of pipelines that are visible to the requester.
message
pipeline.proto:311ListPublicPipelinesRequest represents a request to list public pipelines.
optional int32 page_size = 1
The maximum number of pipelines to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional Pipeline.View view = 3
View allows clients to specify the desired pipeline view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`. - Example: `recipe.components.definition_name:"operator-definitions/2ac8be70-0f7a-4b61-a33d-098b8acfa6f3"`.
optional bool show_deleted = 5
Include soft-deleted pipelines in the result.
optional Pipeline.Visibility visibility = 6
Limit results to pipelines with the specified visibility.
optional string order_by = 7
Order by field, with options for ordering by `id`, `create_time` or `update_time`. Format: `order_by=id` or `order_by=create_time desc`, default is `asc`.
message
pipeline.proto:336ListPublicPipelinesResponse contains a list of public pipelines.
repeated pipelines = 1
A list of pipeline resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipelines.
Check if the pipeline server is alive See https://github.com/grpc/grpc/blob/master/doc/health-checking.md.
message
pipeline.proto:24LivenessRequest represents a request to check a service liveness status
optional health_check_request = 1
HealthCheckRequest message
message
pipeline.proto:30LivenessResponse represents a response for a service liveness status
optional health_check_response = 1
HealthCheckResponse message
Get a pipeline by UID Returns the details of a pipeline by a permalink defined by the resource UID.
message
pipeline.proto:385LookUpPipelineRequest represents a request to query a pipeline by its UID.
string permalink = 1
The permalink of the pipeline, which allows its access by UID. - Format: `pipelines/{pipeline.uid}`.
optional Pipeline.View view = 2
View allows clients to specify the desired pipeline view in the response.
message
pipeline.proto:394LookUpPipelineResponse contains the requested pipeline.
optional pipeline = 1
The requested pipeline.
Check if the pipeline server is ready See https://github.com/grpc/grpc/blob/master/doc/health-checking.md
message
pipeline.proto:36ReadinessRequest represents a request to check a service readiness status
optional health_check_request = 1
HealthCheckRequest message
message
pipeline.proto:42ReadinessResponse represents a response for a service readiness status
optional health_check_response = 1
HealthCheckResponse message
Rename a pipeline Updates the ID of a pipeline. Since this is an output-only field, a custom method is required to modify it. The pipeline name will be updated accordingly, as it is composed by the parent namespace and ID of the pipeline (e.g. `namespaces/luigi/pipelines/pizza-recipe-generator`). The authenticated namespace must be the parent of the pipeline in order to perform this action.
message
pipeline.proto:486RenamePipelineRequest represents a request to rename the name of a pipeline owned by a namespace.
string name = 1
The resource name of the pipeline to rename. Format: namespaces/{namespace}/pipelines/{pipeline}
string new_pipeline_id = 2
The new resource ID. This will transform the resource name into `namespaces/{namespace}/pipelines/{new_pipeline_id}`.
message
pipeline.proto:499RenamePipelineResponse contains a renamed pipeline.
optional pipeline = 1
The renamed pipeline resource.
Test a connection Makes a request to the 3rd party app that the connection is configured to communicate with, and checks the result of the call. If the test fails, the response status and error message will provide more information about the failure. Note that this action might affect the quota or billing of the integrated account in the 3rd party app.
message
integration.proto:226TestNamespaceConnectionRequest represents a request to test a connection.
string name = 1
The resource name of the connection to test. Format: `namespaces/{namespace}/connections/{connection}`
message
integration.proto:233TestNamespaceConnectionResponse is an empty response.
(message has no fields)
Trigger a pipeline asynchronously Triggers the execution of a pipeline asynchronously, i.e., the result contains the necessary information to access the result and status of the operation. This method is intended for cases that require long-running workloads. The pipeline is identified by its resource name, formed by the parent namespace and ID of the pipeline. For more information, see [Run Pipeline](https://instill-ai.dev/docs/pipeline/run-pipeline).
message
pipeline.proto:669TriggerPipelineRequest represents a request to trigger a user-owned pipeline synchronously.
string name = 1
The resource name of the pipeline to trigger. Format: namespaces/{namespace}/pipelines/{pipeline}
repeated inputs = 2
Pipeline input parameters, it will be deprecated soon.
repeated data = 3
Data
message
pipeline.proto:685TriggerAsyncPipelineResponse contains the information to access the status of an asynchronous pipeline execution.
optional operation = 1
Long-running operation information.
Trigger a pipeline release asynchronously Triggers the asynchronous execution of of a pipeline. While the trigger endpoint (where the release version isn't specified) triggers the pipeline at its latest release, this method allows the client to specified any committed release. The pipeline is identified by its resource name, formed by its parent namespace and ID.
message
pipeline.proto:820TriggerPipelineReleaseRequest represents a request to trigger a pinned release of a user-owned pipeline asynchronously.
string name = 1
The resource name of the pipeline release to trigger. Format: namespaces/{namespace}/pipelines/{pipeline}/releases/{release}
repeated inputs = 2
Pipeline input parameters, it will be deprecated soon.
repeated data = 3
Data
message
pipeline.proto:837TriggerAsyncPipelineReleaseResponse contains the information to access the status of an asynchronous pipeline execution.
optional operation = 1
Long-running operation information.
Trigger a pipeline Triggers the execution of a pipeline synchronously, i.e., the result is sent back to the namespace right after the data is processed. This method is intended for real-time inference when low latency is of concern. The pipeline is identified by its resource name, formed by the parent namespace and ID of the pipeline. For more information, see [Run Pipeline](https://instill-ai.dev/docs/pipeline/run-pipeline).
message
pipeline.proto:621TriggerPipelineRequest represents a request to trigger a user-owned pipeline synchronously.
string name = 1
The resource name of the pipeline to trigger. Format: namespaces/{namespace}/pipelines/{pipeline}
repeated inputs = 2
Pipeline input parameters, it will be deprecated soon.
repeated data = 3
Data
message
pipeline.proto:636TriggerPipelineResponse contains the pipeline execution results, i.e., the multiple model inference outputs.
repeated outputs = 1
Model inference outputs.
optional metadata = 2
Traces of the pipeline inference.
Trigger a pipeline release Triggers the synchronous execution of of a pipeline. While the trigger endpoint (where the release version isn't specified) triggers the pipeline at its latest release, this method allows the client to specified any committed release. The pipeline is identified by its resource name, formed by its parent namespace and ID.
message
pipeline.proto:795TriggerPipelineReleaseRequest represents a request to trigger a pinned release of a user-owned pipeline.
string name = 1
The resource name of the pipeline release to trigger. Format: namespaces/{namespace}/pipelines/{pipeline}/releases/{release}
repeated inputs = 2
Pipeline input parameters, it will be deprecated soon.
repeated data = 3
Data
message
pipeline.proto:811TriggerPipelineReleaseResponse contains the pipeline execution results, i.e., the multiple model inference outputs.
repeated outputs = 1
Model inference outputs.
optional metadata = 2
Traces of the pipeline inference.
rpc TriggerPipelineWithStream (, stream )
pipeline_public_service.proto:294Trigger a pipeline via streaming Triggers the execution of a pipeline asynchronously and streams back the response. This method is intended for real-time inference when low latency is of concern and the response needs to be processed incrementally. The pipeline is identified by its resource name, formed by the parent namespace and ID of the pipeline.
message
pipeline.proto:645TriggerPipelineWithStreamRequest represents a request to trigger a user-owned pipeline synchronously and streams back the results.
string name = 1
The resource name of the pipeline to trigger. Format: namespaces/{namespace}/pipelines/{pipeline}
repeated inputs = 2
Pipeline input parameters, it will be deprecated soon.
repeated data = 3
Data
message
pipeline.proto:660TriggerPipelineWithStreamResponse contains the pipeline execution results, i.e., the multiple model inference outputs.
repeated outputs = 1
Model inference outputs.
optional metadata = 2
Traces of the pipeline inference.
Update a connection Updates a connection with the supplied connection fields.
message
integration.proto:193UpdateNamespaceConnectionRequest represents a request to update a connection. Follows AIP-134: https://google.aip.dev/134
optional connection = 1
Connection object with the new properties to be updated. The connection's `name` field identifies the resource. Format: `namespaces/{namespace}/connections/{connection}` Immutable and output-only fields will be ignored. The Setup property must be updated in block (no partial update is supported).
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
integration.proto:208UpdateNamespaceConnectionResponse contains the updated connection.
optional connection = 1
The created connection.
Update a secret Udpates a secret, accessing it by its resource name, which is defined by In REST requests, only the supplied secret fields will be taken into account when updating the resource.
message
secret.proto:114UpdateNamespaceSecretRequest represents a request to update a namespace secret. Follows AIP-134: https://google.aip.dev/134
optional secret = 1
The secret resource to update. The secret's `name` field identifies the resource. Format: `namespaces/{namespace}/secrets/{secret}`
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
secret.proto:126UpdateNamespaceSecretResponse contains the updated secret.
optional secret = 1
The updated secret resource.
Update a pipeline Udpates a pipeline, accessing it by its resource name, which is defined by the parent namespace and the ID of the pipeline. The authenticated namespace must be the parent of the pipeline in order to modify it. In REST requests, only the supplied pipeline fields will be taken into account when updating the resource.
message
pipeline.proto:436UpdatePipelineRequest represents a request to update a pipeline owned by a namespace. Follows AIP-134: https://google.aip.dev/134
optional pipeline = 1
The pipeline resource to update. The pipeline's `name` field identifies the resource. Format: `namespaces/{namespace}/pipelines/{pipeline}`
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
pipeline.proto:448UpdatePipelineResponse contains the updated pipeline.
optional pipeline = 1
The updated pipeline resource.
Update a pipeline release Updates the details of a pipeline release, where the pipeline is identified by its resource name, formed by its parent namespace and ID. The authenticated namespace must be the parent of the pipeline in order to perform this action.
message
pipeline.proto:763UpdatePipelineReleaseRequest represents a request to update a user-owned pipeline release. Follows AIP-134: https://google.aip.dev/134
optional release = 1
The pipeline release resource to update. The release's `name` field identifies the resource. Format: `namespaces/{namespace}/pipelines/{pipeline}/releases/{release}`
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
pipeline.proto:776UpdatePipelineReleaseResponse contains the updated pipeline release.
optional release = 1
The updated pipeline release resource.
Validate a pipeline Validates a pipeline by its resource name, which is defined by the parent namespace and the ID of the pipeline. Validation checks the recipe of the pipeline and the status of its components.
message
pipeline.proto:467ValidatePipelineRequest represents a request to validate a pipeline owned by a user.
string name = 1
The resource name of the pipeline to validate. Format: namespaces/{namespace}/pipelines/{pipeline}
message
pipeline.proto:477ValidatePipelineResponse contains a validated pipeline.
bool success = 1
Success
repeated errors = 2
The validated pipeline resource.
message
component_definition.proto:17ComponentDefinition describes a certain type of Component.
Used in:
string name = 1
The name of the component definition, defined by its ID. - Format: `component-definitions/{id}`
string uid = 2
Component definition UUID.
string id = 3
Component definition resource ID (used in `name` as the last segment). This conforms to RFC-1034, which restricts to letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
string title = 4
Component definition title.
string documentation_url = 5
Component definition documentation URL.
string icon = 6
Component definition icon. This is a path that's relative to the root of the component implementation (see `source_url`) and that allows frontend applications to pull and locate the icons.
optional spec = 7
Component definition specification.
ComponentType type = 8
Component definition type.
bool tombstone = 9
Component definition tombstone. If true, this configuration is permanently off. Otherwise, the configuration is active.
bool public = 10
The public flag determines whether this connector definition is available to all workspaces.
bool custom = 11
Component definition custom flag, i.e., whether this is a custom component definition.
string vendor = 12
Component definition vendor name.
optional vendor_attributes = 13
Vendor-specific attributes.
string source_url = 14
Source code URL. This points to the source code where the component is implemented.
string version = 15
Component definition version. This is a string that fulfills the SemVer specification (e.g. `1.0.0-beta`).
repeated tasks = 16
List of tasks that can be executed by the component.
string description = 17
Short description of the component.
ComponentDefinition.ReleaseStage release_stage = 18
Release stage.
repeated events = 19
List of events that can be produced by the component.
ReleaseStage defines the release stage of a component. This is used to group components with the same pre-relase groups (e.g. `0.1.0-beta`, `0.1.0-beta.1` -> `RELEASE_STAGE_BETA`) and to include other "in progress" (i.e. coming soon, open for contributions) stages that may not be relevant within semantic versioning. See the documentation of each value for potential constraints between `version` and `release_stage` fields.`
Used in:
RELEASE_STAGE_UNSPECIFIED = 0
Unspecified.
RELEASE_STAGE_OPEN_FOR_CONTRIBUTION = 1
This component is unimplemented and community contributions are welcome for this component. It is recommended that the major and minor versions for definitions at this release stage is kept at 0, e.g., `0.0.1`, `0.0.4`, etc.
RELEASE_STAGE_COMING_SOON = 2
The implementation of this component is planned and will be tackled by the Instill AI team. It is recommended that the major and minor versions for definitions at this release stage is kept at 0, e.g., `0.0.1`, `0.0.4`, etc.
RELEASE_STAGE_ALPHA = 3
Initial implementation intended to gather feedback and issues from early adopters. Alpha releases are discouraged for production use cases. The `version` field in the definition must have `alpha` as its first pre-release identifier, e.g., `0.1.0-alpha`, `0.1.3-alpha.1`.
RELEASE_STAGE_BETA = 4
The component has reached stability and no backwards incompatible changes are expected. Before reaching general availability, it should be validated by a broader group of users. Some fixes might be added during this process. The `version` field in the definition must have `beta` as its first pre-release identifier, e.g., `0.1.0-beta`, `0.1.3-beta.1`.
RELEASE_STAGE_GA = 5
Generally available - ready for use in production and fully supported by Instill AI.
message
component_definition.proto:71Spec represents a specification data model.
Used in:
optional component_specification = 3
Component specification.
map<string, > data_specifications = 5
Data specifications. The key represents the task, and the value is the corresponding data_specification. Note: This field will be renamed to task_specifications in the future.
map<string, > event_specifications = 6
Event specifications. The key represents the event, and the value is the corresponding event_specification.
View defines how a component definition is presented.
Used in:
VIEW_UNSPECIFIED = 0
Unspecified, equivalent to BASIC.
VIEW_BASIC = 1
Default view, only includes basic information (removes the `spec` field).
VIEW_FULL = 2
Full representation.
message
common.proto:81ComponentEvent contains information about an event that a component can produce.
Used in:
string name = 1
The event name, e.g. `EVENT_NEW`.
string title = 2
Title is the event name in a human-friendly format.
string description = 3
Description contains information about the event.
message
pipeline.proto:1212ComponentRun represents the execution details of a single component within a pipeline run.
Used in:
string name = 1
The resource name of the component run. Format: namespaces/{namespace}/pipelines/{pipeline}/runs/{run}/components/{component}
string id = 2
Unique identifier for the component within the pipeline.
optional create_time = 7
Time when the component run was created.
optional update_time = 8
Time when the component run was last updated.
string pipeline_run = 9
Parent pipeline run resource name. Full resource name: namespaces/{namespace}/pipelines/{pipeline}/runs/{run}
common.run.v1alpha.RunStatus status = 10
Completion status of the component.
optional int32 total_duration = 11
Time taken to execute the component in milliseconds.
optional start_time = 12
Time when the component started execution.
optional complete_time = 13
Time when the component finished execution.
optional string error = 14
Error message if the component failed.
repeated inputs_reference = 15
Input files for the run.
repeated inputs = 16
Component input parameters.
repeated outputs_reference = 17
Output files from the run.
repeated outputs = 18
Component inference outputs.
optional float credit_amount = 19
Credits used of internal accounting metric.
optional blob_data_expiration_time = 20
Expiration time for the blob data associated with the component run.
message
common.proto:70ComponentTask contains information about a task that a component can perform.
Used in:
string name = 1
The task name, e.g. `TASK_TEXT_GENERATION`.
string title = 2
Title is the task name in a human-friendly format.
string description = 3
Description contains information about the task.
ComponentType defines the component type based on its task features.
Used in:
COMPONENT_TYPE_UNSPECIFIED = 0
Unspecified.
COMPONENT_TYPE_AI = 1
Connect with an AI model.
COMPONENT_TYPE_DATA = 2
Connect with a remote data source.
COMPONENT_TYPE_OPERATOR = 4
Manipulate data.
COMPONENT_TYPE_APPLICATION = 5
Connect with an external application.
COMPONENT_TYPE_GENERIC = 6
Generic.
message
integration.proto:20Connection contains the parameters to communicate with a 3rd party app. A component may reference a connection in their setup. One connection may be used by several components and pipelines. Field ordering follows AIP standard: name(1), id(2), display_name(3), slug(4), aliases(5), description(6)
Used in: , , , , , ,
string name = 1
Field 1: Canonical resource name. Format: `namespaces/{namespace}/connections/{connection}`.
string id = 2
Field 2: Immutable canonical resource ID (80-96 bits entropy, base62). Example: "con-8f3a2k9E7c1"
string display_name = 3
Field 3: Human-readable display name for UI.
string slug = 4
Field 4: URL-friendly slug (NO prefix). If omitted, server generates from display_name. If provided, server validates and persists it. Slug is NOT part of resource identity. Example: "my-google-drive"
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility. When display_name changes, a new slug is generated and old slugs are stored here.
string description = 6
Field 6: Optional description.
optional create_time = 7
Field 7: Creation time.
optional update_time = 8
Field 8: Last update time.
string namespace_id = 9
Field 9: ID of the namespace owning the connection.
string integration_id = 10
Field 10: Integration ID. It determines for which type of components can reference this connection.
string integration_title = 11
Field 11: Integration title. This helps the console display the results grouped by integration ID without needing an extra call to fetch title by integration ID.
Connection.Method method = 12
Field 12: Connection method. It references the setup schema provided by the integration.
optional setup = 13
Field 13: Connection details. This field is required on creation, optional on view. When viewing the connection details, the setup values will be redacted.
View view = 14
Field 14: View defines how the connection is presented. The following fields are only shown in the FULL view: - setup - scopes - oAuthAccessDetails
repeated string scopes = 15
Field 15: A list of scopes that identify the resources that the connection will be able to access on the user's behalf. This is typically passed on creation when the setup has been generated through an OAuth flow with a limited set of scopes.
optional o_auth_access_details = 16
Field 16: When the connection method is METHOD_OAUTH, the access token might come with some extra information that might vary across vendors. This information is passed as connection metadata.
optional string identity = 17
Field 17: When the connection method is METHOD_OAUTH, this field will hold the identity (e.g., email, username) with which the access token has been generated.
Method defines how the connection is set up.
Used in:
METHOD_UNSPECIFIED = 0
Unspecified.
METHOD_DICTIONARY = 1
Key-value collection. The user is responsible of fetching the connection details from the 3rd party service.
METHOD_OAUTH = 2
Access token created via OAuth 2.0 authorization.
message
component_definition.proto:136DataSpecification describes the JSON schema of component input and output. Note: This message will be renamed to TaskSpecifications in the future.
Used in: , , ,
optional input = 1
JSON schema describing the component input data.
optional output = 2
JSON schema describing the component output data.
message
pipeline.proto:60Endpoints describe the endpoints of a pipeline.
Used in: ,
map<string, > webhooks = 1
Webhook endpoints.
message
pipeline.proto:62WebhookEndpoint describe a webhook endpoint.
Used in:
string url = 1
Webhook URL.
string description = 2
Description.
message
pipeline.proto:844ErrPipelineValidation contains information about a failed pipeline validation.
Used in:
string location = 1
Location
string error = 2
error
message
component_definition.proto:144EventSpecification describes the JSON schema of component event setup and examples.
Used in:
string title = 1
Event title.
string description = 2
Event description.
optional config_schema = 3
JSON schema describing the component event config data.
optional message_schema = 4
JSON schema describing the component event message data.
repeated message_examples = 5
JSON schema describing the component event examples.
message
pipeline.proto:1110FileReference represents metadata for a file.
Used in:
string name = 1
Name of the file.
string type = 2
Format of the file (e.g., PDF, TXT, JPG).
int64 size = 3
Size of the file in bytes.
string url = 4
URL of the file (e.g., S3 URL).
message
pipeline.proto:578HandlePipelineReleaseWebhookEventRequest
string name = 1
The resource name of the pipeline release. Format: namespaces/{namespace}/pipelines/{pipeline}/releases/{release}
string event = 2
Event
string code = 3
Code
optional data = 4
Input data
message
pipeline.proto:594HandlePipelineReleaseWebhookEventResponse
optional data = 1
data
message
pipeline.proto:556HandlePipelineWebhookEventRequest
string name = 1
The resource name of the pipeline. Format: namespaces/{namespace}/pipelines/{pipeline}
string event = 2
Event
string code = 3
Code
optional data = 4
Input data
message
pipeline.proto:572HandlePipelineWebhookEventResponse
optional data = 1
data
message
integration.proto:237Integration contains the parameters to create a connection between components and 3rd party apps.
Used in: ,
string id = 1
Field 1: Identifier of the integration, which references a component definition. Components with that definition ID will be able to use the connections produced by this integration.
string title = 2
Field 2: Title, reflects the app name.
string description = 3
Field 3: Short description of the integrated app.
string vendor = 4
Field 4: Integrated app vendor name.
string icon = 5
Field 5: Integration icon. This is a path that's relative to the root of the component implementation and that allows frontend applications to pull and locate the icons. See the `icon` field in the `ComponentDefinition` entity for more information.
optional help_link = 6
Field 6: Reference to the vendor's documentation to expand the integration details.
optional setup_schema = 7
Field 7: The connection setup field definitions. Each integration will require different data to connect to the 3rd party app.
optional o_auth_config = 8
Field 8: Configuration parameters required for the OAuth setup flow. This field will be present only if the integration supports OAuth 2.0.
View view = 9
Field 9: View defines how the integration is presented. The following fields are only shown in the FULL view: - setupSchema - oAuthConfig
message
integration.proto:239Link contains the information to display an reference to an external URL.
Used in:
string text = 1
Text contains the message to display.
string url = 2
URL contains the reference the link will redirect to.
message
integration.proto:248OAuthConfig contains the configuration parameters for fetching an access token via an OAuth 2.0 flow.
Used in:
string auth_url = 1
The URL of the OAuth server to initiate the authentication and authorization process.
string access_url = 2
The URL of the OAuth server to exchange the authorization code for an access token.
repeated string scopes = 11
A list of scopes that identify the resources that the connection will be able to access on the user's behalf.
message
common.proto:59Permission defines how a pipeline can be used.
Used in:
bool can_edit = 1
Defines whether the pipeline can be modified.
bool can_trigger = 2
Defines whether the pipeline can be executed.
bool can_release = 3
Defines whether the pipeline can be released.
message
pipeline.proto:80A Pipeline is an end-to-end workflow that automates a sequence of components to process data. For more information, see [Pipeline](https://instill-ai.dev/docs/pipeline/introduction) in the official documentation. Pipeline represents a data pipeline for AI/ML workflows. Field ordering follows AIP standard: name(1), id(2), display_name(3), slug(4), aliases(5), description(6)
Used in: , , , , , , , , , ,
string name = 1
Field 1: Canonical resource name. Format: `namespaces/{namespace}/pipelines/{pipeline}`.
string id = 2
Field 2: Immutable canonical resource ID (80-96 bits entropy, base62). Example: "pip-8f3a2k9E7c1"
string display_name = 3
Field 3: Human-readable display name for UI.
string slug = 4
Field 4: URL-friendly slug (NO prefix). If omitted, server generates from display_name. Slug is NOT part of resource identity.
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility.
optional string description = 6
Field 6: Optional description.
optional create_time = 7
Field 7: Creation time.
optional update_time = 8
Field 8: Last update time.
optional recipe = 9
Recipe describes the components of a Pipeline and how they are connected.
string raw_recipe = 10
Recipe in YAML format.
Pipeline.Visibility visibility = 11
Pipeline visibility.
optional sharing = 12
Pipeline sharing information.
optional permission = 13
Permission defines how a pipeline can be used.
optional data_specification = 14
Data specifications.
repeated string tags = 15
Tags.
optional stats = 16
Statistic data.
optional metadata = 17
Metadata holds console-related data such as the pipeline builder layout.
string readme = 18
README holds the pipeline documentation.
repeated releases = 19
Releases holds the history of pipeline versions.
optional endpoints = 20
Pipeline endpoints.
optional string source_url = 21
A link to the source code of the pipeline (e.g. to a GitHub repository).
optional string documentation_url = 22
A link to any extra information.
optional string license = 23
License under which the pipeline is distributed.
optional string profile_image = 24
Pipeline profile image in base64 format.
string owner_name = 25
Resource name of the owner namespace.
optional owner = 26
Pipeline owner (User or Organization).
optional string creator_name = 27
Full resource name of the user who created this pipeline. Format: `users/{user}`
optional creator = 28
The user who created this pipeline.
optional delete_time = 29
Soft delete timestamp.
message
pipeline.proto:109Statistic data
Used in:
int32 number_of_runs = 1
Number of pipeline runs.
optional last_run_time = 2
Last run time.
int32 number_of_clones = 3
Number of times this pipeline has been cloned.
View defines how a Pipeline is presented.
Used in: , , , , , , , , ,
VIEW_UNSPECIFIED = 0
Unspecified, equivalent to BASIC.
VIEW_BASIC = 1
Default view, only includes basic information.
VIEW_FULL = 2
Full representation.
VIEW_RECIPE = 3
Contains the recipe of the resource.
Visibility defines who can access the pipeline.
Used in: , ,
VISIBILITY_UNSPECIFIED = 0
Unspecified, equivalent to PRIVATE.
VISIBILITY_PRIVATE = 1
Only the user can see the pipeline.
VISIBILITY_PUBLIC = 2
Other users can see the pipeline.
message
pipeline.proto:265Pipeline releases contain the version control information of a pipeline. This allows users to track changes in the pipeline over time. Field ordering follows AIP standard: name (1), id (2), display_name (3), slug (4), aliases (5), description (6)
Used in: , , , , , , ,
string name = 1
Field 1: The name of the release. - Format: `namespaces/{namespace}/pipelines/{pipeline}/releases/{release}`.
string id = 2
Field 2: Release resource ID (used in `name` as the last segment). It must be a sematic version vX.Y.Z.
string display_name = 3
Field 3: Human-readable display name for UI.
string slug = 4
Field 4: URL-friendly slug (alias for the release).
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility.
optional string description = 6
Field 6: Release description.
optional recipe = 7
Recipe of the versioned pipeline.
optional create_time = 8
Pipeline creation time.
optional update_time = 9
Pipeline update time.
optional delete_time = 10
Pipeline deletion time.
optional metadata = 11
Key-value object with console-related data such as the pipeline builder layout.
string readme = 12
README.
optional data_specification = 13
Data specifications.
string raw_recipe = 14
Recipe in YAML format describes the components of a pipeline and how they are connected.
optional endpoints = 15
Pipeline endpoints.
message
pipeline.proto:1125PipelineRun represents a single execution of a pipeline.
Used in: ,
string name = 1
The resource name of the pipeline run. Format: namespaces/{namespace}/pipelines/{pipeline}/runs/{run}
string id = 2
Unique identifier for each run (immutable).
optional create_time = 7
Time when the run was created.
optional update_time = 8
Time when the run was last updated.
optional string runner = 9
Runner who triggered the run. Full resource name: users/{user}.
optional string pipeline = 10
The pipeline resource name. Full resource name: namespaces/{namespace}/pipelines/{pipeline}
string requester = 11
Requester namespace. Full resource name: namespaces/{namespace}.
string pipeline_version = 12
Pipeline version used in the run.
common.run.v1alpha.RunStatus status = 13
Current status of the run.
common.run.v1alpha.RunSource source = 14
Origin of the run.
optional int32 total_duration = 15
Time taken to complete the run in milliseconds.
repeated inputs = 16
Pipeline input parameters.
repeated outputs = 17
Pipeline inference outputs.
optional recipe_snapshot = 18
Snapshot of the pipeline recipe used for this run.
optional start_time = 19
Time when the run started execution.
optional complete_time = 20
Time when the run completed.
optional string error = 21
Error message if the run failed.
optional float credit_amount = 22
Credits used of internal accounting metric.
optional data_specification = 23
Data specifications.
optional blob_data_expiration_time = 24
Expiration time for the blob data associated with the pipeline run.
enum Role
common.proto:8Role describes the permissions a user has over a resource.
Used in: ,
ROLE_UNSPECIFIED = 0
Unspecified, equivalent to VIEWER.
ROLE_VIEWER = 1
Viewers can see the resource properties.
ROLE_EXECUTOR = 2
Executors can execute the resource (e.g. trigger a pipeline).
message
secret.proto:14API secrets allow users to make requests to the Instill AI API. Field ordering follows AIP standard: name(1), id(2), display_name(3), slug(4), aliases(5), description(6)
Used in: , , , , ,
string name = 1
Field 1: Canonical resource name. Format: `namespaces/{namespace}/secrets/{secret}`.
string id = 2
Field 2: Immutable canonical resource ID (80-96 bits entropy, base62). Example: "sec-8f3a2k9E7c1"
string display_name = 3
Field 3: Human-readable display name for UI.
string slug = 4
Field 4: URL-friendly slug (NO prefix). If omitted, server generates from display_name. If provided, server validates and persists it. Slug is NOT part of resource identity. Example: "openai-api-key"
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility. When display_name changes, a new slug is generated and old slugs are stored here.
string description = 6
Field 6: Optional description.
optional create_time = 7
Field 7: Creation time.
optional update_time = 8
Field 8: Last update time.
optional string value = 9
Field 9: The value of the secret, which is input-only and will never be returned in API responses.
message
common.proto:20Sharing contains the information to share a resource with other users. For more information, see [Share Pipelines](https://instill-ai.dev/docs/pipeline/share-pipeline).
Used in: , ,
map<string, > users = 1
Defines sharing rules for a set of user resource names. Each key in this object should contain a pattern that can be matched against user names. Each value is a user sharing configuration. **NOTE**: For now, the only accepted key is `*/*`.
optional share_code = 2
Defines the configuration to share a resource via link.
ShareCode describes a sharing configuration through a link.
Used in:
string user = 1
Defines which users will be able to access the resource through the code. This is a pattern that will be checked against user names. For now, the only accepted value is `*/*`.
string code = 2
The public URL that allows users to access the resource.
bool enabled = 3
Defines whether the sharing option via link is enabled.
Role role = 4
Defines the role users will have over the resource.
message
common.proto:22Describes the sharing configuration with a given user.
Used in:
bool enabled = 1
Defines whether the sharing option with this user is enabled.
Role role = 4
Defines the role the user will have over the resource.
State describes the state of a pipeline.
STATE_UNSPECIFIED = 0
Unspecified.
STATE_INACTIVE = 1
Inactive.
STATE_ACTIVE = 2
Active.
STATE_ERROR = 3
The pipeline has an error.
message
pipeline.proto:227Trace contains the execution details of a component.
Used in:
repeated Trace.Status statuses = 1
Statuses contains an execution status per input.
repeated inputs = 2
Component inputs.
repeated outputs = 3
Component outputs.
optional error = 4
Error details.
float compute_time_in_seconds = 5
Computation time in seconds.
Status holds the the component execution outcome.
Used in:
STATUS_UNSPECIFIED = 0
Unspecified.
STATUS_COMPLETED = 1
Successfully completed.
STATUS_SKIPPED = 2
Skipped.
STATUS_ERROR = 3
Aborted with error.
message
pipeline.proto:852TriggerData contains the input data for a pipeline run.
Used in: , , , ,
optional variable = 1
The values of the pipeline variables.
map<string, string> secret = 2
A collection of secrets. By default, if a pipeline references any secret (`${secret.<id>}`), its value is read from the namespace's secrets. This object provides a way to override these secret values: if one of its keys matches the ID of a reference secret, its value will be read from here instead of from the namespace secret collection.
map<string, string> connection_references = 3
A collection of connection references. By default, connection references (`${connection.<id>}`) in a pipeline will be resolved by fetching the value from the requester's connections. Connections contain sensitive data and can't be shared across namespaces, so this means that, in order to successfully run a pipeline owned by another namespace, the requester will need to have a connection with the same ID. This object provides a way to override the connection references with connections that the requester owns. Each element in the object maps a connection ID present in the pipeline (key) to the ID of a connection owned by the requester (value). Note that, since only references are accepted (this object shouldn't contain connection **values**), the reference syntax shouldn't be used here.
message
pipeline.proto:220TriggerMetadata contains the traces of the pipeline inference.
Used in: , ,
map<string, > traces = 1
Each key in the `traces` object is a component ID. The value is a Trace object containing the execution details.
enum View
common.proto:113View defines how a resource is presented. Most resources can share this view definition, the particular meaning of each value should be defined in the resource itself. Certain resources might have their own View definition if they need to implement more than 2 (basic / full) views.
Used in: , , , ,
VIEW_UNSPECIFIED = 0
Unspecified, equivalent to BASIC.
VIEW_BASIC = 1
Default view.
VIEW_FULL = 2
Full representation.