Get initialization workflow

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "workflowID": "<string>",
  "name": "<string>"
}

Get initialization workflow

Returns the agent’s initialization workflow, the workflow set in Behaviour settings that runs at launch, before the user says anything. The name is null when the ID points at a workflow that no longer exists.

GET

/v1/stable/agent/initialization-workflow

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "workflowID": "<string>",
  "name": "<string>"
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Query Parameters

projectID

string

required

The ID of the project to operate on.

environmentAlias

string

required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns the ID and name of the initialization workflow, both null when none is set or when the project has no initialization workflow setting.

workflowID

string

required

The workflow that runs before the user's first turn, or null when none is set or this project has no initialization workflow setting.

name

string

required

That workflow's name. Null when none is set, or when the stored ID names a workflow that no longer exists.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Get initialization workflow

Authorizations

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks