Agentic - Work Flows

Get work flow by ID

get/api/v1/agentic/work-flows/{id}

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/agentic/work-flows/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Response

Work Flow retrieved successfully

idstring required

Unique identifier

createdAtstring date-time required

Creation timestamp

activeboolean required

Whether the entity is active

createdBystring required

Name of the user who created the entity

createdByIdstring required

ID of the user who created the entity

modifiedAtstring date-time

ISO 8601 date string

modifiedBystring

Name of the user who last modified the entity

modifiedByIdstring

ID of the user who last modified the entity

companyIdstring required

Company identifier

companyobject

Any valid JSON value

groupIdsstring[]

Linked group IDs

namestring required

Name of the function call

fileIdsstring[]

Array of file IDs linked with this function call

visibility'private' | 'resellerRead' | 'resellerWrite' | 'globalRead' required

Workflow visibility and access control

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "active": true,
  "createdBy": "John Doe",
  "createdById": "123",
  "modifiedAt": "2024-01-15T10:30:00.000Z",
  "modifiedBy": "Jane Doe",
  "modifiedById": "456",
  "companyId": "507f1f77bcf86cd799439012",
  "name": "Handle Incoming Call",
  "description": "Automated call handling flow",
  "type": "flow",
  "executeAt": "immediate",
  "visibility": "private",
  "trigger": {
    "nodeType": "onCallStart",
    "nodeTitle": "Call Start Trigger",
    "triggerConfig": {
      "enabled": true,
      "triggerType": "onCallStart",
      "description": "Trigger when a new call starts"
    }
  },
  "nodes": [
    {
      "id": 1,
      "name": "Welcome Message",
      "position": {
        "x": 100,
        "y": 100
      },
      "inputs": {},
      "outputs": {
        "default": [
          {
            "node": "2",
            "output": "default"
          }
        ]
      },
      "className": "conversation-node",
      "data": {
        "nodeType": "llmCompletionConfig",
        "nodeTitle": "Welcome Message",
        "transitions": [
          {
            "type": "success",
            "label": "Continue to next step"
          }
        ]
      }
    }
  ],
  "connections": [
    {
      "node": "2",
      "input": "default",
      "output": "default",
      "label": "Continue"
    }
  ],
  "files": [
    {
      "id": "file_123",
      "filename": "welcome.wav",
      "s3Id": "s3-file-123",
      "displayUrl": "https://example.com/files/welcome.wav"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.