Skip to main content

Workstation Request Lifecycle

The lifecycle of a workstation in AgentStation involves three main stages: requesting a workstation, performing actions, and releasing the workstation. This guide will walk you through each stage using our API.

1. Request a Workstation

To start using a workstation, you need to request one from AgentStation.

API Endpoint: POST /workstations

For detailed information on this endpoint, including request parameters and response format, see the Workstations Request API documentation.

2. Perform Actions

Once you have a workstation, you can perform various actions on it.

API Endpoint: POST /workstations/{workstation_id}/<action>

Replace <action> with the specific action you want to perform. Available actions include:

Each action will return a 200 OK response with relevant data, which may include file download URLs for any generated content.

3. Release the Workstation

When you're done using the workstation, it's important to release it to free up resources.

API Endpoint: DELETE /workstations/{workstation_id}/release

For more information on releasing a workstation, see the Workstations Release API documentation.

By following this lifecycle, you can efficiently manage workstations for your agentic applications. Remember to handle errors and implement proper error handling in your application to ensure smooth operation.