Skip to main content
GET
/
tasks
/
steps
/
{stepId}
Get specific task step
curl --request GET \
  --url https://api.workser.ai/tasks/steps/{stepId} \
  --header 'x-api-key: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "task_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Create user registration endpoint",
  "description": "Implement POST /auth/register endpoint with validation",
  "status": "in_progress",
  "type": "ai_agent_message",
  "metadata": {
    "path": "src/pages/index.tsx",
    "tool": "read_file_from_sandbox"
  },
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-15T12:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
stepId
string
required

Task Step ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Task step retrieved successfully

​
id
string

Task step ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
task_id
string

Task ID that this step belongs to

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
name
string

Task step name

Example:

"Create user registration endpoint"

​
description
string

Task step description

Example:

"Implement POST /auth/register endpoint with validation"

​
status
enum<string>

Task step status

Available options:
pending,
in_progress,
completed,
failed,
cancelled
Example:

"in_progress"

​
type
enum<string>

Type of task step: this can be null if step type not in special type in enum

Available options:
ai_agent_message,
image_understanding,
research,
image_generation
Example:

"ai_agent_message"

​
metadata
object

Additional metadata for the task step: path, tool, command, pattern, and etc. depends on tool used in step

Examples:
{
  "path": "src/pages/index.tsx",
  "tool": "read_file_from_sandbox"
}
{
  "command": "npm install react",
  "tool": "run_command_in_sandbox"
}
{
  "tool": "replace_text_in_files_sandbox",
  "files": ["src/app/page.tsx"],
  "pattern": "import { Header } from \"@/components/layout/Header\"",
  "new_value": "import Header from \"@/components/layout/Header\""
}
{
  "path": "src/app/page.tsx",
  "tool": "write_file_to_sandbox"
}
{
  "path": "",
  "tool": "get_list_of_files_in_sandbox"
}
{
  "tool": "replace_text_in_files_sandbox",
  "files": ["src/app/page.tsx"],
  "pattern": "import { Header } from \"@/components/layout/Header\"",
  "new_value": "import Header from \"@/components/layout/Header\""
}
​
created_at
string<date-time>

Creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
updated_at
string<date-time>

Last update timestamp

Example:

"2024-01-15T12:00:00.000Z"