Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

Publish a Pipeline to a ServiceBeta

Beta
This is coming — this page describes a feature that's still being rolled out and may not be available to you yet.

Publish a pipeline version to a service to make it available to external callers in a stable endpoint. You can publish the same pipeline version to multiple services. One service can only serve one pipeline version.

About This Task​

Services let you separate your work in progress from what's live in production. Once you publish a pipeline version to a service, external callers can use it there in a reliable environment, while you can continue to iterate on the pipeline in the Builder. Your services live in Gateway, where you can manage them.

To learn more, see Gateway.

Prerequisites​

  • A pipeline version ready to be published.
  • Read and write permissions to services.

Publish a Pipeline to a Service​

  1. In the navigation, go to Pipelines and click the name of the pipeline you want to publish.
  2. In Builder, click Publish. This publishes the current version. To publish a previous version, restore it first.
  3. Choose how you want to publish and move to the next step.
    • Create a service and publish to it.
    • Publish to an existing service.
    Deploying a Pipeline without a Service

    This just deploys the pipeline without any service. This option is not recommended for production use where external apps call your pipeline. Every time you deploy a new pipeline version, the endpoint URL changes.Deploying a pipeline is required to test it in the Playground. For production use, we recommend publishing it to a service, where the endpoint URL stays the same, regardless of the pipeline version you publish.

  4. If you're publishing to a new service:
    1. Give your service a name and, optionally, a description to easily identify it.
    2. Configure the hosting settings for the service:
    Hosting settings

    Hosting determines the minimum and maximum number of replicas that must be available for the service and idle timeout. Idle timeout is the period of inactivity after which the service becomes inactive to save resources. You can update these settings at any time from the Service Details page.

info
  • High demand: Choose this option for production pipelines that require high availability and scalability.
  • Low demand: Choose this option for testing and pipelines that are not used frequently.
  • Custom: Configure your own hosting settings.
  1. Review the pipeline version, update the message to describe the changes, and click Create service. The service is starting. Wait until it's ready to serve queries. You can view it in Gateway.
  2. If you're publishing to an existing service:
    1. Choose the service from the list and click Continue to comparison.
    2. Review the pipeline version, update the message to describe the changes, and click Publish. The pipeline version is published to the service and the service is starting. Wait until it's ready to serve queries. You can view it in Gateway.

What To Do Next​

  • Click the service name to view and update its details.
  • Publish a pipeline version to the service.
  • Create an API key for the service to use it in your code.