Workflows & Personas API | Product Documentation

Workflows define automated actions that can be triggered by events or run on demand. Personas are AI-powered assistants configured with specific domain expertise, filtering rules, and behavioral settings.

Workflows

List Workflows

Retrieve all workflows in a workspace.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/workflows/`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace

Response 200 OK

Returns a paginated list of workflow objects.

Get Workflow Detail

Retrieve details of a specific workflow.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/workflows/{workflow_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`workflow_id`	integer	The ID of the workflow

Response 200 OK

Returns the full workflow configuration.

Create Workflow

Create a new workflow in a workspace.


Method	`POST`
Path	`/api/v3/workspaces/{workspace_name}/workflows/`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace

Request Body

Provide the workflow definition including trigger conditions and actions.

Response 201 Created

Returns the newly created workflow object.

Update Workflow

Update an existing workflow.


Method	`PUT`
Path	`/api/v3/workspaces/{workspace_name}/workflows/{workflow_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`workflow_id`	integer	The ID of the workflow

Response 200 OK

Returns the updated workflow object.

Delete Workflow

Delete a workflow from a workspace.


Method	`DELETE`
Path	`/api/v3/workspaces/{workspace_name}/workflows/{workflow_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`workflow_id`	integer	The ID of the workflow

Response 204 No Content

Run Workflow

Trigger execution of a workflow on demand.


Method	`POST`
Path	`/api/v3/workspaces/{workspace_name}/workflows/{workflow_id}/run`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`workflow_id`	integer	The ID of the workflow

Response 200 OK

Returns the execution result.

Get Workflow Webhook Token

Retrieve the webhook token for triggering a workflow externally.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/workflows/{workflow_id}/token`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`workflow_id`	integer	The ID of the workflow

Response 200 OK

Returns the webhook token that can be used to trigger this workflow from external systems.

Personas

List Personas

Retrieve all AI personas configured in a workspace.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/personas/`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace

Response 200 OK

JSON

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "sre-responder",
      "fullName": "SRE First Responder",
      "description": "Focused on infrastructure health and incident response",
      "avatarUrl": "https://...",
      "filterConfidenceThreshold": 0.7,
      "filterIssueSelectionStrategy": "highest_confidence",
      "createdAt": "2026-01-05T09:00:00Z"
    }
  ]
}

Get Persona Detail

Retrieve details of a specific persona.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/personas/{persona_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`persona_id`	integer	The ID of the persona

Response 200 OK

Returns the full persona object including filter configuration, scope settings, and run configuration.

Create Persona

Create a new AI persona in a workspace.


Method	`POST`
Path	`/api/v3/workspaces/{workspace_name}/personas/`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace

Response 201 Created

Returns the newly created persona object.

Update Persona

Update an existing persona.


Method	`PUT`
Path	`/api/v3/workspaces/{workspace_name}/personas/{persona_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`persona_id`	integer	The ID of the persona

Response 200 OK

Returns the updated persona object.

Delete Persona

Delete a persona from a workspace.


Method	`DELETE`
Path	`/api/v3/workspaces/{workspace_name}/personas/{persona_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`persona_id`	integer	The ID of the persona

Response 204 No Content